add example config for nginx subdirectory

ssb22 · Oct 29, 2022 · 5cd85f7 · 5cd85f7
1 parent 4aec063
commit 5cd85f7
Show file tree

Hide file tree

Showing 2 changed files with 34 additions and 0 deletions.
diff --git a/README.md b/README.md
@@ -199,6 +199,23 @@ location / {
 }
 ```
 
+If the Nginx server is also serving a website,
+you can have it put WebSSH into a subdirectory:
+
+```nginx
+location = /webssh {
+    return 302 /webssh/;
+}
+location /webssh/ws {
+    proxy_pass http://127.0.0.1:8888/ws;
+    proxy_http_version 1.1;
+    # ... (rest as above)
+}
+location /webssh/ {
+    proxy_pass http://127.0.0.1:8888/;
+}
+```
+
 Running as a standalone server
 ```bash
 wssh --port=8080 --sslport=4433 --certfile='cert.crt' --keyfile='cert.key' --xheaders=False --policy=reject

diff --git a/README.rst b/README.rst
@@ -214,6 +214,23 @@ Running behind an Nginx server
         proxy_set_header X-Real-PORT $remote_port;
     }
 
+If the Nginx server is also serving a website,
+you can have it put WebSSH into a subdirectory:
+
+.. code:: nginx
+
+    location = /webssh {
+        return 302 /webssh/;
+    }
+    location /webssh/ws {
+        proxy_pass http://127.0.0.1:8888/ws;
+        proxy_http_version 1.1;
+        # ... (rest as above)
+    }
+    location /webssh/ {
+        proxy_pass http://127.0.0.1:8888/;
+    }
+
 Running as a standalone server
 
 .. code:: bash