Skip to content

Document config.json setup behind a reverse proxy - #1876

Closed
Saifjafri212213 wants to merge 1 commit into
nodeSolidServer:mainfrom
Saifjafri212213:docs/reverse-proxy-config
Closed

Saifjafri212213 wants to merge 1 commit into
nodeSolidServer:mainfrom
Saifjafri212213:docs/reverse-proxy-config

Conversation

@Saifjafri212213

Copy link
Copy Markdown

Closes #819

Adds docs/reverse-proxy.md and links it from the README's "Running Solid behind a reverse proxy" section.

The page covers:

  • port vs. serverUri: port is the internal port the proxy forwards to; serverUri is the public URL and should not include the internal port.
  • TLS between proxy and solid-server: keeping sslKey/sslCert (HTTPS backend) vs. omitting them (plain HTTP backend), including the note that session cookies are only marked Secure when sslKey is set.
  • What the proxy must forward: the Host header (used to resolve pods, especially in multi-user mode), WebSocket upgrade headers for live updates, and longer timeouts.
  • Multi-user mode: wildcard DNS, wildcard certificate, and wildcard server_name.
  • Example configs for NGINX and Apache, plus a note that WebID-TLS doesn't work behind a TLS-terminating proxy.

The NGINX example is based on the existing wiki page and the solidweb.org setup shared in the issue, with WebSocket headers added. The Apache example hasn't been tested; feedback from anyone running Apache is welcome.

Explain the difference between port and serverUri, TLS options
between the proxy and solid-server, required proxy headers
(Host, WebSocket upgrade), multi-user mode, and add example
NGINX and Apache configurations.

Closes nodeSolidServer#819
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

Document config.json when using reverse proxy

1 participant