Document auth session proxy routes for Apache deploys
This commit is contained in:
@@ -68,13 +68,23 @@ cd "$REPO_ROOT"
|
||||
./deploy/scripts/install_apache.sh "$REPO_ROOT" /path/to/apache/include/chgrid.conf
|
||||
```
|
||||
|
||||
Expected proxy endpoint:
|
||||
Expected proxy endpoints:
|
||||
|
||||
```apache
|
||||
ProxyPass /ws ws://127.0.0.1:8765
|
||||
ProxyPassReverse /ws ws://127.0.0.1:8765
|
||||
ProxyPass /auth/session/ http://127.0.0.1:8765/auth/session/
|
||||
ProxyPassReverse /auth/session/ http://127.0.0.1:8765/auth/session/
|
||||
```
|
||||
|
||||
What each route does:
|
||||
- `/ws`: websocket signaling (presence, movement, item actions, chat, voice signaling).
|
||||
- `/auth/session/set`: called by client after successful login to set `HttpOnly` session cookie.
|
||||
- `/auth/session/clear`: called by client on logout/session-reset to clear `HttpOnly` session cookie.
|
||||
|
||||
Important:
|
||||
- Keep `/auth/session/*` at domain root even when the app is served from a subpath like `/chgrid`.
|
||||
|
||||
After Apache changes, reload Apache using your host's command.
|
||||
|
||||
## 7) Optional HTTP Stream Relay
|
||||
|
||||
@@ -4,8 +4,12 @@
|
||||
# Optional but recommended modules for client update freshness: headers, setenvif
|
||||
|
||||
# Proxy websocket signaling endpoint to local Python service.
|
||||
# `/ws` is used by the browser signaling client for realtime packets.
|
||||
ProxyPass /ws ws://127.0.0.1:8765
|
||||
ProxyPassReverse /ws ws://127.0.0.1:8765
|
||||
# Proxy auth cookie helper endpoints to local Python service.
|
||||
# These root-scoped paths are required even when the app is hosted under `/chgrid`.
|
||||
# The client calls `/auth/session/set` after login and `/auth/session/clear` on logout/session-reset.
|
||||
ProxyPass /auth/session/ http://127.0.0.1:8765/auth/session/
|
||||
ProxyPassReverse /auth/session/ http://127.0.0.1:8765/auth/session/
|
||||
|
||||
|
||||
Reference in New Issue
Block a user