stonewareslord/telematrix
1
0
Fork 0
Code Issues Pull Requests Releases Wiki Activity

Add a bit more documentation

Browse Source
This commit is contained in:
Sijmen Schoon 2016-11-15 07:45:09 +01:00
parent fa390b69c5
commit e9f166ee1b
2 changed files with 19 additions and 5 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

20
README.md
View File

@ -19,7 +19,25 @@ pip install -r requirements.txt
``` ```
### Configuration ### Configuration
TODO **telematrix configuration**
First, copy config.json.example to config.json. Then fill in the fields:
`tokens.hs`: A randomly generated token
`tokens.as`: Another randomly generated token
`tokens.telegram`: The Telegram bot API token, as generated by @BotFather
`tokens.google`: A Google API key, used for URL shortening. Can be left out to disable.
`hosts.internal`: The homeserver host to connect to internally.
`hosts.external`: The external domain of the homeserver, used for generating URLs.
`hosts.bare`: Just the (sub)domain of the server.
`user_id_format`: A Python `str.format`-style string to format user IDs as
`db_url`: A SQLAlchemy URL for the database. See the [SQLAlchemy docs](http://docs.sqlalchemy.org/en/latest/core/engines.html).
**Synapse configuration**
*TODO*
## Contributions ## Contributions

4
config.json.example
View File

@ -12,10 +12,6 @@
"bare": "DOMAIN.TLD" "bare": "DOMAIN.TLD"
}, },
"chats": {
"-TELEGRAM_ID": "!INTERNAL_ID:DOMAIN.TLD"
},
"user_id_format": "@telegram_{}:DOMAIN.TLD", "user_id_format": "@telegram_{}:DOMAIN.TLD",
"db_url": "sqlite:///database.db" "db_url": "sqlite:///database.db"
} }