From b051b7908aa793da79897e8d9e708821367dc4fe Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Fri, 9 May 2025 12:01:52 +0200 Subject: [PATCH 1/7] Unify whitespace --- content/deployment/reference/server-specifications.md | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index 29e5a0e5..cd32301f 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -7,11 +7,11 @@ weight: 2 The minimum recommended server specifications are: -- 2GB RAM -- 1CPU @ 2GHz -- 10GB storage +- 2 GB RAM +- 1 CPU @ 2GHz +- 10 GB storage -Approximately 750MB of storage is required for the engine itself, with the remaining space allocated for data generated by the engine. +Approximately 750 MB of storage is required for the engine itself, with the remaining space allocated for data generated by the engine. ## Storage growth From d2c834280316b4e38a4db7feda215dae963f9ab5 Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Fri, 9 May 2025 12:02:53 +0200 Subject: [PATCH 2/7] Define minimum specifications are strictly minimal --- content/deployment/reference/server-specifications.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index cd32301f..0ebb1ea0 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -5,13 +5,13 @@ weight: 2 # Server specifications -The minimum recommended server specifications are: +The minimum server specifications are: - 2 GB RAM - 1 CPU @ 2GHz -- 10 GB storage +- 2 GB storage -Approximately 750 MB of storage is required for the engine itself, with the remaining space allocated for data generated by the engine. +Approximately 750 MB of storage is required for the engine itself, with the remaining space allocated for data generated by the engine. Storage capacity should be calculated based on the scope and expected lifetime of the collection. ## Storage growth From d76782d4b1a3ad4d2030794e0d33007102aa6bcd Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Fri, 9 May 2025 12:03:10 +0200 Subject: [PATCH 3/7] Improve storage growth definition --- .../deployment/reference/server-specifications.md | 15 +++++++++++---- 1 file changed, 11 insertions(+), 4 deletions(-) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index 0ebb1ea0..94b6c7e9 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -13,12 +13,19 @@ The minimum server specifications are: Approximately 750 MB of storage is required for the engine itself, with the remaining space allocated for data generated by the engine. Storage capacity should be calculated based on the scope and expected lifetime of the collection. -## Storage growth +## Storage -Storage requirements typically grow at a rate of less than 0.5MB per tracked terms per month on average. This growth rate varies depending on the type of service being tracked: +Recommended storage: 10 GB, with resizable partitioning to enable growth over time. -- Very large online platforms with large legal teams and heavy layouts: ~1MB per terms per month -- Standard collections: ~0.1-0.3MB per terms per month +Storage usage typically grows at a rate of 0.5 MB per tracked terms per month on average for latin scripts. This growth rate varies depending on the type of service being tracked: + +- Services with large legal teams and heavy website layouts: ~1 MB per terms per month +- Smaller services: ~0.1-0.3 MB per terms per month + +### Examples + +- Tracking 5 very large social media platforms on their 5 most common terms types (such as Terms of Service, Privacy Policy, Trackers Policy, Developer Agreement, Community Guidelines) would require approximately 300 MB of additional storage per year. +- Tracking a sample of 200 platforms on an average of 4 common terms types would require approximately 5 GB of additional storage per year. ## Operating system From 2eae4863e9b8e734085644e8bd8fb146ecb70aae Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Fri, 9 May 2025 12:03:35 +0200 Subject: [PATCH 4/7] Correct supported operating systems based on CI --- content/deployment/reference/server-specifications.md | 8 +++++--- 1 file changed, 5 insertions(+), 3 deletions(-) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index 94b6c7e9..a8c08c81 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -29,9 +29,11 @@ Storage usage typically grows at a rate of 0.5 MB per tracked terms per month o ## Operating system -Supported operating systems: -- Ubuntu 20.04 or higher -- Debian 11 or higher +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: + +- Ubuntu 22.04 +- macOS 14 +- Windows Server 2022 ## Location From 3ac611fabf7068196c97d13b21e1e95f37ab0e7d Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Fri, 9 May 2025 12:03:53 +0200 Subject: [PATCH 5/7] Add expected OS compatibility --- content/deployment/reference/server-specifications.md | 9 +++++++++ 1 file changed, 9 insertions(+) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index a8c08c81..05ac4806 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -35,6 +35,15 @@ The Open Terms Archive engine is [continuously tested](https://github.com/Open - macOS 14 - Windows Server 2022 +The following operating systems should be compatible, but are not guaranteed: + +- Debian 11 or higher +- Ubuntu 24.04 or higher +- macOS 15 or higher +- Windows Server 2025 + +Please [report](https://github.com/OpenTermsArchive/engine/issues/new) any incompatibility with more recent versions of Ubuntu, macOS or Windows. + ## Location Servers should be physically located in geographic regions that align with the jurisdiction the collection targets to ensure to [obtain documents like a user would]({{< relref "concepts/design-principles#3-obtain-documents-like-a-user-would" >}}). This is crucial because some services deliver different versions of documents based on the location of the request, even when the documents are supposed to be identical. From 47fa725cc83eac3c1ee51291d0087927851cfbef Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Fri, 9 May 2025 12:04:04 +0200 Subject: [PATCH 6/7] Clarify geolocation requirements --- content/deployment/reference/server-specifications.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index 05ac4806..008d6880 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -46,4 +46,4 @@ Please [report](https://github.com/OpenTermsArchive/engine/issues/new) any incom ## Location -Servers should be physically located in geographic regions that align with the jurisdiction the collection targets to ensure to [obtain documents like a user would]({{< relref "concepts/design-principles#3-obtain-documents-like-a-user-would" >}}). This is crucial because some services deliver different versions of documents based on the location of the request, even when the documents are supposed to be identical. +Servers must be physically located in geographic regions that belong to the jurisdiction the collection targets to ensure to [obtain documents like a user would]({{< relref "concepts/design-principles#3-obtain-documents-like-a-user-would" >}}). This is crucial because some services deliver different versions of documents based on the inferred location of the request, even when the documents are supposed to be identical and located at the same URL. From e23e2f859abb4f782fd0d515aa2fec508d5795fa Mon Sep 17 00:00:00 2001 From: Matti Schneider Date: Fri, 9 May 2025 15:24:27 +0200 Subject: [PATCH 7/7] Update list of supported operating systems The core team develops with macOS 15 and deploys on Debian --- content/deployment/reference/server-specifications.md | 11 +++-------- 1 file changed, 3 insertions(+), 8 deletions(-) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index 008d6880..ace8b936 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -32,17 +32,12 @@ Storage usage typically grows at a rate of 0.5 MB per tracked terms per month o 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: - Ubuntu 22.04 +- Debian 11 - macOS 14 +- macOS 15 - Windows Server 2022 -The following operating systems should be compatible, but are not guaranteed: - -- Debian 11 or higher -- Ubuntu 24.04 or higher -- macOS 15 or higher -- Windows Server 2025 - -Please [report](https://github.com/OpenTermsArchive/engine/issues/new) any incompatibility with more recent versions of Ubuntu, macOS or Windows. +Please [report](https://github.com/OpenTermsArchive/engine/issues/new) any incompatibility with more recent versions of these operating systems. ## Location