solid / solid/solidproject.org

Using Apache as a Reverse Proxy mentions settings for the wrong server

Open
#633 1 comment 1 reaction 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
HTML
Stars
183
Forks
152
PR merge metrics
No merged PRs in 30d

Description

Search terms you've used

is:issue Apache

What problem are you trying to solve? Please describe.

The documentation of Running Community Solid Server mentions on the right side that it is about Running Community Solid Server but in reality the settings provided are for the Node Solid Server. These settings will not work for the Solid Server.

What existing documentation is relevant to your problem, and why is it insufficient?

In the current version one needs help from Solid developers to setup a reverse proxy for the Solid Server.

Here is an example of a Apache configuration that will work for running the community solid server.

<VirtualHost *:443>
    ServerName solid.example

    .
    . (snip)
    .

    RewriteEngine

    # Pass the host and protocol
    RequestHeader set X-Forwarded-Host solid.example
    RequestHeader set X-Forwarded-Proto https

    # Delegate to the Solid server
    ProxyPreserveHost On
    ProxyPass / http://localhost:3000/
    ProxyPassReverse / http://localhost:3000/

    # Enable websockets
    RewriteCond %{HTTP:Upgrade} websocket [NC]
    RewriteCond %{HTTP:Connection} upgrade [NC]
    RewriteRule ^/?(.*) "ws://localhost:3000/$1" [P,L]

    .
    . (snip)
    .
</VirtualHost>

The SSL setting below are for the NSS server and not required for running a CSS server:

SSLProxyEngine On
SSLProxyVerify None
SSLProxyCheckPeerCN Off
SSLProxyPeerName Off
SSLProxyCheckPeerExpire Off

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Locate the documentation page for “Running Community Solid Server” and compare its Apache reverse-proxy settings with the configuration shown in this issue. Update the page so the CSS example is accurate and remove the NSS-only SSL settings, then verify that the rendered documentation clearly describes the working Apache setup.

Written by the indexing model from the issue text.

Assessment

Tech stack
apache
Domain
documentation
Issue type
Documentation
Difficulty
2/5
Estimated time
1-3 hours
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
45/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.