From 115bb78ac9919a9a1fc046622b4545e9ba4513f5 Mon Sep 17 00:00:00 2001 From: Ruben Beltran del Rio Date: Tue, 23 Dec 2025 22:58:29 +0100 Subject: Add more information for self-hosters. --- README.md | 23 +++++++++++++++++++++++ 1 file changed, 23 insertions(+) diff --git a/README.md b/README.md index 723b1c9..0410a0c 100644 --- a/README.md +++ b/README.md @@ -23,6 +23,29 @@ To use this plugin, you must set the `security_type` to `"oidc"`. out from the wiki. Providers like Pocket ID don't allow you to be redirected back if this is true. **Optional, defaults to `false`** +### Additional Considerations + +When running behind a reverse proxy such as `nginx`, it might be necessary to +increase the buffer sizes to properly handle the response. We use: + +``` +proxy_busy_buffers_size 512k; +proxy_buffers 4 512k; +proxy_buffer_size 256k; +``` + +Likewise, if running behind a reverse proxy, you might need to set up the +following configuration values in your `config.json` to get the right +callbacks: + +``` +{ +... +security_useHttps: true, +wiki_domain: +} +``` + ## Development workflow This project has a `Makefile` that encapsulates some of the common development -- cgit