mirror of
https://github.com/CommunitySolidServer/CommunitySolidServer.git
synced 2024-10-03 14:55:10 +00:00
184a862297
* Add basic documentation of config variables * Address PR comments * Added additional documentation based on chat with Joachim * Import wiki to documentation folder The reason for this migration is that community members cannot submit PRs against the wiki to update documentation, so move them here so they can. Next steps are to deploy this folder as part of the docs CI setup. * Update README.md Co-authored-by: Joachim Van Herwegen <joachimvh@gmail.com> * Address Joachim's comments Co-authored-by: Joachim Van Herwegen <joachimvh@gmail.com>
28 lines
1.4 KiB
Markdown
28 lines
1.4 KiB
Markdown
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).
|
|
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
|
|
|
|
_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
|
|
```
|
|
|
|
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.
|
|
|
|
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:
|
|
```bash
|
|
$ bin/server.js -c my-config.json
|
|
```
|
|
|
|
## Globally installed server
|
|
|
|
TODO: after making a first release, write a guide on how to create a custom config for it when it is globally installed.
|
|
|
|
## Including the server as dependency in another package.
|
|
|
|
TODO: after making a first release, write a guide on how to create a custom config for it when it is included as a dependency in another package. |