Skip to content

Commit e09803e

Browse files
committed
Update README
1 parent fa96c63 commit e09803e

1 file changed

Lines changed: 3 additions & 1 deletion

File tree

README.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -100,12 +100,13 @@ You can customize the application settings via a configuration file, e.g. by pro
100100

101101
All configuration options can also be set via environment variables (`.env` when running via Node.js or using `environment` or `env_file` in Docker Compose).
102102

103-
Please consult the table below for possible configuration options. Some notes:
103+
Some notes:
104104

105105
- To use a custom Wikibase instance, you can set the subkeys of the `wikibase` property. Both `instance` and `sparqlEnpoint` are necessary. By default, Wikidata is used.
106106
- wikidata-jskos supports saving, editing, and deleting mappings in Wikidata. To enable this, you will need to provide `auth.algorithm` and `auth.key` (algorithm and key to decode the JWT, usually coming from [login-server]), as well as `oauth.consumer_key` and `oauth.consumer_secret` (for your registered OAuth consumer).
107107
- `auth.key`/`AUTH_KEY` contain line breaks. In JSON, these can simply be set as `\n`. When using `.env` or `env_file`, the whole key needs to be double-quoted (`"-----BEGIN PUBLIC KEY-----\n..."`). To set `AUTH_KEY` directly in `docker-compose.yml` via `environment`, please look at the included [`docker-compose.yml`](./docker/docker-compose.yml) file or refer to [this StackOverflow answer](https://stackoverflow.com/a/53198865).
108108
- Please provide a `baseUrl` when used in production. If no baseUrl is provided, `http://localhost:${port}/` will be used.
109+
- List of all available configuration options:
109110

110111
| `config.json` key | environment variable | default value |
111112
| ----------------------- | -------------------- | ----------------------------------- |
@@ -136,6 +137,7 @@ npm run start
136137
For deployment there is a config file to use with [pm2](http://pm2.keymetrics.io/):
137138

138139
```bash
140+
cp ecosystem.example.json ecosystem.config.json
139141
pm2 start ecosystem.config.json
140142
```
141143

0 commit comments

Comments
 (0)