FAELIX/incident_handler
FAELIX/incident_handler
3
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

add a bit more detail to the README.md

Browse Source
This commit is contained in:
Marek Isalski 2018-06-16 16:26:53 +02:00
parent d13a64f863
commit 220725d989
1 changed files with 20 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -1,3 +1,15 @@
## Installation
We are using [Pipenv](https://docs.pipenv.org) to make our lives easier:
```sh
git clone https://gitea.faelix.net/FAELIX/incident_handler.git
cd incident_handler
pipenv install --three
```
## Configuration
Example `settings.cfg` file: Example `settings.cfg` file:
```python ```python
@ -22,3 +34,11 @@ PUBLIC_INCIDENT_PREFIX = "FI#"
STATUS_PAGE_URL = "https://status.faelix.net/" STATUS_PAGE_URL = "https://status.faelix.net/"
INCIDENT_URL_SCHEME = STATUS_PAGE_URL + "event/%s/" INCIDENT_URL_SCHEME = STATUS_PAGE_URL + "event/%s/"
``` ```
## Running
```sh
export FIH_SETTINGS=~/incident_handler/settings.cfg
export FLASK_APP=fih.py
cd ~/incident_handler
flask run -p 3333