diff options
| author | Christian Bläul | 2019-08-17 11:40:53 +0200 |
|---|---|---|
| committer | Christian Bläul | 2019-08-17 11:40:53 +0200 |
| commit | 29e1ff7699b86c327940153ba9dce0fc23794310 (patch) | |
| tree | 646bdebccdb6b7699b34f4f19ea8ccab35b6799c /docs | |
| parent | 60d6a6a15dd029a40d5f267d3143febb7fb4afba (diff) | |
Documentation: improved dbURL description
Signed-off-by: Christian Bläul <christian@blaeul.de>
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration-config-file.md | 2 | ||||
| -rw-r--r-- | docs/configuration-env-vars.md | 2 |
2 files changed, 2 insertions, 2 deletions
diff --git a/docs/configuration-config-file.md b/docs/configuration-config-file.md index bf8d90ba..407eb9e3 100644 --- a/docs/configuration-config-file.md +++ b/docs/configuration-config-file.md @@ -26,7 +26,7 @@ to `config.json` before filling in your own details. | --------- | ------ | ----------- | | `allowPDFExport` | `true` | Whether or not PDF export is offered. | | `db` | `{ "dialect": "sqlite", "storage": "./db.codimd.sqlite" }` | set the db configs, [see more here](http://sequelize.readthedocs.org/en/latest/api/sequelize/) | -| `dbURL` | `mysql://localhost:3306/database` | set the db URL; if set, then `db` config will be overridden. | +| `dbURL` | `mysql://localhost:3306/database` | Set the db in URL style. If set, then the relevant `db` config entries will be overridden. | | `forbiddenNoteIDs` | `['robots.txt']` | disallow creation of notes, even if `allowFreeUrl` is `true` | | `loglevel` | `info` | Defines what kind of logs are provided to stdout. Available options: `debug`, `verbose`, `info`, `warn`, `error` | | `imageUploadType` | `imgur`, `s3`, `minio`, `azure`, `lutim` or `filesystem`(default) | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [MinIO](guides/minio-image-upload.md)| diff --git a/docs/configuration-env-vars.md b/docs/configuration-env-vars.md index bc0eac99..b07547ff 100644 --- a/docs/configuration-env-vars.md +++ b/docs/configuration-env-vars.md @@ -30,7 +30,7 @@ defaultNotePath can't be set from env-vars | -------- | ------------- | ----------- | | `CMD_ALLOW_PDF_EXPORT` | `true` or `false` | Enable or disable PDF exports | | `CMD_CONFIG_FILE` | `/path/to/config.json` | optional override for the path to CodiMD's config file | -| `CMD_DB_URL` | `mysql://localhost:3306/database` | set the database URL | +| `CMD_DB_URL` | `mysql://localhost:3306/database` | Set the db in URL style. If set, then the relevant `db` config entries will be overridden. | | `CMD_LOGLEVEL` | `info`, `debug` ... | Defines what kind of logs are provided to stdout. | | `CMD_FORBIDDEN_NOTE_IDS` | `'robots.txt'` | disallow creation of notes, even if `CMD_ALLOW_FREEURL` is `true` | | `CMD_IMAGE_UPLOAD_TYPE` | `imgur`, `s3`, `minio`, `lutim` or `filesystem` | Where to upload images. For S3, see our Image Upload Guides for [S3](guides/s3-image-upload.md) or [Minio](guides/minio-image-upload.md), also there's a whole section on their respective env vars below. | |