diff options
author | David Robertson <davidr@element.io> | 2022-10-24 14:11:53 +0100 |
---|---|---|
committer | David Robertson <davidr@element.io> | 2022-10-24 14:12:59 +0100 |
commit | 1a9cc657e1eae5302b130ee3f50f8741e63afb34 (patch) | |
tree | 5d9db2767d61d77f8d63f6f505e4e3a795332506 | |
parent | move other doc to other dir (diff) | |
download | synapse-1a9cc657e1eae5302b130ee3f50f8741e63afb34.tar.xz |
Move usage docs to usage dir
-rw-r--r-- | docs/SUMMARY.md | 2 | ||||
-rw-r--r-- | docs/setup/installation.md | 4 | ||||
-rw-r--r-- | docs/usage/federate.md (renamed from docs/federate.md) | 6 | ||||
-rw-r--r-- | docs/welcome_and_overview.md | 4 |
4 files changed, 8 insertions, 8 deletions
diff --git a/docs/SUMMARY.md b/docs/SUMMARY.md index 65ed6e1d48..afbe2ae3ea 100644 --- a/docs/SUMMARY.md +++ b/docs/SUMMARY.md @@ -15,7 +15,7 @@ - [Upgrading between Synapse Versions](upgrade.md) # Usage - - [Federation](federate.md) + - [Federation](usage/federate.md) - [Configuration](usage/configuration/README.md) - [Configuration Manual](usage/configuration/config_documentation.md) - [Homeserver Sample Config File](usage/configuration/homeserver_sample_config.md) diff --git a/docs/setup/installation.md b/docs/setup/installation.md index 8d4edbf0a0..d1a4970c01 100644 --- a/docs/setup/installation.md +++ b/docs/setup/installation.md @@ -14,7 +14,7 @@ production-ready setup, you will probably want to specify your domain (`example.com`) rather than a matrix-specific hostname here (in the same way that your email address is probably `user@example.com` rather than `user@email.example.com`) - but doing so may require more advanced setup: see -[Setting up Federation](../federate.md). +[Setting up Federation](../usage/federate.md). ## Installing Synapse @@ -436,7 +436,7 @@ listeners: `cert.pem`). For a more detailed guide to configuring your server for federation, see -[Federation](../federate.md). +[Federation](../usage/federate.md). ### Client Well-Known URI diff --git a/docs/federate.md b/docs/usage/federate.md index 285473362f..9b8c61f5a0 100644 --- a/docs/federate.md +++ b/docs/usage/federate.md @@ -14,7 +14,7 @@ you set the `server_name` to match your machine's public DNS hostname. For this default configuration to work, you will need to listen for TLS connections on port 8448. The preferred way to do that is by using a -reverse proxy: see [the reverse proxy documentation](setup/reverse_proxy.md) for instructions +reverse proxy: see [the reverse proxy documentation](../setup/reverse_proxy.md) for instructions on how to correctly set one up. In some cases you might not want to run Synapse on the machine that has @@ -23,7 +23,7 @@ traffic to use a different port than 8448. For example, you might want to have your user names look like `@user:example.com`, but you want to run Synapse on `synapse.example.com` on port 443. This can be done using delegation, which allows an admin to control where federation traffic should -be sent. See [the delegation documentation](setup/delegate.md) for instructions on how to set this up. +be sent. See [the delegation documentation](../setup/delegate.md) for instructions on how to set this up. Once federation has been configured, you should be able to join a room over federation. A good place to start is `#synapse:matrix.org` - a room for @@ -44,7 +44,7 @@ a complicated dance which requires connections in both directions). Another common problem is that people on other servers can't join rooms that you invite them to. This can be caused by an incorrectly-configured reverse -proxy: see [the reverse proxy documentation](setup/reverse_proxy.md) for instructions on how +proxy: see [the reverse proxy documentation](../setup/reverse_proxy.md) for instructions on how to correctly configure a reverse proxy. ### Known issues diff --git a/docs/welcome_and_overview.md b/docs/welcome_and_overview.md index 427997bd92..e35234929a 100644 --- a/docs/welcome_and_overview.md +++ b/docs/welcome_and_overview.md @@ -52,8 +52,8 @@ following documentation: * Understand [how Synapse is built](development/internal_documentation/index.html), how to [migrate database schemas](development/database_schema.md), learn about - [federation](federate.md) and how to [set up a local - federation](federate.md#running-a-demo-federation-of-synapses) for development. + [federation](usage/federate.md) and how to [set up a local + federation](usage/federate.md#running-a-demo-federation-of-synapses) for development. * We like to keep our `git` history clean. [Learn](development/git.md) how to do so! |