From 03a0afd65782edb07526adc51948ef4c8dfc2ef8 Mon Sep 17 00:00:00 2001 From: Kieran Eglin Date: Tue, 14 Jan 2025 12:54:43 -0800 Subject: [PATCH] Add blurb about websockets --- README.md | 5 +++++ 1 file changed, 5 insertions(+) diff --git a/README.md b/README.md index 86e1468b..36f68679 100644 --- a/README.md +++ b/README.md @@ -33,6 +33,7 @@ - [Portainer](#portainer) - [Docker](#docker) - [Environment Variables](#environment-variables) + - [A note on reverse proxies](#reverse-proxies) - [Username and Password (authentication)](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password) - [Frequently asked questions](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions) - [Documentation](https://github.com/kieraneglin/pinchflat/wiki) @@ -156,6 +157,10 @@ If you change this setting and it works well for you, please leave a comment on | `YT_DLP_WORKER_CONCURRENCY` | No | `2` | The number of concurrent workers that use `yt-dlp` _per queue_. Set to 1 if you're getting IP limited, otherwise don't touch it | | `ENABLE_PROMETHEUS` | No | `false` | Setting to _any_ non-blank value will enable Prometheus. See [docs](https://github.com/kieraneglin/pinchflat/wiki/Prometheus-and-Grafana) | +### Reverse Proxies + +Pinchflat makes heavy use of websockets for real-time updates. If you're running Pinchflat behind a reverse proxy then you'll need to make sure it's configured to support websockets. + ## EFF donations Prior to 2024-05-10, a portion of all donations were given to the [Electronic Frontier Foundation](https://www.eff.org/). Now, the app doesn't accept donations that go to me personally and instead directs you straight to the EFF. [Here](https://github.com/kieraneglin/pinchflat/issues/234) are some people that have generously donated.