From b1db236f02cc692d4920d43381e76d219b122832 Mon Sep 17 00:00:00 2001 From: Jonathan Batchelor Date: Thu, 2 Mar 2023 19:25:02 +0000 Subject: [PATCH 1/2] Add simple Caddy reverse proxy instructions --- content/running_bookwyrm/reverse-proxy.md | 17 +++++++++++++++++ 1 file changed, 17 insertions(+) diff --git a/content/running_bookwyrm/reverse-proxy.md b/content/running_bookwyrm/reverse-proxy.md index 0c835035..5f45702a 100644 --- a/content/running_bookwyrm/reverse-proxy.md +++ b/content/running_bookwyrm/reverse-proxy.md @@ -112,3 +112,20 @@ If everything worked correctly, your BookWyrm instance should now be externally *Note: the `proxy_set_header Host $host;` is essential; if you do not include it, incoming messages from federated servers will be rejected.* *Note: the location of the ssl certificates may vary depending on the OS of your server* + + +#### Caddy + +- Add an email address in the global section of your `Caddyfile` and Caddy will automatically obtain https certificates from LetsEncrypt. , +- Add the three endpoints for your BookWyrm domain: +```Caddyfile +{ + email email@your.domain +} +your.domain { + reverse_proxy /images/* localhost:8001 + reverse_proxy /static/* localhost:8001 + reverse_proxy localhost:8000 +} +``` +Caddy will set the headers needed by default for you. From 2d42964ea053176e0fbfbd3a7951951bf96b8795 Mon Sep 17 00:00:00 2001 From: Jonathan Batchelor Date: Thu, 9 Mar 2023 10:08:28 +0000 Subject: [PATCH 2/2] Caddy instructions update. Update to Caddy instructions to make things clearer. --- content/running_bookwyrm/reverse-proxy.md | 28 +++++++++++++++++------ 1 file changed, 21 insertions(+), 7 deletions(-) diff --git a/content/running_bookwyrm/reverse-proxy.md b/content/running_bookwyrm/reverse-proxy.md index 5f45702a..b851218e 100644 --- a/content/running_bookwyrm/reverse-proxy.md +++ b/content/running_bookwyrm/reverse-proxy.md @@ -116,16 +116,30 @@ If everything worked correctly, your BookWyrm instance should now be externally #### Caddy -- Add an email address in the global section of your `Caddyfile` and Caddy will automatically obtain https certificates from LetsEncrypt. , -- Add the three endpoints for your BookWyrm domain: +[Caddy](https://caddyserver.com) is an alternative reverse-proxy server that is simple to use and can manage TLS certificate renewals and static file serving automatically. This guide assumes that you already have a Caddy server running and it has access to the bookwyrm docker network. + +To use Caddy instead of nginx as the Reverse-Proxy server, make the following changes: + +- In `nginx/default.conf`: + - Comment out the two default servers + - Uncomment the server labeled Reverse-Proxy server + - Replace `your-domain.com` with your domain name + +- In `docker-compose.yml`: + - In `services` -> `nginx` -> `ports`, comment out the default ports and add `- 8001:8001` + - In `services` -> `nginx` -> `volumes`, comment out the two volumes that begin `./certbot/` + - In `services`, comment out the `certbot` service + +- In your Caddyfile add your bookwyrm subdomain: ```Caddyfile -{ - email email@your.domain -} your.domain { reverse_proxy /images/* localhost:8001 reverse_proxy /static/* localhost:8001 reverse_proxy localhost:8000 } -``` -Caddy will set the headers needed by default for you. +`` +If you were to give `container_name`s to the `nginx` and `web` containers in `docker-compose.yml`, then you could comment out the `ports` sections and use the container names in place of `localhost`. This would secure the raw services from being accessible directly from the outside world. + +Caddy will set the headers needed by default for you so there is no further configuration necessary. + +It should also be possible to share the static and images volumes with caddy and use caddy's inbuilt file server to server these directly, but this is beyond the scope of this guide.