Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add simple Caddy reverse proxy instructions #99

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
31 changes: 31 additions & 0 deletions content/running_bookwyrm/reverse-proxy.md
Original file line number Diff line number Diff line change
Expand Up @@ -112,3 +112,34 @@ 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

[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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Can we clarify what "has access to the bookwyrm docker network" means in this context?


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
your.domain {
reverse_proxy /images/* localhost:8001
reverse_proxy /static/* localhost:8001
reverse_proxy localhost:8000
}
``
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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

This is a bit unclear for people who are not super familiar with docker. I think it would benefit from a code example of how one would do this in the docker-compose.yml


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.