Skip to content
This repository was archived by the owner on Apr 26, 2024. It is now read-only.

Commit 2d91988

Browse files
authored
Improve docs on choosing server_name (#5558)
Fixes #4901
1 parent 0e97284 commit 2d91988

File tree

2 files changed

+19
-13
lines changed

2 files changed

+19
-13
lines changed

INSTALL.md

Lines changed: 18 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,4 @@
1+
- [Choosing your server name](#choosing-your-server-name)
12
- [Installing Synapse](#installing-synapse)
23
- [Installing from source](#installing-from-source)
34
- [Platform-Specific Instructions](#platform-specific-instructions)
@@ -10,6 +11,22 @@
1011
- [Setting up a TURN server](#setting-up-a-turn-server)
1112
- [URL previews](#url-previews)
1213

14+
# Choosing your server name
15+
16+
It is important to choose the name for your server before you install Synapse,
17+
because it cannot be changed later.
18+
19+
The server name determines the "domain" part of user-ids for users on your
20+
server: these will all be of the format `@user:my.domain.name`. It also
21+
determines how other matrix servers will reach yours for federation.
22+
23+
For a test configuration, set this to the hostname of your server. For a more
24+
production-ready setup, you will probably want to specify your domain
25+
(`example.com`) rather than a matrix-specific hostname here (in the same way
26+
that your email address is probably `[email protected]` rather than
27+
`[email protected]`) - but doing so may require more advanced setup: see
28+
[Setting up Federation](docs/federate.md).
29+
1330
# Installing Synapse
1431

1532
## Installing from source
@@ -64,16 +81,7 @@ python -m synapse.app.homeserver \
6481
--report-stats=[yes|no]
6582
```
6683

67-
... substituting an appropriate value for `--server-name`. The server name
68-
determines the "domain" part of user-ids for users on your server: these will
69-
all be of the format `@user:my.domain.name`. It also determines how other
70-
matrix servers will reach yours for Federation. For a test configuration,
71-
set this to the hostname of your server. For a more production-ready setup, you
72-
will probably want to specify your domain (`example.com`) rather than a
73-
matrix-specific hostname here (in the same way that your email address is
74-
probably `[email protected]` rather than `[email protected]`) - but
75-
doing so may require more advanced setup: see [Setting up Federation](docs/federate.md).
76-
Beware that the server name cannot be changed later.
84+
... substituting an appropriate value for `--server-name`.
7785

7886
This command will generate you a config file that you can then customise, but it will
7987
also generate a set of keys for you. These keys will allow your Home Server to
@@ -86,9 +94,6 @@ different. See the
8694
[spec](https://matrix.org/docs/spec/server_server/latest.html#retrieving-server-keys)
8795
for more information on key management.)
8896

89-
You will need to give Synapse a TLS certficate before it will start - see [TLS
90-
certificates](#tls-certificates).
91-
9297
To actually run your new homeserver, pick a working directory for Synapse to
9398
run (e.g. `~/synapse`), and::
9499

changelog.d/5558.misc

Lines changed: 1 addition & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1 @@
1+
Improve install docs on choosing server_name.

0 commit comments

Comments
 (0)