1
0

Move usage docs to usage dir

This commit is contained in:
David Robertson
2022-10-24 14:11:53 +01:00
parent 36f3bbd472
commit 1a9cc657e1
4 changed files with 8 additions and 8 deletions
+1 -1
View File
@@ -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)
+2 -2
View File
@@ -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
+3 -3
View File
@@ -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
+2 -2
View File
@@ -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!