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
71cc6bab
Unverified
Commit
71cc6bab
authored
5 years ago
by
Brendan Abolivier
Browse files
Options
Downloads
Patches
Plain Diff
Update INSTALL.md to recommend reverse proxying and warn about ACMEv1 deprecation
parent
df1c98c2
No related branches found
Branches containing commit
No related tags found
Tags containing commit
No related merge requests found
Changes
1
Hide whitespace changes
Inline
Side-by-side
Showing
1 changed file
INSTALL.md
+15
-11
15 additions, 11 deletions
INSTALL.md
with
15 additions
and
11 deletions
INSTALL.md
+
15
−
11
View file @
71cc6bab
...
...
@@ -388,15 +388,17 @@ Once you have installed synapse as above, you will need to configure it.
## TLS certificates
The default configuration exposes a single HTTP port: http://localhost:8008. It
is suitable for local testing, but for any practical use, you will either need
to enable a reverse proxy, or configure Synapse to expose an HTTPS port.
The default configuration exposes a single HTTP port on the local
interface:
`http://localhost:8008`
. It is suitable for local testing,
but for any practical use, you will need Synapse's APIs to be served
over HTTPS.
For information on using a reverse proxy, see
The recommended way to do so is to set up a reverse proxy on port
`8448`
. You can find documentation on doing so in
[
docs/reverse_proxy.md
](
docs/reverse_proxy.md
)
.
To
configure Synapse to expose an HTTPS port
, you will need to edit
`homeserver.yaml`
, as follows:
Alternatively, you can
configure Synapse to expose an HTTPS port
. To do
so, you will need to edit
`homeserver.yaml`
, as follows:
*
First, under the
`listeners`
section, uncomment the configuration for the
TLS-enabled listener. (Remove the hash sign (
`#`
) at the start of
...
...
@@ -414,11 +416,13 @@ To configure Synapse to expose an HTTPS port, you will need to edit
point these settings at an existing certificate and key, or you can
enable Synapse's built-in ACME (Let's Encrypt) support. Instructions
for having Synapse automatically provision and renew federation
certificates through ACME can be found at
[
ACME.md
](
docs/ACME.md
)
. If you
are using your own certificate, be sure to use a
`.pem`
file that includes
the full certificate chain including any intermediate certificates (for
instance, if using certbot, use
`fullchain.pem`
as your certificate, not
`cert.pem`
).
certificates through ACME can be found at
[
ACME.md
](
docs/ACME.md
)
.
Note that, as pointed out in that document, this feature will not
work with installs set up after November 2020. If you are using your
own certificate, be sure to use a
`.pem`
file that includes the full
certificate chain including any intermediate certificates (for
instance, if using certbot, use
`fullchain.pem`
as your certificate,
not
`cert.pem`
).
For a more detailed guide to configuring your server for federation, see
[
federate.md
](
docs/federate.md
)
...
...
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