From e375a3965e3fb3d77cc213ee97d7bc19f066d59c Mon Sep 17 00:00:00 2001 From: Frank Lanitz Date: Fri, 15 Jul 2022 15:08:00 +0200 Subject: [PATCH] Add deeplink for registration.sample.yml to setup documentation (#374) This hopefully make it easier to reach for users while reading the documentation. Signed-off-by: Frank Lanitz --- changelog.d/374.doc | 1 + docs/setup.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) create mode 100644 changelog.d/374.doc diff --git a/changelog.d/374.doc b/changelog.d/374.doc new file mode 100644 index 00000000..c80aa294 --- /dev/null +++ b/changelog.d/374.doc @@ -0,0 +1 @@ +Add deeplink for registration.sample.yml to setup documentation diff --git a/docs/setup.md b/docs/setup.md index 26d9437d..4109ef2f 100644 --- a/docs/setup.md +++ b/docs/setup.md @@ -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).