Mirroristas/CommunitySolidServer
2
0
Fork 0
mirror of https://github.com/CommunitySolidServer/CommunitySolidServer.git synced 2024-10-03 14:55:10 +00:00
Code Issues Packages Projects Releases Wiki Activity

docs: Update readme with config as env var update

Browse Source 
docs: simplify readme section
This commit is contained in:
Thomas Dupont 2022-07-06 15:00:57 +02:00 committed by Joachim Van Herwegen
parent c6c42e40cc
commit d6ff3b39d2
1 changed files with 11 additions and 0 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

11
README.md
View File

@ -81,6 +81,8 @@ docker run --rm -v ~/Solid:/data -p 3000:3000 -it solidproject/community-server:
docker run --rm -p 3000:3000 -it solidproject/community-server -c config/default.json docker run --rm -p 3000:3000 -it solidproject/community-server -c config/default.json
# Or use your own configuration mapped to the right directory # 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 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 ### 🗃️ Helm Chart
@ -119,6 +121,15 @@ to some commonly used settings:
| `--seededPodConfigJson` | | Path to the file that keeps track of seeded Pod configurations. | | `--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. |
### 🖥️ 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 ### 🧶 Custom configurations
More substantial changes to server behavior can be achieved More substantial changes to server behavior can be achieved
by writing new configuration files in JSON-LD. by writing new configuration files in JSON-LD.