diff options
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 19 |
1 files changed, 15 insertions, 4 deletions
@@ -48,11 +48,22 @@ Easybridge is configured using a single JSON configuration file, which contains a dictionnary whose keys are the following: - `log_level`: what log level Easybridge runs with (trace, debug, info, warn, error, fatal, panic). **Warning:** in `trace` level, the content of all calls to the Matrix API and some other information will be dumped, exposing user's credentials and messages. In `debug` level, room join/leave information will be exposed. The `info` level (default) does not expose any user's private information. +- `easybridge_avatar`: path to the image that Easybridge uses as an avatar on Matrix + +### Matrix configuration + +- `registration`: path to the YAML appservice registration file - `appservice_bind_addr`: on what IP/port to bind as a Matrix app service (HTTP only, no HTTPS) +- `homeserver_url`: HTTP address of the Matrix homeserver +- `matrix_domain`: the domain name of the Matrix homeserver (i.e. the domain used in user identifiers, room identifiers, etc) +- `name_format`: the format of identifiers that are created on Matrix for users and room aliases. `{}` is replaced by the concatenation of user/room identifier and protocol. Typically you want either `_ezbr_{}` or `{}_ezbr`, the latter having the advantage that the briged user's names are then used as prefixes for the created identifiers. + +### Web interface configuration + - `web_bind_addr`: on what IP/port to bind for the web interface that allows adding and configuring accounts (HTTP only, no HTTPS, use a reverse proxy for that) - `web_url`: the outside HTTP/HTTPS address at which the web interface is made available. If set, a widget will be added in the Easybridge room so that users can configure the bridge without leaving the Riot client. -- `registration`: path to the YAML appservice registration file -- `homeserver_url`: HTTP address of the Matrix homeserver -- `matrix_domain`: the dmoain name of the Matrix homeserver (i.e. the domain used in user identifiers, room identifiers, etc) -- `db_type` and `db_path`: the database backend and path to use (see the [Gorm documentation](http://gorm.io/docs/connecting_to_the_database.html)) - `session_key`: a key with which session cookies are encrypted for the web interface + +### Storage configuration + +- `db_type` and `db_path`: the database backend and path to use (see the [Gorm documentation](http://gorm.io/docs/connecting_to_the_database.html)) |