From 6037eb7563ace24a01df1a91d20821642a9f8c5b Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Mon, 31 Mar 2025 16:46:09 +0200 Subject: [PATCH 1/5] Add server specifications --- content/deployment/reference/_index.md | 4 +++ .../reference/server-specifications.md | 33 +++++++++++++++++++ 2 files changed, 37 insertions(+) create mode 100644 content/deployment/reference/_index.md create mode 100644 content/deployment/reference/server-specifications.md diff --git a/content/deployment/reference/_index.md b/content/deployment/reference/_index.md new file mode 100644 index 00000000..d86ccf79 --- /dev/null +++ b/content/deployment/reference/_index.md @@ -0,0 +1,4 @@ +--- +title: Reference +weight: 1 +--- diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md new file mode 100644 index 00000000..e206d457 --- /dev/null +++ b/content/deployment/reference/server-specifications.md @@ -0,0 +1,33 @@ +--- +title: Server specifications +weight: 1 +--- + +# Server specifications + +## Minimum Requirements + +The minimum recommended server specifications are: + +- 2GB RAM +- 1CPU @ 2GHz +- 10GB storage + +Approximately 750MB of storage is required for the engine itself, with the remaining space allocated for data generated by the engine. + +## Storage Growth + +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: + +- Large digital services, like those in the [PGA collection](https://github.com/OpenTermsArchive/pga-declarations): ~1MB per terms per month +- Standard collections: ~0.1-0.3MB per terms per month + +## Operating System Requirements + +Supported operating systems: +- Ubuntu 20.04 or higher +- Debian 11 or higher + +## Geographic Requirements + +Servers must be deployed in geographic regions that align with the jurisdiction the collection targets. This is crucial because some services deliver different versions of documents based on the server's location, even when the documents are supposed to be identical. Therefore, ensure your server is physically located in a country within the jurisdiction that the collection targets. From d9e5389c4713936205023df47fd6f425faf34702 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Tue, 1 Apr 2025 11:49:00 +0200 Subject: [PATCH 2/5] Improve server specifications --- content/deployment/reference/server-specifications.md | 10 ++++------ 1 file changed, 4 insertions(+), 6 deletions(-) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index e206d457..e59f9e6d 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -5,8 +5,6 @@ weight: 1 # Server specifications -## Minimum Requirements - The minimum recommended server specifications are: - 2GB RAM @@ -15,19 +13,19 @@ The minimum recommended server specifications are: Approximately 750MB of storage is required for the engine itself, with the remaining space allocated for data generated by the engine. -## Storage Growth +## Storage growth 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: - Large digital services, like those in the [PGA collection](https://github.com/OpenTermsArchive/pga-declarations): ~1MB per terms per month - Standard collections: ~0.1-0.3MB per terms per month -## Operating System Requirements +## Operating system Supported operating systems: - Ubuntu 20.04 or higher - Debian 11 or higher -## Geographic Requirements +## Location -Servers must be deployed in geographic regions that align with the jurisdiction the collection targets. This is crucial because some services deliver different versions of documents based on the server's location, even when the documents are supposed to be identical. Therefore, ensure your server is physically located in a country within the jurisdiction that the collection targets. +To align with our [third design principle]({{< relref "/concepts/design-principles/#3-obtain-documents-like-a-user-would" >}}), servers should be deployed in geographic regions that align with the jurisdiction the collection targets. This is crucial because some services deliver different versions of documents based on the server's location, even when the documents are supposed to be identical. Therefore, ensure your server is physically located in a country within the jurisdiction that the collection targets. From 975accb2f5c5016b7815da97e8484381ef61beb1 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Tue, 1 Apr 2025 11:51:24 +0200 Subject: [PATCH 3/5] Fix link --- 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 e59f9e6d..5e8a0cfd 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -28,4 +28,4 @@ Supported operating systems: ## Location -To align with our [third design principle]({{< relref "/concepts/design-principles/#3-obtain-documents-like-a-user-would" >}}), servers should be deployed in geographic regions that align with the jurisdiction the collection targets. This is crucial because some services deliver different versions of documents based on the server's location, even when the documents are supposed to be identical. Therefore, ensure your server is physically located in a country within the jurisdiction that the collection targets. +To align with our [third design principle]({{< relref "concepts/design-principles#3-obtain-documents-like-a-user-would" >}}), servers should be deployed in geographic regions that align with the jurisdiction the collection targets. This is crucial because some services deliver different versions of documents based on the server's location, even when the documents are supposed to be identical. Therefore, ensure your server is physically located in a country within the jurisdiction that the collection targets. From e25a69ef32cf728ad68f993cda119719366fecc5 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Tue, 1 Apr 2025 11:52:35 +0200 Subject: [PATCH 4/5] Fix weight --- content/deployment/reference/_index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/deployment/reference/_index.md b/content/deployment/reference/_index.md index d86ccf79..6f4fd0f8 100644 --- a/content/deployment/reference/_index.md +++ b/content/deployment/reference/_index.md @@ -1,4 +1,4 @@ --- title: Reference -weight: 1 +weight: 2 --- From e8025ff66218c5081e9ce93d2e00a82f8bfa5d95 Mon Sep 17 00:00:00 2001 From: Nicolas Dupont Date: Tue, 1 Apr 2025 17:47:30 +0200 Subject: [PATCH 5/5] Improve phrasing Co-authored-by: Matti Schneider --- content/deployment/reference/server-specifications.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/content/deployment/reference/server-specifications.md b/content/deployment/reference/server-specifications.md index 5e8a0cfd..1e389a99 100644 --- a/content/deployment/reference/server-specifications.md +++ b/content/deployment/reference/server-specifications.md @@ -17,7 +17,7 @@ Approximately 750MB of storage is required for the engine itself, with the remai 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: -- Large digital services, like those in the [PGA collection](https://github.com/OpenTermsArchive/pga-declarations): ~1MB per terms per month +- 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 ## Operating system @@ -28,4 +28,4 @@ Supported operating systems: ## Location -To align with our [third design principle]({{< relref "concepts/design-principles#3-obtain-documents-like-a-user-would" >}}), servers should be deployed in geographic regions that align with the jurisdiction the collection targets. This is crucial because some services deliver different versions of documents based on the server's location, even when the documents are supposed to be identical. Therefore, ensure your server is physically located in a country within the jurisdiction that the collection targets. +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.