fair/matrix-appservice-kakaotalk
fair
/
matrix-appservice-kakaotalk
1
0
Fork 2
Code Issues 2 Pull Requests 1 Projects Releases Wiki Activity

In SETUP.md, mention postgresql setup & sqlite3 support

This commit is contained in:
Andrew Ferrazzutti 2022-03-13 17:56:54 -04:00
parent 9c330350e0
commit d975dd8c1f
1 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

3
SETUP.md
View File

@ -10,7 +10,7 @@ These instructions describe how to install and run the bridge manually from a cl
## Minimum requirements ## Minimum requirements
* Python 3.7 * Python 3.7
* Node 16.13 (not yet tested with earlier versions) * Node 16.13 (not yet tested with earlier versions)
* postgresql 11 * postgresql 11 or sqlite3
* A KakaoTalk account on a smartphone (Android or iOS) * A KakaoTalk account on a smartphone (Android or iOS)
## Optional requirements ## Optional requirements
@ -31,6 +31,7 @@ These instructions describe how to install and run the bridge manually from a cl
* Note that end-to-bridge encryption requires some native dependencies. For details, see https://docs.mau.fi/bridges/python/optional-dependencies.html#all-python-bridges * Note that end-to-bridge encryption requires some native dependencies. For details, see https://docs.mau.fi/bridges/python/optional-dependencies.html#all-python-bridges
1. Copy `matrix_appservice_kakaotalk/example-config.yaml` to `config.yaml`, and update it with the proper settings to connect to your homeserver 1. Copy `matrix_appservice_kakaotalk/example-config.yaml` to `config.yaml`, and update it with the proper settings to connect to your homeserver
* In particular, be sure to set the `rpc.connection` settings to use the socket you chose in `node/config.json` * In particular, be sure to set the `rpc.connection` settings to use the socket you chose in `node/config.json`
* If using Postgres as your database, create a new database that can be accessed via the URI you set for it in `appservice.database`
1. Run `python -m matrix_appservice_kakaotalk -g` to generate an appservice registration file, and update your homeserver configuration to accept it 1. Run `python -m matrix_appservice_kakaotalk -g` to generate an appservice registration file, and update your homeserver configuration to accept it
## Running manually ## Running manually