diff options
| author | Nuno Silva <nuno-silva@users.noreply.github.com> | 2021-01-13 00:49:52 +0000 |
|---|---|---|
| committer | GitHub <noreply@github.com> | 2021-01-13 08:49:52 +0800 |
| commit | db9bb1ff69d011af4a010da6fec720379f4cd6b8 (patch) | |
| tree | 83bdf7f51b2a59f0d0e9e1acf0e1d522a00bade7 /custom/conf/app.example.ini | |
| parent | 9659808172b0d33a79eca44e37cabaf33fbf1b8b (diff) | |
| download | gitea-db9bb1ff69d011af4a010da6fec720379f4cd6b8.tar.gz gitea-db9bb1ff69d011af4a010da6fec720379f4cd6b8.zip | |
Update docs to clarify issues raised in #14272 (#14318)
- example config is not supposed to be copied
- 'persistable-channel' uses a leveldb internally
- '*CONN_STR' overrides queue DIR
Diffstat (limited to 'custom/conf/app.example.ini')
| -rw-r--r-- | custom/conf/app.example.ini | 9 |
1 files changed, 8 insertions, 1 deletions
diff --git a/custom/conf/app.example.ini b/custom/conf/app.example.ini index e26e9e4d56..277df08399 100644 --- a/custom/conf/app.example.ini +++ b/custom/conf/app.example.ini @@ -1,6 +1,8 @@ ; This file lists the default values used by Gitea ; Copy required sections to your own app.ini (default is custom/conf/app.ini) ; and modify as needed. +; Do not copy the whole file as-is, as it contains some invalid sections for illustrative purposes. +; If you don't know what a setting is you should not set it. ; see https://docs.gitea.io/en-us/config-cheat-sheet/ for additional documentation. @@ -451,10 +453,13 @@ ISSUE_INDEXER_NAME = gitea_issues ISSUE_INDEXER_PATH = indexers/issues.bleve ; Issue indexer queue, currently support: channel, levelqueue or redis, default is levelqueue ISSUE_INDEXER_QUEUE_TYPE = levelqueue -; When ISSUE_INDEXER_QUEUE_TYPE is levelqueue, this will be the queue will be saved path, +; When ISSUE_INDEXER_QUEUE_TYPE is levelqueue, this will be the path where the queue will be saved. +; This can be overriden by `ISSUE_INDEXER_QUEUE_CONN_STR`. ; default is indexers/issues.queue ISSUE_INDEXER_QUEUE_DIR = indexers/issues.queue ; When `ISSUE_INDEXER_QUEUE_TYPE` is `redis`, this will store the redis connection string. +; When `ISSUE_INDEXER_QUEUE_TYPE` is `levelqueue`, this is a directory or additional options of +; the form `leveldb://path/to/db?option=value&....`, and overrides `ISSUE_INDEXER_QUEUE_DIR`. ISSUE_INDEXER_QUEUE_CONN_STR = "addrs=127.0.0.1:6379 db=0" ; Batch queue number, default is 20 ISSUE_INDEXER_QUEUE_BATCH_NUMBER = 20 @@ -494,6 +499,8 @@ LENGTH = 20 ; Batch size to send for batched queues BATCH_LENGTH = 20 ; Connection string for redis queues this will store the redis connection string. +; When `TYPE` is `persistable-channel`, this provides a directory for the underlying leveldb +; or additional options of the form `leveldb://path/to/db?option=value&....`, and will override `DATADIR`. CONN_STR = "addrs=127.0.0.1:6379 db=0" ; Provides the suffix of the default redis/disk queue name - specific queues can be overriden within in their [queue.name] sections. QUEUE_NAME = "_queue" |