Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion content/collections/how-to/define-metadata.md
Original file line number Diff line number Diff line change
Expand Up @@ -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:
Expand Down
2 changes: 1 addition & 1 deletion content/collections/reference/configuration.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
/>}}

Expand Down
10 changes: 9 additions & 1 deletion content/collections/reference/environment-variables.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand All @@ -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
Expand Down
2 changes: 1 addition & 1 deletion content/deployment/how-to/deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -85,7 +85,7 @@ First, ensure your server provides unsupervised access:
<server_ip>:
ansible_user: <deployment_user>
ed25519_fingerprint: <server_ssh_fingerprint>
ota_source_repository: https://github.com/<organization>/<collection_id>-declarations.git
ota_collection_repository: https://github.com/<organization>/<collection_id>-declarations.git
```

3. Add the server fingerprint to GitHub, to allow the deployment workflow to uniquely identify the server:
Expand Down
12 changes: 6 additions & 6 deletions content/deployment/reference/server-specifications.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

Expand Down
2 changes: 1 addition & 1 deletion content/terms/how-to/manage-custom-terms-type.md
Original file line number Diff line number Diff line change
Expand Up @@ -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": "<your-organization-or-username>/terms-types#main"
}
}
Expand Down
Loading