From 20a6fe7e28467b319cfab2af6c2fe465b73a01bc Mon Sep 17 00:00:00 2001
From: "B. Stack" <bgstack15@gmail.com>
Date: Wed, 30 Aug 2023 18:54:10 -0400
Subject: prepare documentation

---
 README.md | 16 ++++++++++++++++
 1 file changed, 16 insertions(+)

(limited to 'README.md')

diff --git a/README.md b/README.md
index 4ec3a1d..50b6dd7 100644
--- a/README.md
+++ b/README.md
@@ -25,6 +25,21 @@ Basic docker experience should suffice. You can make a directory, e.g., `instanc
 
     docker run -p 5004:5004 --mount type=bind,source=./instance,destination=/newspipe/instance -it --rm newspipe:latest entrypoint.sh create_admin admin "1234567890"
 
+To use a reverse proxy, you need to set config variable in your `sqlite.py` or `config.py`:
+
+    PREFIX = "/newspipe"
+
+And here is an example apache httpd directive:
+
+    <Location /newspipe>
+       ProxyPass http://newspipe.vm.example.com:5004/ retry=0
+       ProxyPassReverse http://newspipe.vm.example.com:5004/
+       # You might be tempted to try the following, but it does not work in flask or newspipe.
+       # a2enmod headers. These are extra ones that are not provided by Apache natively.
+       #RequestHeader append X-Forwarded-Prefix "/newspipe"
+       #RequestHeader append X-Script-Name "/newspipe"
+    </Location>
+
 # Operations
 ## Create admin user
 If you are using bare docker:
@@ -59,3 +74,4 @@ Future improvements include:
 1. <https://stackoverflow.com/questions/72465421/how-to-use-poetry-with-docker>
 2. <https://git.sr.ht/~cedric/newspipe>
 3. FreeIPA auth (ldap+kerberos) for a different rss reader, in a different language <https://git.sacredheartsc.com/ttrss-freeipa/tree/auth_freeipa/init.php>
+4. Apache httpd config syntax from <https://radicale.org/v3.html#reverse-proxy>
-- 
cgit