mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
92 lines
4.6 KiB
Markdown
92 lines
4.6 KiB
Markdown
# Community Solid Server
|
||
|
||
<img src="https://raw.githubusercontent.com/CommunitySolidServer/CommunitySolidServer/main/templates/images/solid.svg"
|
||
alt="[Solid logo]" height="150" align="right"/>
|
||
|
||
[](https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/LICENSE.md)
|
||
[](https://www.npmjs.com/package/@solid/community-server)
|
||
[](https://www.npmjs.com/package/@solid/community-server)
|
||
[](https://github.com/CommunitySolidServer/CommunitySolidServer/actions)
|
||
[](https://coveralls.io/github/CommunitySolidServer/CommunitySolidServer)
|
||
[](https://zenodo.org/badge/latestdoi/265197208)
|
||
[](https://github.com/CommunitySolidServer/CommunitySolidServer/discussions)
|
||
[](https://gitter.im/CommunitySolidServer/community)
|
||
|
||
**The Community Solid Server is open software
|
||
that provides you with a [Solid](https://solidproject.org/) 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](https://solidproject.org/TR/),
|
||
the Community Solid Server is a great companion:
|
||
|
||
- 🧑🏽 **for people** who want to try out having their own Pod
|
||
|
||
- 👨🏿💻 **for developers** who want to quickly 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.
|
||
|
||
## ⚡ Running the Community Solid Server
|
||
|
||
Make sure you have [Node.js](https://nodejs.org/en/) 18.0 or higher.
|
||
If this is your first time using Node.js,
|
||
you can find instructions on how to do this [here](https://nodejs.org/en/download/package-manager).
|
||
|
||
```shell
|
||
npx @solid/community-server
|
||
```
|
||
|
||
Now visit your brand new server at [http://localhost:3000/](http://localhost:3000/)!
|
||
|
||
To persist your pod's contents between restarts, use:
|
||
|
||
```shell
|
||
npx @solid/community-server -c @css:config/file.json -f data/
|
||
```
|
||
|
||
In case you prefer to use Docker instead,
|
||
you can find instructions for this and other methods in the
|
||
[documentation](https://communitysolidserver.github.io/CommunitySolidServer/latest/usage/starting-server/).
|
||
|
||
## 🔧 Configure your server
|
||
|
||
Substantial changes to server behavior can be achieved via JSON configuration files.
|
||
The Community Solid Server uses [Components.js](https://componentsjs.readthedocs.io/en/latest/)
|
||
to specify how modules and components need to be wired together at runtime.
|
||
|
||
Recipes for configuring the server can be found at [CommunitySolidServer/recipes](https://github.com/CommunitySolidServer/recipes).
|
||
|
||
Examples and guidance on custom configurations
|
||
are available in the [`config` folder](https://github.com/CommunitySolidServer/CommunitySolidServer/tree/main/config),
|
||
and the [configurations tutorial](https://github.com/CommunitySolidServer/tutorials/blob/main/custom-configurations.md).
|
||
There is also a [configuration generator](https://communitysolidserver.github.io/configuration-generator/).
|
||
|
||
## 👩🏽💻 Developing server code
|
||
|
||
The server allows writing and plugging in custom modules
|
||
without altering its base source code.
|
||
|
||
The [📗 API documentation](https://communitysolidserver.github.io/CommunitySolidServer/5.x/docs) and
|
||
the [📓 user documentation](https://communitysolidserver.github.io/CommunitySolidServer/)
|
||
can help you find your way.
|
||
There is also a repository of [📚 comprehensive tutorials](https://github.com/CommunitySolidServer/tutorials/)
|
||
|
||
## 📜 License
|
||
|
||
The Solid Community Server code
|
||
is copyrighted by [Inrupt Inc.](https://inrupt.com/)
|
||
and [imec](https://www.imec-int.com/)
|
||
and available under the [MIT License](https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/LICENSE.md).
|
||
|
||
## 🎤 Feedback and questions
|
||
|
||
Don't hesitate to [start a discussion](https://github.com/CommunitySolidServer/CommunitySolidServer/discussions)
|
||
or [report a bug](https://github.com/CommunitySolidServer/CommunitySolidServer/issues).
|
||
|
||
There's also [a Matrix-based, CSS-focused chat](https://matrix.to/#/#CommunitySolidServer_community:gitter.im)
|
||
|
||
Learn more about Solid at [solidproject.org](https://solidproject.org/).
|