danvics/pinchflat
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions

README: add Caddy proxy example

Browse source 
It took me a minute to figure out that Pinchflat needed me to
"strip_prefix" so maybe this will help others.
This commit is contained in:
Brandon Philips 2025-04-03 16:11:42 -07:00
parent 1cee7a19ee
commit 5bd35efa23
1 changed files with 16 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

16
README.md
View file

@ -183,6 +183,22 @@ If you change this setting and it works well for you, please leave a comment on
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.
### Caddy Proxy Example
To configure Pinchflat behind Caddy set the `BASE_ROUTE_PATH` environment variable to `/pinchflat/` then add a stanza like this to the `Caddyfile`:
```
home.example.com:443 {
redir /pinchflat /pinchflat/
handle_path /pinchflat/* {
reverse_proxy localhost:8945
}
}
```
Now you can access Pinchflat from http://home.example.com/pinchflat
## 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.