Skip to content
GitLab
Explore
Sign in
Primary navigation
Search or go to…
Project
synapse
Manage
Activity
Members
Labels
Plan
Issues
Issue boards
Milestones
Code
Merge requests
Repository
Branches
Commits
Tags
Repository graph
Compare revisions
Build
Pipelines
Jobs
Pipeline schedules
Artifacts
Deploy
Releases
Container Registry
Model registry
Monitor
Service Desk
Analyze
Value stream analytics
Contributor analytics
CI/CD analytics
Repository analytics
Model experiments
Help
Help
Support
GitLab documentation
Compare GitLab plans
Community forum
Contribute to GitLab
Provide feedback
Keyboard shortcuts
?
Snippets
Groups
Projects
Show more breadcrumbs
Maunium
synapse
Commits
2d919887
Unverified
Commit
2d919887
authored
5 years ago
by
Richard van der Hoff
Committed by
GitHub
5 years ago
Browse files
Options
Downloads
Patches
Plain Diff
Improve docs on choosing server_name (#5558)
Fixes #4901
parent
0e97284d
No related branches found
No related tags found
No related merge requests found
Changes
2
Hide whitespace changes
Inline
Side-by-side
Showing
2 changed files
INSTALL.md
+18
-13
18 additions, 13 deletions
INSTALL.md
changelog.d/5558.misc
+1
-0
1 addition, 0 deletions
changelog.d/5558.misc
with
19 additions
and
13 deletions
INSTALL.md
+
18
−
13
View file @
2d919887
-
[
Choosing your server name
](
#choosing-your-server-name
)
-
[
Installing Synapse
](
#installing-synapse
)
-
[
Installing from source
](
#installing-from-source
)
-
[
Platform-Specific Instructions
](
#platform-specific-instructions
)
...
...
@@ -10,6 +11,22 @@
-
[
Setting up a TURN server
](
#setting-up-a-turn-server
)
-
[
URL previews
](
#url-previews
)
# Choosing your server name
It is important to choose the name for your server before you install Synapse,
because it cannot be changed later.
The server name determines the "domain" part of user-ids for users on your
server: these will all be of the format
`@user:my.domain.name`
. It also
determines how other matrix servers will reach yours for federation.
For a test configuration, set this to the hostname of your server. For a more
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
](
docs/federate.md
)
.
# Installing Synapse
## Installing from source
...
...
@@ -64,16 +81,7 @@ python -m synapse.app.homeserver \
--report-stats=[yes|no]
```
... substituting an appropriate value for
`--server-name`
. The server name
determines the "domain" part of user-ids for users on your server: these will
all be of the format
`@user:my.domain.name`
. It also determines how other
matrix servers will reach yours for Federation. For a test configuration,
set this to the hostname of your server. For a more 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
](
docs/federate.md
)
.
Beware that the server name cannot be changed later.
... substituting an appropriate value for
`--server-name`
.
This command will generate you a config file that you can then customise, but it will
also generate a set of keys for you. These keys will allow your Home Server to
...
...
@@ -86,9 +94,6 @@ different. See the
[
spec
](
https://matrix.org/docs/spec/server_server/latest.html#retrieving-server-keys
)
for more information on key management.)
You will need to give Synapse a TLS certficate before it will start - see
[
TLS
certificates
](
#tls-certificates
)
.
To actually run your new homeserver, pick a working directory for Synapse to
run (e.g.
`~/synapse`
), and::
...
...
This diff is collapsed.
Click to expand it.
changelog.d/5558.misc
0 → 100644
+
1
−
0
View file @
2d919887
Improve install docs on choosing server_name.
This diff is collapsed.
Click to expand it.
Preview
0%
Loading
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Save comment
Cancel
Please
register
or
sign in
to comment