Running your own Solid server
A Solid server allows you to register for a Pod and a WebID.
You can either use a publicly available server or follow the steps on this page to set up your own.
The following open-source servers are available:
- Community Solid Server for Node.js
- Node Solid Server for Node.js
- solid-nextcloud as a plugin for Nextcloud
- PHP Solid Server for PHP
And the following commercial servers are available:
We walk you through the installation of the Community Solid Server below.
We also provide Instructions for Node Solid Server.
Running the Community Solid Server
To run the Community Solid Server, you can choose between:
Via Node.js and npm
Ensure you have installed Node.js.
We support versions 12.7 and up,
but recommend 14 or 16.
To install the server, open a command prompt and type:
npm install -g @solid/community-server
To run the server with in-memory storage, type:
To run the server with file-based storage, type:
community-solid-server -c @css:config/file.json
You can now access your server locally.
Docker allows you to run the server without having Node.js installed:
# Clone the repo to get access to the configs git clone https://github.com/CommunitySolidServer/CommunitySolidServer.git cd CommunitySolidServer # Run the image, serving your `~/Solid` directory on `http://localhost:3000` docker run --rm -v ~/Solid:/data -p 3000:3000 -it solidproject/community-server:latest # Or use one of the built-in configurations docker run --rm -p 3000:3000 -it solidproject/community-server -c config/default.json # Or use your own configuration mapped to the right directory docker run --rm -v ~/solid-config:/config -p 3000:3000 -it solidproject/community-server -c /config/my-config.json
Accessing your server
Open your browser and visit http://localhost:3000/. You will be greeted by a welcome page.
This welcome page is hosted on a root Pod, to which you and your apps can read and write.
Creating your own account
To create your own account,
The server can then host your Pod and WebID.
Extending your server
The Community Solid Server is highly modular and supports many different configurations and plugins.
The Recipes contain a couple of examples to get started.
These are some plugins you can add to your server:
Exposing your server publicly
The Solid server will run as a local Web server. You can expose the server directly either by running it on a public port or by placing it behind a reverse proxy.
When going public,
be sure to tell the server its base URL via the
community-solid-server -b https://server.example/
Here are instructions to set up common proxy servers: