From f18e35fab863b8936757d6dd7dbaaa65e0d269a8 Mon Sep 17 00:00:00 2001 From: Fernando Ribeiro Date: Fri, 21 Feb 2025 10:01:04 +0000 Subject: [PATCH 1/7] clarify call-home service and requirements --- src/server/administer/index.md | 5 ++++- src/server/install/index.md | 2 ++ 2 files changed, 6 insertions(+), 1 deletion(-) diff --git a/src/server/administer/index.md b/src/server/administer/index.md index 2777b439..ce2ac928 100644 --- a/src/server/administer/index.md +++ b/src/server/administer/index.md @@ -20,6 +20,9 @@ If you do not want to provide these data, you can opt-out any time by setting th COLLECT_STATISTICS=false ``` + ::: warning -It is legally required by servers to send usage information to monitor the usage of the License. +It is legally required by servers to send usage information (`call-home` service) to monitor the usage of the License. + +This service runs on background via `TCP` port `443`, hence it needs to be enabled on firewall side in order to comply with terms. ::: diff --git a/src/server/install/index.md b/src/server/install/index.md index 258b05d2..de1d8531 100644 --- a/src/server/install/index.md +++ b/src/server/install/index.md @@ -18,6 +18,8 @@ The images are stored on publicly accessible images. +Make sure you follow deployment guidelines, namely enabling [`call-home`](../administer/index.md#opt-out-of-sending-statistics) functionality. + ## Deployment Follow these steps to run a local instance. From 791d881936e7099153b2ae092f9b16b7069ab702 Mon Sep 17 00:00:00 2001 From: Fernando Ribeiro Date: Wed, 26 Feb 2025 16:08:03 +0000 Subject: [PATCH 2/7] Further refinement for telemetry service information #548 --- src/server/administer/index.md | 25 ++++++++++++++++++------- src/server/install/index.md | 5 ++++- 2 files changed, 22 insertions(+), 8 deletions(-) diff --git a/src/server/administer/index.md b/src/server/administer/index.md index ce2ac928..89991150 100644 --- a/src/server/administer/index.md +++ b/src/server/administer/index.md @@ -8,7 +8,24 @@ Administration guide will help you to configure and maintain your telemetry service helps us gather some information about the usage of the platform, namely on-premise deployment. This information is very valuable to us to help us improve . +Please consider enabling this functionality, even if you are using edition. For deployments, as you'll check down below, this is mandatory. + +The telemetry service (`call-home`) requires https access to `https://api.merginmaps.com/monitoring` on `TCP` port `443`. + + +::: warning +It is legally required by servers to send usage information to monitor the usage of the License. + +Double check your deployment. Make sure if `COLLECT_STATISTICS` environment variable is enabled, it must not be set to `False`. +::: + +``` +COLLECT_STATISTICS=true # Or you can ommit, default is True +``` + @@ -20,9 +37,3 @@ If you do not want to provide these data, you can opt-out any time by setting th COLLECT_STATISTICS=false ``` - -::: warning -It is legally required by servers to send usage information (`call-home` service) to monitor the usage of the License. - -This service runs on background via `TCP` port `443`, hence it needs to be enabled on firewall side in order to comply with terms. -::: diff --git a/src/server/install/index.md b/src/server/install/index.md index de1d8531..3b8ded33 100644 --- a/src/server/install/index.md +++ b/src/server/install/index.md @@ -18,7 +18,10 @@ The images are stored on publicly accessible images. -Make sure you follow deployment guidelines, namely enabling [`call-home`](../administer/index.md#opt-out-of-sending-statistics) functionality. +::: warning Enable Telemetry +Make sure you follow deployment guidelines to ensure any firewalls in your infrastructure are configured to allow the [`call-home`](../administer/index.md#opt-out-of-sending-statistics) functionality to send usage data. + +::: ## Deployment From a26b4bd7a3ac66d5e23cdd217a89197509615ca7 Mon Sep 17 00:00:00 2001 From: Fernando Ribeiro Date: Wed, 26 Feb 2025 16:16:20 +0000 Subject: [PATCH 3/7] fix broken link and aspell --- scripts/wordlist.txt | 1 + src/server/install/index.md | 2 +- 2 files changed, 2 insertions(+), 1 deletion(-) diff --git a/scripts/wordlist.txt b/scripts/wordlist.txt index d4719a4c..62a5135d 100644 --- a/scripts/wordlist.txt +++ b/scripts/wordlist.txt @@ -197,6 +197,7 @@ geoid gpkg hotline http +https iOS iPhone iconv diff --git a/src/server/install/index.md b/src/server/install/index.md index 3b8ded33..a405fa1b 100644 --- a/src/server/install/index.md +++ b/src/server/install/index.md @@ -19,7 +19,7 @@ The images are stored on publicly accessible images. ::: warning Enable Telemetry -Make sure you follow deployment guidelines to ensure any firewalls in your infrastructure are configured to allow the [`call-home`](../administer/index.md#opt-out-of-sending-statistics) functionality to send usage data. +Make sure you follow deployment guidelines to ensure any firewalls in your infrastructure are configured to allow the [`call-home`](../administer/index.md#telemetry-service) functionality to send usage data. ::: From 4c180ca2457381b3cd4d3491e827fc8b31c92861 Mon Sep 17 00:00:00 2001 From: Fernando Ribeiro Date: Fri, 28 Feb 2025 10:12:34 +0000 Subject: [PATCH 4/7] Minor refinment #564 --- src/server/administer/index.md | 3 ++- 1 file changed, 2 insertions(+), 1 deletion(-) diff --git a/src/server/administer/index.md b/src/server/administer/index.md index 89991150..0f2798c7 100644 --- a/src/server/administer/index.md +++ b/src/server/administer/index.md @@ -19,7 +19,8 @@ The telemetry service (`call-home`) requires https access t ::: warning It is legally required by servers to send usage information to monitor the usage of the License. -Double check your deployment. Make sure if `COLLECT_STATISTICS` environment variable is enabled, it must not be set to `False`. +Double check your deployment. Make sure if `COLLECT_STATISTICS` environment variable is present, it is set to `True`. + ::: ``` From 29ac04f17c2e45af85b9cacda431af72e3c290cd Mon Sep 17 00:00:00 2001 From: Fernando Ribeiro Date: Tue, 4 Mar 2025 10:10:55 +0000 Subject: [PATCH 5/7] Add link to telemetry information --- src/server/administer/environment.md | 12 ++++++------ 1 file changed, 6 insertions(+), 6 deletions(-) diff --git a/src/server/administer/environment.md b/src/server/administer/environment.md index 3bd3d86f..ab2f23b9 100644 --- a/src/server/administer/environment.md +++ b/src/server/administer/environment.md @@ -5,12 +5,12 @@ There are several application settings which can be changed via is hosted. | -| `COLLECT_STATISTICS` | Boolean | `true` | Whether to send usage statistics for application improvements. | -| `CONTACT_EMAIL` | string | `` | Email contact for application administrator. | -| `SERVICE_ID` | string | | Deployment UUID. Auto-generated on the first run. | +| Variable name | Type | Default | Description | +|--------------------------|-----------|-----------|---------------------------------------------------------------------------------------------------------------------------------------------| +| `MERGIN_BASE_URL`⭐️ | string | | Deployment URL where is hosted. | +| `COLLECT_STATISTICS` | Boolean | `true` | Whether to send usage statistics for application improvements. For more information check this [page section](./index.md#telemetry-service) | +| `CONTACT_EMAIL` | string | `` | Email contact for application administrator. | +| `SERVICE_ID` | string | | Deployment UUID. Auto-generated on the first run. | ​ #### Security settings (important for production use)🛡️ Security settings are important for production use. From 8fb38bf77d7071896f4afcddaddbf69af75394a4 Mon Sep 17 00:00:00 2001 From: Fernando Ribeiro Date: Wed, 19 Mar 2025 09:57:41 +0000 Subject: [PATCH 6/7] address remarks on GH --- src/server/administer/index.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/src/server/administer/index.md b/src/server/administer/index.md index 0f2798c7..e42a868c 100644 --- a/src/server/administer/index.md +++ b/src/server/administer/index.md @@ -10,12 +10,15 @@ See the list of all [environment variables](./environment.md) that you can confi ## Telemetry Service - telemetry service helps us gather some information about the usage of the platform, namely on-premise deployment. This information is very valuable to us to help us improve . -Please consider enabling this functionality, even if you are using edition. For deployments, as you'll check down below, this is mandatory. +The telemetry service helps us gather some information about the usage of the platform, namely on-premise deployment. + +This information is very valuable and help us improve . The collected information is related with users seats, URL of installation and autogenerated `uuid` of the installation. We keep this information for unlimited time for the purposes we previously provided. + +Please consider enabling this functionality, even if you are using edition. For deployments, as you'll check down below, this is [mandatory (section 4.5)](https://merginmaps.com/licenses/license-ee). The telemetry service (`call-home`) requires https access to `https://api.merginmaps.com/monitoring` on `TCP` port `443`. - + ::: warning It is legally required by servers to send usage information to monitor the usage of the License. @@ -28,7 +31,6 @@ COLLECT_STATISTICS=true # Or you can ommit, default is True ``` - By default, collects anonymous usage information to make the service better. There is a variable named `COLLECT_STATISTICS` that controls if statistics are collected and sent. From 23030fe8f13360c923e914dad12545e78cb9c1ed Mon Sep 17 00:00:00 2001 From: Fernando Ribeiro Date: Wed, 19 Mar 2025 10:39:05 +0000 Subject: [PATCH 7/7] make spellcheck happy --- src/server/administer/index.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/src/server/administer/index.md b/src/server/administer/index.md index e42a868c..25089e18 100644 --- a/src/server/administer/index.md +++ b/src/server/administer/index.md @@ -12,7 +12,7 @@ See the list of all [environment variables](./environment.md) that you can confi The telemetry service helps us gather some information about the usage of the platform, namely on-premise deployment. -This information is very valuable and help us improve . The collected information is related with users seats, URL of installation and autogenerated `uuid` of the installation. We keep this information for unlimited time for the purposes we previously provided. +This information is very valuable and help us improve . The collected information is related with users seats, URL of installation and auto generated `uuid` of the installation. We keep this information for unlimited time for the purposes we previously provided. Please consider enabling this functionality, even if you are using edition. For deployments, as you'll check down below, this is [mandatory (section 4.5)](https://merginmaps.com/licenses/license-ee).