Skip to content

Commit

Permalink
Add deeplink for registration.sample.yml to setup documentation (#374)
Browse files Browse the repository at this point in the history
This hopefully make it easier to reach for users while reading the documentation.

Signed-off-by: Frank Lanitz <[email protected]>
  • Loading branch information
frlan authored Jul 15, 2022
1 parent 6516364 commit e375a39
Show file tree
Hide file tree
Showing 2 changed files with 2 additions and 1 deletion.
1 change: 1 addition & 0 deletions changelog.d/374.doc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add deeplink for registration.sample.yml to setup documentation
2 changes: 1 addition & 1 deletion docs/setup.md
Original file line number Diff line number Diff line change
Expand Up @@ -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).
Expand Down

0 comments on commit e375a39

Please sign in to comment.