diff --git a/examples/readeck/README.md b/examples/readeck/README.md index 064da71..6a604df 100644 --- a/examples/readeck/README.md +++ b/examples/readeck/README.md @@ -1,3 +1,21 @@ # References - https://codeberg.org/readeck/readeck +- https://readeck.org/en/docs/deploy#setup-a-reverse-proxy + +# Notes + +If you're using readeck as a container behind a reverse proxy, you must set the environment variable `READECK_USE_X_FORWARDED=1`. + +Furthermore, you must adjust the `allowed_hosts` directive the Readeck config at `/etc/readeck/config.toml`: + +```` +[server] +host = "0.0.0.0" +port = 8000 +allowed_hosts = ["readeck.example.com"] +use_x_forwarded_for = true +use_x_forwarded_host = true +use_x_forwarded_proto = true +```` +