docs: add missing configurations #1000
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -77,6 +77,7 @@ These settings control how `ingest` connects to the RabbitMQ message broker. | |
| - `BROKER_USER`: username to connect to RabbitMQ | ||
| - `BROKER_PASSWORD`: password to connect to RabbitMQ | ||
| - `BROKER_PREFETCHCOUNT`: Number of messages to pull from the message server at the time (default to `2`) | ||
| - `BROKER_EXCHANGE`= the exchange name (i.e., `sda`) | ||
|
|
||
| ### PostgreSQL Database settings: | ||
|
|
||
|
|
@@ -139,3 +140,37 @@ and if `*_TYPE` is `POSIX`: | |
| - `error` | ||
| - `fatal` | ||
| - `panic` | ||
|
|
||
| ### Required settings (Example) | ||
|
|
||
| The following configuration variables are essential for a successful setup. | ||
|
|
||
| - `ARCHIVE_TYPE`= | ||
| - `ARCHIVE_LOCATION`= | ||
| - `BROKER_HOST`= | ||
| - `BROKER_PORT`= | ||
| - `BROKER_USER`= | ||
| - `BROKER_PASSWORD`= | ||
| - `BROKER_VHOST`= | ||
| - `BROKER_QUEUE`= | ||
| - `BROKER_EXCHANGE`= | ||
| - `BROKER_ROUTINGKEY`= | ||
| - `BROKER_ROUTINGERROR`= | ||
| - `BROKER_SSL`= | ||
| - `BROKER_VERIFYPEER`= | ||
| - `BROKER_CACERT`= | ||
| - `BROKER_CLIENTCERT`= | ||
| - `BROKER_CLIENTKEY`= | ||
| - `C4GH_PASSPHRASE`= | ||
| - `C4GH_FILEPATH`= | ||
| - `DB_HOST`= | ||
| - `DB_PORT`= | ||
| - `DB_USER`= | ||
| - `DB_PASSWORD`= | ||
| - `DB_DATABASE`= | ||
| - `DB_SSLMODE`= | ||
| - `DB_CLIENTCERT`= | ||
| - `DB_CLIENTKEY`= | ||
| - `INBOX_TYPE`= | ||
| - `INBOX_LOCATION`= | ||
| - `LOG_LEVEL`= | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change | ||||
|---|---|---|---|---|---|---|
|
|
@@ -49,6 +49,23 @@ These settings control how `intercept` connects to the RabbitMQ message broker. | |||||
| - `BROKER_QUEUE`: message queue to read messages from (commonly: `from_cega`) | ||||||
| - `BROKER_USER`: username to connect to RabbitMQ | ||||||
| - `BROKER_PASSWORD`: password to connect to RabbitMQ | ||||||
| - `BROKER_VHOST`= the virtual host of the exchange (i.e., `test`) | ||||||
|
There was a problem hiding this comment.
Suggested change
|
||||||
| - `BROKER_EXCHANGE`= the exchange name (i.e., `sda`) | ||||||
|
|
||||||
| ### PostgreSQL Database settings: | ||||||
|
|
||||||
| - `DB_HOST`: hostname for the postgresql database | ||||||
| - `DB_PORT`: database port (commonly: `5432`) | ||||||
| - `DB_USER`: username for the database | ||||||
| - `DB_PASSWORD`: password for the database | ||||||
| - `DB_DATABASE`: database name (i.e., `sda`) | ||||||
| - `DB_SSLMODE`: The TLS encryption policy to use for database connections ([See Docs](https://www.postgresql.org/docs/current/libpq-ssl.html#LIBPQ-SSL-PROTECTION)), valid options are: | ||||||
| - `disable` | ||||||
| - `allow` | ||||||
| - `prefer` | ||||||
| - `require` | ||||||
| - `verify-ca` | ||||||
| - `verify-full` | ||||||
|
|
||||||
| ### Logging settings | ||||||
|
|
||||||
|
|
@@ -61,3 +78,23 @@ These settings control how `intercept` connects to the RabbitMQ message broker. | |||||
| - `error` | ||||||
| - `fatal` | ||||||
| - `panic` | ||||||
|
|
||||||
| ### Required settings (Example) | ||||||
|
|
||||||
| The following configuration variables are essential for a successful setup. | ||||||
|
|
||||||
| - `BROKER_HOST`= | ||||||
| - `BROKER_PORT`= | ||||||
| - `BROKER_USER`= | ||||||
| - `BROKER_PASSWORD`= | ||||||
| - `BROKER_QUEUE`= | ||||||
| - `BROKER_VHOST`= | ||||||
| - `BROKER_EXCHANGE`= | ||||||
| - `DB_HOST`= | ||||||
| - `DB_PORT`= | ||||||
| - `DB_USER`= | ||||||
| - `DB_PASSWORD`= | ||||||
| - `DB_DATABASE`= | ||||||
| - `DB_SSLMODE`= | ||||||
| - `LOG_LEVEL`= | ||||||
|
|
||||||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -56,6 +56,7 @@ These settings control how `mapper` connects to the RabbitMQ message broker. | |
| - `BROKER_USER`: username to connect to RabbitMQ | ||
| - `BROKER_PASSWORD`: password to connect to RabbitMQ | ||
| - `BROKER_PREFETCHCOUNT`: Number of messages to pull from the message server at the time (default to `2`) | ||
| - `BROKER_EXCHANGE`= the exchange name (i.e., `sda`) | ||
|
|
||
| ### PostgreSQL Database settings | ||
|
|
||
|
|
@@ -115,4 +116,32 @@ and if `*_TYPE` is `POSIX`: | |
| - `warn` (or `warning`) | ||
| - `error` | ||
| - `fatal` | ||
| - `panic` | ||
|
|
||
| ### Required settings (Example) | ||
|
|
||
| The following configuration variables are essential for a successful setup. | ||
|
|
||
| - `BROKER_HOST`= | ||
| - `BROKER_PORT`= | ||
| - `BROKER_USER`= | ||
| - `BROKER_PASSWORD`= | ||
| - `BROKER_VHOST`= | ||
| - `BROKER_QUEUE`= | ||
| - `BROKER_EXCHANGE`= | ||
| - `BROKER_ROUTINGERROR`= | ||
| - `BROKER_SSL`= | ||
| - `BROKER_VERIFYPEER`= | ||
| - `BROKER_CACERT`= | ||
| - `BROKER_CLIENTCERT`= | ||
| - `BROKER_CLIENTKEY`= | ||
| - `DB_HOST`= | ||
| - `DB_PORT`= | ||
| - `DB_USER`= | ||
| - `DB_PASSWORD`= | ||
| - `DB_DATABASE`= | ||
| - `DB_SSLMODE`= | ||
| - `DB_CLIENTCERT`= | ||
| - `DB_CLIENTKEY`= | ||
| - `LOG_LEVEL`= | ||
| - `INBOX_LOCATION`= | ||
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
| Original file line number | Diff line number | Diff line change |
|---|---|---|
|
|
@@ -79,6 +79,7 @@ These settings control how `verify` connects to the RabbitMQ message broker. | |
| - `BROKER_USER`: username to connect to RabbitMQ | ||
| - `BROKER_PASSWORD`: password to connect to RabbitMQ | ||
| - `BROKER_PREFETCHCOUNT`: Number of messages to pull from the message server at the time (default to `2`) | ||
| - `BROKER_EXCHANGE`= the exchange name (i.e., `sda`) | ||
|
|
||
| ### PostgreSQL Database settings | ||
|
|
||
|
|
@@ -142,3 +143,36 @@ and if `*_TYPE` is `POSIX`: | |
| - `error` | ||
| - `fatal` | ||
| - `panic` | ||
|
|
||
| ### Required settings (Example) | ||
|
|
||
| The following configuration variables are essential for a successful setup. | ||
|
|
||
| - `ARCHIVE_TYPE`= | ||
| - `ARCHIVE_LOCATION`= | ||
| - `BROKER_HOST`= | ||
| - `BROKER_PORT`= | ||
| - `BROKER_USER`= | ||
| - `BROKER_PASSWORD`= | ||
| - `BROKER_VHOST`= | ||
| - `BROKER_QUEUE`= | ||
| - `BROKER_EXCHANGE`= | ||
| - `BROKER_ROUTINGKEY`= | ||
| - `BROKER_ROUTINGERROR`= | ||
| - `BROKER_SSL`= | ||
| - `BROKER_VERIFYPEER`= | ||
| - `BROKER_CACERT`= | ||
| - `BROKER_CLIENTCERT`= | ||
| - `BROKER_CLIENTKEY`= | ||
| - `C4GH_PASSPHRASE`= | ||
| - `C4GH_FILEPATH`= | ||
| - `DB_HOST`= | ||
| - `DB_PORT`= | ||
| - `DB_USER`= | ||
| - `DB_PASSWORD`= | ||
| - `DB_DATABASE`= | ||
| - `DB_SSLMODE`= | ||
| - `DB_CLIENTCERT`= | ||
| - `DB_CLIENTKEY`= | ||
| - `INBOX_LOCATION`= | ||
| - `LOG_LEVEL`= | ||
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
Follow the existing syntax
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The setting BROKER_EXCHANGE is
onlyneeded if the MQ is configured in that way.Do not use the preconfigured MQ and DB as templates since they are not designed to be used in a production setting.