From 782e52eee57dfc5ad6460e29bdb8de5c66b66060 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Biron?= Date: Mon, 29 Jun 2026 11:06:34 +0200 Subject: [PATCH 1/6] Fix deployment inventory variable name --- content/deployment/how-to/deploy.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/deployment/how-to/deploy.md b/content/deployment/how-to/deploy.md index aa131067..eb73a006 100644 --- a/content/deployment/how-to/deploy.md +++ b/content/deployment/how-to/deploy.md @@ -85,7 +85,7 @@ First, ensure your server provides unsupervised access: : ansible_user: ed25519_fingerprint: - ota_source_repository: https://github.com//-declarations.git + ota_collection_repository: https://github.com//-declarations.git ``` 3. Add the server fingerprint to GitHub, to allow the deployment workflow to uniquely identify the server: From 98af57482596a56d39b71bc695e1152ba25c8185 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Biron?= Date: Mon, 29 Jun 2026 11:06:34 +0200 Subject: [PATCH 2/6] Align server specifications with engine CI --- .../deployment/reference/server-specifications.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index 53b90b92..4c2ed1e7 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -29,15 +29,15 @@ Storage usage typically grows at a rate of 0.5 MB per tracked terms per month o ## Operating system -The Open Terms Archive engine is [continuously tested](https://github.com/OpenTermsArchive/engine/blob/main/.github/workflows/test.yml#L12-L15) and guaranteed to work on the following operating systems: +The Open Terms Archive engine is [continuously tested](https://github.com/OpenTermsArchive/engine/blob/main/.github/workflows/test.yml) and guaranteed to work on the following operating systems: - Ubuntu 22.04 -- Debian 11 -- macOS 14 -- macOS 15 -- Windows Server 2022 +- the latest macOS +- the latest Windows Server -Please [report](https://github.com/OpenTermsArchive/engine/issues/new) any incompatibility with more recent versions of these operating systems. +It is tested on Node.js 22 and 26. + +Please [report](https://github.com/OpenTermsArchive/engine/issues/new) any incompatibility with other operating systems or versions. ## Location From f4be58b753d448c005df40e487a8a25789082635 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Biron?= Date: Mon, 29 Jun 2026 11:06:34 +0200 Subject: [PATCH 3/6] Document proxy and fetcher environment variables --- content/collections/reference/environment-variables.md | 10 +++++++++- 1 file changed, 9 insertions(+), 1 deletion(-) diff --git a/content/collections/reference/environment-variables.md b/content/collections/reference/environment-variables.md index 30fec768..ff2b2c22 100644 --- a/content/collections/reference/environment-variables.md +++ b/content/collections/reference/environment-variables.md @@ -5,7 +5,7 @@ weight: 4 ## Environment variables -This reference documentation details all available environment variables that can be used to configure sensitive information. These variables can be defined in a `.env` file at the root of the collection repository. +This reference documentation details the environment variables used to configure sensitive credentials and the runtime behaviour of the engine. These variables can be defined in a `.env` file at the root of the collection repository. ### Engine @@ -19,6 +19,14 @@ This reference documentation details all available environment variables that ca {{< refItem name="OTA_ENGINE_DATAGOUV_API_KEY" type="string" description="API key for data.gouv.fr dataset publishing." />}} +{{< refItem name="OTA_ENGINE_FETCHER_NO_SANDBOX" type="string" description="Set to any value to launch the headless browser without its sandbox, for containerised environments such as Docker where the sandbox cannot run." />}} + +{{< refItem name="OTA_ENGINE_FETCHER_NO_HEADLESS" type="string" description="Set to any value to run the browser with a visible window instead of headless, which is useful for debugging fetching issues." />}} + +{{< refItem name="HTTPS_PROXY" type="string" description="Proxy URL for the engine's outgoing HTTPS traffic, such as document fetching and GitLab issue reporting." />}} + +{{< refItem name="HTTP_PROXY" type="string" description="Proxy URL for the engine's outgoing HTTP traffic. Also used as a fallback when `HTTPS_PROXY` is not set." />}} + --- ### Federation API From 8fa7dbb60e224c32ae8ced7091f86c7794a72960 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Biron?= Date: Mon, 29 Jun 2026 11:06:34 +0200 Subject: [PATCH 4/6] Update engine version in custom terms type guide --- content/terms/how-to/manage-custom-terms-type.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/terms/how-to/manage-custom-terms-type.md b/content/terms/how-to/manage-custom-terms-type.md index 871f1d30..ff80b0f7 100644 --- a/content/terms/how-to/manage-custom-terms-type.md +++ b/content/terms/how-to/manage-custom-terms-type.md @@ -46,7 +46,7 @@ If you need a faster solution for production use, you can fork the terms-types r ```json { "dependencies": { - "@opentermsarchive/engine": "5.0.3", + "@opentermsarchive/engine": "^14.0.0", "@opentermsarchive/terms-types": "/terms-types#main" } } From 007e29d9f9f4f6043dfc8fb35fe23714bf7c05b8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Biron?= Date: Mon, 29 Jun 2026 11:14:27 +0200 Subject: [PATCH 5/6] Fix invalid role in metadata example --- content/collections/how-to/define-metadata.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/collections/how-to/define-metadata.md b/content/collections/how-to/define-metadata.md index d4d8817b..84a42618 100644 --- a/content/collections/how-to/define-metadata.md +++ b/content/collections/how-to/define-metadata.md @@ -57,7 +57,7 @@ This guide will help you define the metadata for your Open Terms Archive collect - name: "Admin entity" url: "https://admin-website.com" logo: "https://path-to-logo.png" - roles: ["administrator"] + roles: ["sysadmin"] ``` 6. Add optional fields as needed: From 59ec7d6aa25fe2d8012a910d33ce1d0f0e6cc4d8 Mon Sep 17 00:00:00 2001 From: =?UTF-8?q?Cl=C3=A9ment=20Biron?= Date: Mon, 29 Jun 2026 11:14:27 +0200 Subject: [PATCH 6/6] Clarify fetcher language configuration --- content/collections/reference/configuration.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/collections/reference/configuration.md b/content/collections/reference/configuration.md index b4b01f44..9f7a6e21 100644 --- a/content/collections/reference/configuration.md +++ b/content/collections/reference/configuration.md @@ -63,7 +63,7 @@ The fetcher section configures how the engine retrieves documents from the web. {{< refItem name="fetcher.language" type="string" - description="Language code (ISO 639-1) for request headers." + description="Comma-separated priority list of language tags used for the `Accept-Language` request header and the browser language, e.g. `en` or `en-IE,en-GB,en`. Quality factors (`;q=…`) are not supported." default="en" />}}