From 04ff369cb2ffdd7caf7518f71312617bf0f2d8d3 Mon Sep 17 00:00:00 2001 From: Marek Isalski Date: Sat, 16 Jun 2018 16:16:30 +0200 Subject: [PATCH] add a README file --- .hgignore | 4 ++++ README.md | 24 ++++++++++++++++++++++++ 2 files changed, 28 insertions(+) create mode 100644 README.md diff --git a/.hgignore b/.hgignore index a4e9e10..2ace9fb 100644 --- a/.hgignore +++ b/.hgignore @@ -1 +1,5 @@ ^.venv/ +^settings\.cfg$ +^sftp-config\.json$ +^incident-handler\.sublime-project$ +^incident-handler\.sublime-workspace$ diff --git a/README.md b/README.md new file mode 100644 index 0000000..2518000 --- /dev/null +++ b/README.md @@ -0,0 +1,24 @@ +Example `settings.cfg` file: + +```python +FIH_ROOT = "/home/status/incident_handler" +STATUS_ROOT = "/home/status/status.example.com" +STATUS_EVENT_SCHEME = STATUS_ROOT + "/content/event/%(incident_number)s-%(slug)s.md" +STATUS_EVENT_GLOB = STATUS_ROOT + "/content/event/%(incident_number)s*.md" +STATUS_EVENT_INDEX = STATUS_ROOT + "/content/pages/index.md" +MERCURIAL_BIN = "/usr/bin/hg" +GROW_BIN = "/usr/local/bin/grow" +MERCURIAL_PUSH_TO = [ "c3", "c4" ] +GROW_DEPLOY_TO = [ "c3", "c4" ] + +MATTERMOST_COMMAND_TOKENS = [ "XXXXXXXXXXXXXXXXXXXXXXXXXX" ] +MATTERMOST_USER_EMAIL = "mattermostuser@example.com" +MATTERMOST_USER_PASSWORD = "XXXXXXXXXXXXXXXX" +MATTERMOST_URL = "mattermost.example.com" +MATTERMOST_PORT = 443 + +MATTERMOST_INCIDENT_CHANNEL_PREFIX = "incident" +PUBLIC_INCIDENT_PREFIX = "FI#" +STATUS_PAGE_URL = "https://status.faelix.net/" +INCIDENT_URL_SCHEME = STATUS_PAGE_URL + "event/%s/" +```