Configuration options

This reference documentation details all available configuration options that can be specified in a collection’s configuration file to configure the Open Terms Archive engine.

As an example, see the production configuration file of the Demo collection.

Options

trackingSchedule string

Defines how often the engine should check for changes in terms. Uses standard cron syntax to set the schedule. By default, it runs every 12 hours at minute 30.

Default: 30 */12 * * *

collectionPath string

Path to the collection’s directory containing declarations directory and metadata file, relative to the engine execution location

Default: ./

Example ../collections/demo-declarations

Recorder

The recorder section manages how versions and snapshots of terms are stored, supporting multiple storage backends.

recorder.versions.storage object

Configuration for storing versions. Supports Git and MongoDB. See Storage Repositories for more information.

recorder.snapshots.storage object

Configuration for storing snapshots. Supports Git and MongoDB. See Storage Repositories for more information.

Fetcher

The fetcher section configures how the engine retrieves documents from the web.

fetcher.waitForElementsTimeout number

Maximum wait time for elements to appear in a page (milliseconds).

Default: 10000

fetcher.navigationTimeout number

Maximum wait time for a page to load (milliseconds).

Default: 30000

fetcher.language string

Language code (ISO 639-1) for request headers.

Default: en

Notifier

The notifier section sets up how notifications are sent when new versions of terms are recorded.

notifier.sendInBlue.updatesListId string

SendInBlue contacts list ID of persons to notify on terms updates.

Default: 850

notifier.sendInBlue.updateTemplateId string

SendInBlue email template ID used for updates notifications.

Default: 7

Logger

The logger section configures logging and error notification settings.

logger.smtp.host string

SMTP server hostname.

Default: smtp-relay.sendinblue.com

logger.smtp.username string

Username for SMTP server authentication.

Default: admin@opentermsarchive.org

logger.sendMailOnError.to string

Email address for error notifications.

Example admin@example.com

logger.sendMailOnError.from string

Sender email address for error notifications.

Example noreply@example.com

logger.sendMailOnError.sendWarnings boolean

Set to true to also send email in case of warning.

Default: false

logger.timestampPrefix boolean

Set to false to avoid duplicate timestamps if logs are managed by a process manager.

Default: true

Reporter

The reporter section manages how issues are reported when terms content is inaccessible, supporting GitHub and GitLab.

reporter.type string

Type of reporter

Allowed values github gitlab

Example github

reporter.repositories.declarations string

Repository for creating issues.

Example OpenTermsArchive/demo-declarations

reporter.repositories.versions string

Repository for versions.

Example OpenTermsArchive/demo-versions

reporter.repositories.snapshots string

Repository for snapshots.

Example OpenTermsArchive/demo-snapshots

reporter.baseURL string

Base URL for GitLab (if applicable).

Example https://gitlab.example.com

reporter.apiBaseURL string

API base URL for GitLab (if applicable).

Example https://api.gitlab.example.com

The dataset section configures how datasets are published. Datasets can be published to GitHub releases, GitLab releases, and/or data.gouv.fr. If both GitHub and GitLab tokens are configured, GitHub takes precedence.

dataset.title string

Title of the dataset.

Default: sandbox

dataset.versionsRepositoryURL string

Repository URL for dataset releases.

Default: https://github.com/OpenTermsArchive/sandbox

dataset.publishingSchedule string

Cron expression for dataset publishing. By default, it runs every Monday at 8:30 AM. If publishing to data.gouv.fr, remember to update dataset.datagouv.frequency to match the actual publishing frequency.

Default: 30 8 * * MON

data.gouv.fr publishing

The data.gouv.fr section configures publishing to the French government’s open data platform. Either datasetId or organizationIdOrSlug must be configured.

dataset.datagouv.datasetId string

ID of an existing dataset on data.gouv.fr. Use this to publish to an existing dataset. Either this or organizationIdOrSlug is required.

Example 6914a64b17a0a91bb0a61222

dataset.datagouv.organizationIdOrSlug string

ID or slug of the organization on data.gouv.fr. Use this to automatically create and publish a dataset. The dataset will be created with the title from dataset.title if it doesn’t exist. Either this or datasetId is required.

Example open-terms-archive

dataset.datagouv.frequency string

Update frequency of the dataset. Used when creating or updating a dataset on data.gouv.fr. See data.gouv.fr API for all allowed values.

Example weekly

dataset.datagouv.useDemo boolean

Set to true to use the demo.data.gouv.fr environment for testing.

Default: false