A local-first personal finance app
Add Caddy Reverse Proxy Instructions (#292)
Shaan Khosla0566e9c30849
diff --git a/.github/actions/spelling/expect.txt b/.github/actions/spelling/expect.txtindex 4e00e9c49f..0434ce8563 100644--- a/.github/actions/spelling/expect.txt+++ b/.github/actions/spelling/expect.txt@@ -13,6 +13,8 @@ lightmodemodalsmurmurhashnginx+caddy+CaddyfileoverbudgetingParibasprefsdiff --git a/README.md b/README.mdindex 8bcf0b31c3..13ac31192e 100644--- a/README.md+++ b/README.md@@ -6,7 +6,7 @@ This repo forms the basis for what will become the new Actual Budget community d## Contributing-Firstly, thankyou for stopping by and giving up some of your time to either check out the documentation we have already produced or pick off some of the [issues](https://github.com/actualbudget/docs/issues) and help create some new documentation for our future users.+Firstly, thank you for stopping by and giving up some of your time to either check out the documentation we have already produced or pick off some of the [issues](https://github.com/actualbudget/docs/issues) and help create some new documentation for our future users.### Installation Methodsdiff --git a/docs/config/reverse-proxies.md b/docs/config/reverse-proxies.mdindex 422ee0cc11..303426e174 100644--- a/docs/config/reverse-proxies.md+++ b/docs/config/reverse-proxies.md@@ -13,6 +13,42 @@ In our examples, the Actual Server should be published under the domain **budgetThe **basic configurations** provided here are only suggestions for implementing a reverse proxy configuration. Additional security mechanisms should then be activated/implemented for the tool selected in each case.:::+## CADDY++Below is an example `Caddyfile` that you can use to configure Caddy and Actual Server using Docker. Caddy is an easy reverse proxy to use since it automatically obtains and renews SSL certificates for you.++```yaml title="docker-compose.yml"+services:+ caddy:+ container_name: caddy+ image: caddy:alpine+ volumes:+ - ./Caddyfile:/etc/caddy/Caddyfile:ro+ - ./caddy/data:/data+ - ./caddy/config:/config+ ports:+ - "80:80"+ - '443:443'++ actual-server:+ image: actualbudget/actual-server:latest+ container_name: actual_server+ restart: unless-stopped+ volumes:+ - ./actual-data:/data+ restart: unless-stopped+ ports:+ - '5006:5006'+```+Caddyfile:+```+budget.example.org {+ encode gzip zstd+ reverse_proxy actual_server:5006+}+```++## TraefikOur example shows a working configuration for Traefik and Actual Server using Docker - as documented in [Install Actual/Docker](../install/docker.md)