Skip to content

Commit 03a0afd

Browse files
committed
Add blurb about websockets
1 parent ca90da4 commit 03a0afd

File tree

1 file changed

+5
-0
lines changed

1 file changed

+5
-0
lines changed

README.md

+5
Original file line numberDiff line numberDiff line change
@@ -33,6 +33,7 @@
3333
- [Portainer](#portainer)
3434
- [Docker](#docker)
3535
- [Environment Variables](#environment-variables)
36+
- [A note on reverse proxies](#reverse-proxies)
3637
- [Username and Password (authentication)](https://github.com/kieraneglin/pinchflat/wiki/Username-and-Password)
3738
- [Frequently asked questions](https://github.com/kieraneglin/pinchflat/wiki/Frequently-Asked-Questions)
3839
- [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
156157
| `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 |
157158
| `ENABLE_PROMETHEUS` | No | `false` | Setting to _any_ non-blank value will enable Prometheus. See [docs](https://github.com/kieraneglin/pinchflat/wiki/Prometheus-and-Grafana) |
158159

160+
### Reverse Proxies
161+
162+
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.
163+
159164
## EFF donations
160165

161166
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.

0 commit comments

Comments
 (0)