https://github.com/communitysolidserver/recipes
Example configurations for the Community Solid Server
https://github.com/communitysolidserver/recipes
solid
Last synced: 5 months ago
JSON representation
Example configurations for the Community Solid Server
- Host: GitHub
- URL: https://github.com/communitysolidserver/recipes
- Owner: CommunitySolidServer
- License: unlicense
- Created: 2021-01-21T13:27:09.000Z (about 5 years ago)
- Default Branch: main
- Last Pushed: 2025-01-30T08:31:04.000Z (about 1 year ago)
- Last Synced: 2025-06-05T04:43:55.415Z (10 months ago)
- Topics: solid
- Homepage:
- Size: 3.97 MB
- Stars: 22
- Watchers: 5
- Forks: 11
- Open Issues: 12
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
![[Solid Logo]](https://avatars.githubusercontent.com/u/14262490?s=66)
# 🍱 Community Solid Server recipes
This repository contains example configurations
for the [Community Solid Server](https://github.com/CommunitySolidServer/CommunitySolidServer),
to get you started quickly.
You can launch the Community Solid Server with the following user interfaces:
- [Mashlib Data Browser](https://github.com/SolidOS/mashlib)
- [Penny](https://forum.solidproject.org/t/new-developer-tool-app-penny/3837)
## ⚙️ Installing the recipes
```shell
# Load the configurations to your device
git clone https://github.com/CommunitySolidServer/Recipes
cd Recipes
# Pick the configuration of your choice, and install its dependencies
cd mashlib # or penny
npm ci --omit=dev
```
## 🚀 Starting the server from a recipe
### Mashlib
The Mashlib configurations are in the `mashlib` folder.
```shell
# Start the server with your documents folder as the root container
npx community-solid-server -c config-mashlib.json -f ~/Documents/
# Start the server in development mode (authenticated as a specific user)
npx community-solid-server -c config-mashlib-dev.json -f ~/Documents/
```
### Penny
The Penny configurations are in the `penny` folder.
```shell
# Start the server with your documents folder as the root container
npx community-solid-server -c config-penny.json -f ~/Documents/
```
## 📜 Customizing the recipes
The configurations provided here are just one possible combination of CSS features.
You can use the following links to generate alternative configurations
that also include the necessary statements for the relevant interfaces:
* [Mashlib](https://communitysolidserver.github.io/configuration-generator/v7/?config=https://raw.githubusercontent.com/CommunitySolidServer/Recipes/main/mashlib/config-mashlib.json&removeImports=%22util/index%22)
* [Penny](https://communitysolidserver.github.io/configuration-generator/v7/?config=https://raw.githubusercontent.com/CommunitySolidServer/Recipes/main/penny/config-penny.json&removeImports=%22util/index%22)