james/rocketchat2matrix
1
0
Fork 0
Code Issues Pull Requests Packages Projects Releases Wiki Activity

Update run instructions to be clearer

Browse Source
This commit is contained in:
Henrik Hüttemann 2023-06-05 14:53:48 +02:00
parent ac5da7dd01
commit b02db837cb
No known key found for this signature in database
GPG Key ID: 9F7BD10E0A8A111E
1 changed files with 5 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

8
README.md
View File

@ -19,13 +19,13 @@ Export them to `inputs/`
```shell ```shell
docker-compose run --rm -e SYNAPSE_SERVER_NAME=my.matrix.host -e SYNAPSE_REPORT_STATS=no synapse generate docker-compose run --rm -e SYNAPSE_SERVER_NAME=my.matrix.host -e SYNAPSE_REPORT_STATS=no synapse generate
docker-compose up -d docker-compose up -d
# Register a admin user # Register an admin user
docker-compose exec -it synapse register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml --admin --user verdiadmin --password verdiadmin docker-compose exec -it synapse register_new_matrix_user http://localhost:8008 -c /data/homeserver.yaml --admin --user verdiadmin --password verdiadmin
``` ```
Then you can access the homeserver in [Element Web](https://app.element.io/#/login) or the [local admin interface](http://localhost:8080) as `http://localhost:8008` with the `verdiadmin` as username AND password. Then you can access the homeserver in [Element Web](https://app.element.io/#/login) or the [local admin interface](http://localhost:8080) as `http://localhost:8008` with the `verdiadmin` as username AND password.
You can store an access token for that user: Store an access token for that user:
```shell ```shell
curl --request POST \ curl --request POST \
@ -35,6 +35,8 @@ curl --request POST \
> src/config/synapse_access_token.json > src/config/synapse_access_token.json
``` ```
To finally run the script, execute it via `npm start`.
## Configuration ## Configuration
Copy over `.env.example` to `.env` and insert your values. Copy over `.env.example` to `.env` and insert your values.
@ -45,7 +47,7 @@ Copy over `.env.example` to `.env` and insert your values.
## Cleaning Up ## Cleaning Up
To clean up the Synapse server and loal storage database, run (while the containers are stopped) To clean up the Synapse server and local storage database, run (while the containers are stopped)
```shell ```shell
sudo rm files/homeserver.db sudo rm files/homeserver.db