add documentation

README.md

@@ -77,6 +77,8 @@ volumes:
   postgres_prod_data:
 ```
 
+For examples with a reverse proxy, see [documentation about deployment](docs/deployment.md).
+
 ### Development
 
 -   Start up app necessary services

docker-compose.yml

@@ -1,12 +1,6 @@
 version: "3.8"
 
 services:
-  nginx:
-    image: nginx:latest
-    ports:
-      - 80:80
-    volumes:
-      - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
   app:
     build:
       context: .

docs/deployment.md

@@ -0,0 +1,81 @@
+# Deployment
+## Behind a Reverse Proxy
+
+TeamMapper supports deployment behind a reverse proxy. Here's an example configuration using nginx with docker compose, though other reverse proxy setups will work as well. Add these lines to your docker-compose.yml:
+
+```
+nginx:
+  image: nginx:latest
+  ports:
+    - 80:80
+  volumes:
+    - ./nginx/nginx.conf:/etc/nginx/nginx.conf:ro
+```
+
+Then create a `nginx.conf` file in the folder `nginx`, with one of the following setups.
+
+### Reverse Proxy using a Subdomain
+```
+server {
+  listen 80;
+  listen [::]:80;
+  server_name teammapper.lan.DOMAIN.tld;
+
+  return 301 https://$host$request_uri;
+}
+server {
+  listen 443 ssl;
+  listen [::]:443 ssl;
+  server_name teammapper.lan.DOMAIN.tld;
+
+  # certificates for ssl, change according to your setup
+  # ssl_certificate /etc/letsencrypt/live/lan.DOMAIN.tld/fullchain.pem;
+  # ssl_certificate_key /etc/letsencrypt/live/lan.DOMAIN.tld/privkey.pem;
+
+  location / {
+      proxy_pass http://teammapper:3000/;
+      proxy_http_version 1.1;
+      proxy_set_header Host $http_host;
+      proxy_set_header X-Real-IP $remote_addr;
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header X-Forwarded-Proto $scheme;
+      proxy_set_header Access-Control-Allow-Origin *;
+      proxy_set_header Upgrade $http_upgrade;
+      proxy_set_header Connection "Upgrade";
+  }
+}
+```
+
+### Reverse Proxy using a Path
+When hosting TeamMapper under a path (e.g. /teammapper/), the `<base href>` tag in the HTML needs to be updated to match that path. This ensures TeamMapper can correctly resolve relative URLs for assets, API calls, and navigation. For nginx, this can be achieved using the `sub_filter` directive to dynamically replace the base href. For Apache, the equivalent functionality is provided by the `mod_substitute` module.
+
+```
+events {
+  worker_connections 1024;
+}
+
+http {
+  server {
+    listen 80;
+    server_name localhost;
+
+    location /teammapper/ {
+      proxy_pass http://teammapper:3000/;
+      sub_filter '<base href="/"/>' '<base href="/teammapper/" />';
+      sub_filter_types text/html;
+      sub_filter_once on;
+      
+      # Add proper proxy headers
+      proxy_set_header Host $host;
+      proxy_set_header X-Real-IP $remote_addr;
+      proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
+      proxy_set_header X-Forwarded-Proto $scheme;
+      
+      # WebSocket support
+      proxy_http_version 1.1;
+      proxy_set_header Upgrade $http_upgrade;
+      proxy_set_header Connection "upgrade";
+    }
+  }
+}
+```