diff --git a/content/deployment/configuration.md b/content/deployment/configuration.md index 1abb6a665e255fbeadd93d8fee697fdc5152d468..d45116160b49946395784258b79f749ca189b2d4 100644 --- a/content/deployment/configuration.md +++ b/content/deployment/configuration.md @@ -257,7 +257,20 @@ Port of the PostgreSQL database. Defaults to `9100`. ### `database.replica` -TODO +Optional information for a read-only Postgresql replica, allowing to scale the database across multiple servers. This is needed to setup [Patroni](https://patroni.readthedocs.io/en/latest/). + +If you specify these information, all write operations will happen on the main database, and all read operations will happen on the replica. + +Settings are the same as for the main database described above this section, but under a `replica` header: + +``` +database: + replica: + host: ... + port: ... + user: ... + password: ... +``` ### `database.user` @@ -305,7 +318,9 @@ Email address to use both as the SMTP username and as the sender address. ### `export.ttl` -TODO +This integer value configures the Time To Live of an Sqlite export on a corpus in seconds. This prevents creating exports too frequently through the API and overloading the system. When an export has been successfully created, another export on the same corpus cannot be created within this specified time. + +Default to 21600 seconds (or 6 hours). ## `features` @@ -339,7 +354,7 @@ Defines whether or not the worker system is available. Boolean, defaults to `fal ## `imports_worker_version` -TODO +Worker version UUID that will be used for all file imports operation (when importing PDF, images, or files from an S3-compatible bucket). ## `influxdb` @@ -401,7 +416,7 @@ ID of the user group that will designate "internal" users. Internal users will n ### `job_timeouts.notify_process_completion` -TODO +Timeout for the email notification task upon finished process, in seconds. Defaults to `120`. ### `job_timeouts.process_delete` @@ -409,11 +424,11 @@ TODO ### `job_timeouts.reindex_corpus` -TODO +Timeout for the corpus search engine re-indexation task, in seconds. Defaults to `7200`. ### `job_timeouts.task` -TODO +Timeout for locally executed ponos tasks (only for Community Edition). Defaults to `36000`. ### `job_timeouts.worker_results_delete` @@ -433,7 +448,9 @@ The ImageServer may be created from the admin panel or a shell instance. ## `metrics_port` -TODO +Network port where a Prometheus `/metrics` endpoint will be exposed. This allows system administrator to integrate Arkindex in their monitoring stack. + +Default to `3000` ## `ponos`