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

Commit

Permalink
Update ACME docs to include port instructions (#4578)
Browse files Browse the repository at this point in the history
  • Loading branch information
anoadragon453 authored and richvdh committed Feb 7, 2019
1 parent 3bd9daf commit c17b128
Show file tree
Hide file tree
Showing 2 changed files with 16 additions and 11 deletions.
1 change: 1 addition & 0 deletions changelog.d/4578.misc
Original file line number Diff line number Diff line change
@@ -0,0 +1 @@
Add port configuration information to ACME instructions.
26 changes: 15 additions & 11 deletions docs/ACME.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,10 +41,10 @@ placed in Synapse's config directory without the need for any ACME setup.

The main steps for enabling ACME support in short summary are:

1. Allow Synapse to listen on port 80 with authbind, or forward it from a reverse-proxy.
1. Set `acme:enabled` to `true` in homeserver.yaml.
1. Allow Synapse to listen for incoming ACME challenges.
1. Enable ACME support in `homeserver.yaml`.
1. Move your old certificates (files `example.com.tls.crt` and `example.com.tls.key` out of the way if they currently exist at the paths specified in `homeserver.yaml`.
1. Restart Synapse
1. Restart Synapse.

Detailed instructions for each step are provided below.

Expand All @@ -71,14 +71,22 @@ location /.well-known/acme-challenge {
}
```

For Apache, add the following to your existing webserver config::
For Apache, add the following to your existing webserver config:

```
ProxyPass /.well-known/acme-challenge http://localhost:8009/.well-known/acme-challenge
```

Make sure to restart/reload your webserver after making changes.

Now make the relevant changes in `homeserver.yaml` to enable ACME support:

```
acme:
enabled: true
port: 8009
```


#### Authbind

Expand All @@ -102,24 +110,20 @@ sudo touch /etc/authbind/byport/80
sudo chmod 777 /etc/authbind/byport/80
```

When Synapse is started, use the following syntax::
When Synapse is started, use the following syntax:

```
authbind --deep <synapse start command>
```

### Config file editing

Once Synapse is able to listen on port 80 for ACME challenge
requests, it must be told to perform ACME provisioning by setting `enabled`
to true under the `acme` section in `homeserver.yaml`:
Make the relevant changes in `homeserver.yaml` to enable ACME support:

```
acme:
enabled: true
```

### Starting synapse
### (Re)starting synapse

Ensure that the certificate paths specified in `homeserver.yaml` (`tls_certificate_path` and `tls_private_key_path`) do not currently point to any files. Synapse will not provision certificates if files exist, as it does not want to overwrite existing certificates.

Expand Down

0 comments on commit c17b128

Please sign in to comment.