nodejs/hookshot
nodejs/hookshot
1
0
Fork 0
mirror of https://github.com/matrix-org/matrix-hookshot.git synced 2025-03-10 21:19:13 +00:00
Code Issues Packages Projects Releases Wiki Activity

Add deeplink for registration.sample.yml to setup documentation (#374)

Browse Source 
This hopefully make it easier to reach for users while reading the documentation.

Signed-off-by: Frank Lanitz <fl@flyingcircus.io>
This commit is contained in:
Frank Lanitz 2022-07-15 15:08:00 +02:00 committed by GitHub
parent 6516364f3d
commit e375a3965e
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
2 changed files with 2 additions and 1 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

1
changelog.d/374.doc Normal file
View File

@ -0,0 +1 @@
Add deeplink for registration.sample.yml to setup documentation

2
docs/setup.md
View File

@ -59,7 +59,7 @@ You may validate your config without starting the service by running `yarn valid
For Docker you can run `docker run --rm -v /absolute-path-to/config.yml:/config.yml halfshot/matrix-hookshot node Config/Config.js /config.yml`
Copy `registration.sample.yml` into `registration.yml` and fill in:
- At a minimum, you will need to replace the `as_token` and `hs_token` and change the domain part of the namespaces.
- At a minimum, you will need to replace the `as_token` and `hs_token` and change the domain part of the namespaces. The sample config can be also found at our [github repo](https://raw.githubusercontent.com/matrix-org/matrix-hookshot/main/registration.sample.yml) for your convienence.
You will need to link the registration file to the homeserver. Consult your homeserver documentation
on how to add appservices. [Synapse documents the process here](https://matrix-org.github.io/synapse/latest/application_services.html).