Awesome Open Source
Awesome Open Source

Community Solid Server

[Solid logo]

MIT license npm version Node.js version Build Status Coverage Status GitHub discussions Chat on Gitter

The Community Solid Server is open software that provides you with a Solid Pod and identity. This Pod acts as your own personal storage space so you can share data with people and Solid applications.

As an open and modular implementation of the Solid specifications, the Community Solid Server is a great companion:

  • for people who want to try out having their own Pod

  • for developers who want to create and test Solid apps

  • for researchers who want to design new features for Solid

And, of course, for many others who like to experience Solid.

You can install the software locally or on your server and get started with Solid immediately.

Running the server

To run the server, you will need Node.js. We support versions 14.2 and up.

If you do not use Node.js, you can run a Docker version instead.

Installing and running locally

After installing Node.js, install the latest server version from the npm package repository:

npm install -g @solid/community-server

To run the server with in-memory storage, use:

community-solid-server # add parameters if needed

To run the server with your current folder as storage, use:

community-solid-server -c @css:config/file.json

Installing and running from source

If you rather prefer to run the latest source code version, or if you want to try a specific branch of the code, you can use:

git clone https://github.com/CommunitySolidServer/CommunitySolidServer.git
cd CommunitySolidServer
npm ci
npm start -- # add parameters if needed

Running via Docker

Docker allows you to run the server without having Node.js installed. Images are built on each tagged version and hosted on Docker Hub.

# 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
# Or use environment variables to configure your css instance
docker run --rm -v ~/Solid:/data -p 3000:3000 -it -e CSS_CONFIG=config/file-no-setup.json -e CSS_LOGGING_LEVEL=debug solidproject/community-server

Helm Chart

The official Helm Chart for Kubernetes deployment is maintained at CommunitySolidServer/css-helm-chart and published on ArtifactHUB. There you will find complete installation instructions.

# Summary
helm repo add community-solid-server https://communitysolidserver.github.io/css-helm-chart/charts/
helm install my-css community-solid-server/community-solid-server

Configuring the server

The Community Solid Server is designed to be flexible such that people can easily run different configurations. This is useful for customizing the server with plugins, testing applications in different setups, or developing new parts for the server without needing to change its base code.

Parameters

An easy way to customize the server is by passing parameters to the server command. These parameters give you direct access to some commonly used settings:

parameter name default value description
--port, -p 3000 The TCP port on which the server should listen.
--baseUrl, -b http://localhost:$PORT/ The base URL used internally to generate URLs. Change this if your server does not run on http://localhost:$PORT/.
--loggingLevel, -l info The detail level of logging; useful for debugging problems. Use debug for full information.
--config, -c @css:config/default.json The configuration(s) for the server. The default only stores data in memory; to persist to your filesystem, use @css:config/file.json
--rootFilePath, -f ./ Root folder where the server stores data, when using a file-based configuration.
--sparqlEndpoint, -s URL of the SPARQL endpoint, when using a quadstore-based configuration.
--showStackTrace, -t false Enables detailed logging on error output.
--podConfigJson ./pod-config.json Path to the file that keeps track of dynamic Pod configurations. Only relevant when using @css:config/dynamic.json.
--seededPodConfigJson Path to the file that keeps track of seeded Pod configurations.
--mainModulePath, -m Path from where Components.js will start its lookup when initializing configurations.
--workers, -w 1 Run in multithreaded mode using workers. Special values are -1 (scale to num_cores-1), 0 (scale to num_cores) and 1 (singlethreaded).

Multithreading

The Community Solid Server can be started in multithreaded mode with any config. The config must only contain components that are threadsafe though. If a non-threadsafe component is used in multithreaded mode, the server will describe with an error which class is the culprit.

# Running multithreaded with autoscaling to number of logical cores minus 1
npm start -- -c config/file.json -w -1

Environment variables

Parameters can also be passed through environment variables.

They are prefixed with CSS_ and converted from camelCase to CAMEL_CASE

eg. --showStackTrace => CSS_SHOW_STACK_TRACE

Note: command-line arguments will always override environment variables!

Custom configurations

More substantial changes to server behavior can be achieved by writing new configuration files in JSON-LD. The Community Solid Server uses Components.js to specify how modules and components need to be wired together at runtime.

Examples and guidance on configurations are available in the config folder.

Recipes for configuring the server can be found at CommunitySolidServer/recipes.

Developing server code

The server allows writing and plugging in custom modules without altering its base source code.

The API documentation and the architectural diagram can help you find your way.

If you want to help out with server development, have a look at the user documentation and good first issues.

License

The Solid Community Server code is copyrighted by Inrupt Inc. and imec and available under the MITLicense.

Core contributors are Joachim Van Herwegen, Ruben Verborgh, Ruben Taelman, and Matthieu Bosquet.

Feedback and questions

Don't hesitate to start a discussion or report a bug.

Learn more about Solid at solidproject.org.

Related Awesome Lists
Top Programming Languages
Top Projects

Get A Weekly Email With Trending Projects For These Topics
No Spam. Unsubscribe easily at any time.
Typescript (266,780
Rdf (3,092
Linked Data (445
Ldp (41