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

fix: Update config files path

Browse Source
This commit is contained in:
Simone Persiani 2021-05-19 11:10:13 +02:00 committed by Joachim Van Herwegen
parent 452032e312
commit a7a0e2d264
4 changed files with 9 additions and 9 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

2
Dockerfile
View File

@ -47,4 +47,4 @@ EXPOSE 3000
ENTRYPOINT [ "node", "bin/server.js" ]
## By default run in filemode (overriden if passing alternative arguments)
CMD [ "-c", "config/config-file.json", "-f", "/data" ]
CMD [ "-c", "config/file.json", "-f", "/data" ]

4
README.md
View File

@ -64,7 +64,7 @@ Additional recipes for configuring and deploying the server can be found at [sol
| --------- | ------- | ----------- |
| `--port, -p` | `3000` | |
| `--baseUrl. -b` | `"http://localhost:$PORT/"` | Needs to be set to the base URL of the server for authnetication and authorization to function. |
| `--config, -c` | `"config/config-default.json"` | `config-default.json` stores all data in memory. If you would like to persist data to your filesystem, try `config-file.json` |
| `--config, -c` | `"config/default.json"` | `config/default.json` stores all data in memory. If you would like to persist data to your filesystem, try `config/file.json` |
| `--mainModulePath, -m` | | Absolute path to the package root from which ComponentJS module resolution should start. |
| `--loggingLevel, -l` | `"info"`| |
| `--rootFilePath, -f` | `"./"` | Folder to start the server in when using a file-based config. |
@ -198,7 +198,7 @@ Common usage:
```
- Use alternative versions of the built in config. The filestorage is just the default configuration, you can override with any of the configurations included with the server
```shell
docker run --rm -p 3000:3000 -it css:latest -c config/config-default.json
docker run --rm -p 3000:3000 -it css:latest -c config/default.json
```
Or override it with your own config mapped to the right directory
```shell

8
documentation/Create-a-custom-configuration.md
View File

@ -1,5 +1,5 @@
By default, the server will start with a set of preconfigured components.
These components are configured in [`config-default.json`](https://github.com/solid/community-server/tree/master/config/config-default.json).
These components are configured in [`config/default.json`](https://github.com/solid/community-server/tree/master/config/default.json).
Learn more about the structure of this config file in the [notes for developers](https://github.com/solid/community-server/wiki/Notes-for-developers#add-components-to-configuration).
## Local development environment
@ -9,12 +9,12 @@ _This guide assumes the server is installed locally by cloning the git repo._
When starting the server via `bin/server.js`, you can provide another config via the `-c` flag.
For example:
```bash
$ bin/server.js -c config/config-default.json
$ bin/server.js -c config/default.json
```
The command above will behave in the exact same way as just running `bin/server.js`, since `config/config-default.json` is the default server config for when `-c` is not provided.
The command above will behave in the exact same way as just running `bin/server.js`, since `config/default.json` is the default server config for when `-c` is not provided.
If you for example create a copy from `config/config-default.json` named `my-config.json`, and make some adjustments, you can invoke it as follows:
If you for example create a copy from `config/default.json` named `my-config.json`, and make some adjustments, you can invoke it as follows:
```bash
$ bin/server.js -c my-config.json
```

4
documentation/Notes-for-developers.md
View File

@ -27,8 +27,8 @@ The advantage of this is that changing the configuration of components does not
### Config file structure
In order to add a component to the default configuration,
you will have to update [`config-default.json`](https://github.com/solid/community-server/tree/master/config/config-default.json),
or any of its _imported_ files, which exist in the [`presets`](https://github.com/solid/community-server/tree/master/config/presets) folder.
you will have to update [`config/default.json`](https://github.com/solid/community-server/tree/master/config/default.json),
or any of its _imported_ files, which exist in the [`config subfolders`](https://github.com/solid/community-server/tree/master/config/).
A component in a configuration file has the following structure:
```json