2017-09-13 12:21:40 +05:00
# OpenSAPS configuration
2019-03-06 05:31:00 +05:00
There is no hardcoded place for OpenSAPS configuration. You **should** provide path to configuration file via ``-config`` parameter.
2017-09-13 12:21:40 +05:00
# Example configuration
2019-03-06 05:31:00 +05:00
Example can be viewed in opensaps.example.yaml, which is stored in root directory of this repository.
2017-09-13 12:21:40 +05:00
# Configuration values.
2019-03-06 05:31:00 +05:00
Here we will go thru configuration values available. Nesting shows nesting level in configuration file.
2017-09-13 12:21:40 +05:00
* ``slackhandler`` - namespace for configuring Slack API HTTP listener.
* ``listener`` - namespace for configuring HTTP listener itself.
2019-03-06 05:31:00 +05:00
* ``address`` - IP address and port we will listen on. Defaulting to ``127.0.0.1:39231``.
2017-09-13 12:21:40 +05:00
2019-03-06 05:31:00 +05:00
* ``webhooks`` - namespace for webhooks configuration. Here you should define webhook name (**should be unique!**) and some parameters.
2017-09-13 12:21:40 +05:00
2019-03-06 05:31:00 +05:00
* ``gitea_to_matrix`` - example webhook name. Should be unique and can be anything you can imagine (in text, of course).
2017-09-13 12:21:40 +05:00
2019-03-06 05:31:00 +05:00
**WARNING:** multiline webhook names wasn't tested! Try to keep your text in single line!
* ``slack`` - namespace for configuring Slack API parameters. URL for Slack webhook looks like:
2017-09-13 12:21:40 +05:00
```
http(s)://server.tls/services/T12345678/B87654321/24charslongstring
```
2019-03-06 05:31:00 +05:00
Where ``12345678`` is a random 8-char string (all caps) and ``24charslongstring`` is a random 24-char string.
2017-09-13 12:21:40 +05:00
Next variables configures these strings.
* ``random1`` - first 8-char random string (``T12345678``).
* ``random2`` - second 8-char random string (``B87654321``).
* ``longrandom`` - 24-char random string.
* ``remote`` - configures pusher this webhook should use and
connection name for it.
* ``pusher`` - what pusher this webhook should use.
* ``push_to`` - connection name for this pusher.
* ``matrix`` - configures Matrix pusher connections available.
2019-03-06 05:31:00 +05:00
* ``matrix_test`` - connection name. Should be unique and can be anything you can imagine (in text, of course).
**WARNING:** multiline webhook names wasn't tested! Try to keep your text in single line!
2017-09-13 12:21:40 +05:00
* ``api_root`` - API root for Matrix connection. For example,
``https://localhost:8448/_matrix/client/r0``.
* ``user`` - Matrix user.
* ``password`` - password for Matrix user.
2019-03-06 05:31:00 +05:00
* ``room`` - room ID to use. If Matrix user isn't in that room while OpenSAPS logging in - OpenSAPS will try to join this room.
* ``telegram`` - configures Telegram pusher connections.
* ``telegram_test`` - connection name. Should be unique and can be anything you can imagine (in text, of course).
* ``bot_id`` - token from BotFather.
* ``chat_id`` - chat ID to where OpenSAPS will write message. Easies way to get it - invite bot into chat (or start chat with bot), send a message and go to https://api.telegram.org/botYOUR:BOTTOKEN/getUpdates to obtain chat ID. It can be positive (for privates) and negative (for groupchats).
* ``proxy`` - proxy configuration for Telegram connection. This configuration is **connection-specific** .
* ``enabled`` - should we use proxy or not.
* ``type`` - proxy type. For now ignored as only HTTP proxy support is available.
* ``address`` - proxy server address in format "address:port".
* ``user`` - this username will be used for authorization if filled.
* ``password`` - this password will be used for authorization if filled **and** if username is also filled.
