-
Notifications
You must be signed in to change notification settings - Fork 33
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
jmb
wants to merge
2
commits into
bookwyrm-social:main
Choose a base branch
from
jmb:patch-1
base: main
Could not load branches
Branch not found: {{ refName }}
Loading
Could not load tags
Nothing to show
Loading
Are you sure you want to change the base?
Some commits from the old base branch may be removed from the timeline,
and old review comments may become outdated.
Open
Changes from all commits
Commits
Show all changes
2 commits
Select commit
Hold shift + click to select a range
File filter
Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -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. | ||
|
||
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. | ||
There was a problem hiding this comment. Choose a reason for hiding this commentThe 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 |
||
|
||
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. |
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
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?