mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
Merge branch 'main' into versions/4.0.0
This commit is contained in:
Joachim Van Herwegen
58
README.md
58
README.md
@@ -1,14 +1,14 @@
|
||||
# Community Solid Server
|
||||
|
||||
<img src="https://raw.githubusercontent.com/solid/community-server/main/templates/images/solid.svg" alt="[Solid logo]" height="150" align="right"/>
|
||||
<img src="https://raw.githubusercontent.com/CommunitySolidServer/CommunitySolidServer/main/templates/images/solid.svg" alt="[Solid logo]" height="150" align="right"/>
|
||||
|
||||
[](https://github.com/solid/community-server/blob/main/LICENSE.md)
|
||||
[](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/solid/community-server/actions)
|
||||
[](https://coveralls.io/github/solid/community-server)
|
||||
[](https://github.com/solid/community-server/discussions)
|
||||
[](https://gitter.im/solid/community-server)
|
||||
[](https://github.com/CommunitySolidServer/CommunitySolidServer/actions)
|
||||
[](https://coveralls.io/github/CommunitySolidServer/CommunitySolidServer)
|
||||
[](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.
|
||||
@@ -16,7 +16,7 @@ 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://solid.github.io/specification/),
|
||||
[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
|
||||
@@ -62,7 +62,7 @@ If you rather prefer to run the latest source code version,
|
||||
or if you want to try a specific [branch](https://www.npmjs.com/) of the code,
|
||||
you can use:
|
||||
```shell
|
||||
git clone https://github.com/solid/community-server.git
|
||||
git clone https://github.com/CommunitySolidServer/CommunitySolidServer.git
|
||||
cd community-server
|
||||
npm ci
|
||||
npm start -- # add parameters if needed
|
||||
@@ -73,7 +73,7 @@ Docker allows you to run the server without having Node.js installed. Images are
|
||||
|
||||
```shell
|
||||
# Clone the repo to get access to the configs
|
||||
git clone https://github.com/solid/community-server.git
|
||||
git clone https://github.com/CommunitySolidServer/CommunitySolidServer.git
|
||||
cd community-server
|
||||
# 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
|
||||
@@ -84,7 +84,13 @@ docker run --rm -v ~/solid-config:/config -p 3000:3000 -it solidproject/communit
|
||||
```
|
||||
|
||||
### 🗃️ Helm Chart
|
||||
The official [Helm](https://helm.sh/) Chart for Kubernetes deployment is maintained and published on [ArtifactHUB](https://artifacthub.io/packages/helm/idlab-gent/css).
|
||||
The official [Helm](https://helm.sh/) Chart for Kubernetes deployment is maintained at [CommunitySolidServer/css-helm-chart](https://github.com/CommunitySolidServer/css-helm-chart) and published on [ArtifactHUB](https://artifacthub.io/packages/helm/community-solid-server/community-solid-server). 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
|
||||
@@ -101,17 +107,17 @@ 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 runs. |
|
||||
| `--baseUrl, -b` | `http://localhost:$PORT/` | The public URL of your server. |
|
||||
| `--loggingLevel, -l` | `info` | The detail level of logging; useful for debugging problems. |
|
||||
|------------------------|----------------------------|--------------------------------------------------------------------------------------------------------------------------------------|
|
||||
| `--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 for the server. The default only stores data in memory; to persist to your filesystem, use `@css:config/file.json` |
|
||||
| `--rootFilePath, -f` | `./` | Root folder of the server, when using a file-based configuration. |
|
||||
| `--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 pages. |
|
||||
| `--podConfigJson` | `./pod-config.json` | Path to the file that keeps track of dynamic Pod configurations. |
|
||||
| `--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.
|
||||
| `--mainModulePath, -m` | | Path from where Components.js will start its lookup when initializing configurations. |
|
||||
|
||||
### 🧶 Custom configurations
|
||||
More substantial changes to server behavior can be achieved
|
||||
@@ -120,29 +126,29 @@ The Community Solid Server uses [Components.js](https://componentsjs.readthedocs
|
||||
to specify how modules and components need to be wired together at runtime.
|
||||
|
||||
Examples and guidance on configurations
|
||||
are available in the [`config` folder](https://github.com/solid/community-server/tree/main/config).
|
||||
are available in the [`config` folder](https://github.com/CommunitySolidServer/CommunitySolidServer/tree/main/config).
|
||||
|
||||
Recipes for configuring the server can be found at [solid/community-server-recipes](https://github.com/solid/community-server-recipes).
|
||||
Recipes for configuring the server can be found at [CommunitySolidServer/recipes](https://github.com/CommunitySolidServer/recipes).
|
||||
|
||||
|
||||
## 👩🏽💻 Developing server code
|
||||
The server allows writing and plugging in custom modules
|
||||
without altering its base source code.
|
||||
|
||||
The [📗 API documentation](https://solid.github.io/community-server/docs/) and
|
||||
The [📗 API documentation](https://communitysolidserver.github.io/CommunitySolidServer/docs/) and
|
||||
the [📐 architectural diagram](https://rubenverborgh.github.io/solid-server-architecture/solid-architecture-v1-3-0.pdf)
|
||||
can help you find your way.
|
||||
|
||||
If you want to help out with server development,
|
||||
have a look at the [📓 developer notes](https://github.com/solid/community-server/blob/main/guides/developer-notes.md) and
|
||||
[🛠️ good first issues](https://github.com/solid/community-server/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
|
||||
have a look at the [📓 user documentation](https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/documentation/) and
|
||||
[🛠️ good first issues](https://github.com/CommunitySolidServer/CommunitySolidServer/issues?q=is%3Aissue+is%3Aopen+label%3A%22good+first+issue%22).
|
||||
|
||||
|
||||
## 📜 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/solid/community-server/blob/main/LICENSE.md).
|
||||
and available under the [MIT License](https://github.com/CommunitySolidServer/CommunitySolidServer/blob/main/LICENSE.md).
|
||||
|
||||
Core contributors are
|
||||
[Joachim Van Herwegen](https://github.com/joachimvh),
|
||||
@@ -153,7 +159,7 @@ and
|
||||
|
||||
|
||||
## 🎤 Feedback and questions
|
||||
Don't hesitate to [start a discussion](https://github.com/solid/community-server/discussions)
|
||||
or [report a bug](https://github.com/solid/community-server/issues).
|
||||
Don't hesitate to [start a discussion](https://github.com/CommunitySolidServer/CommunitySolidServer/discussions)
|
||||
or [report a bug](https://github.com/CommunitySolidServer/CommunitySolidServer/issues).
|
||||
|
||||
Learn more about Solid at [solidproject.org](https://solidproject.org/).
|
||||
|
||||
Reference in New Issue
Block a user