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
1 change: 1 addition & 0 deletions scripts/wordlist.txt
Original file line number Diff line number Diff line change
Expand Up @@ -198,6 +198,7 @@ geoid
gpkg
hotline
http
https
iOS
iPhone
iconv
Expand Down
12 changes: 6 additions & 6 deletions src/server/administer/environment.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,12 +5,12 @@ There are several application settings which can be changed via <GitHubRepo desc
#### Server basics
Variables marked with star ⭐️ need to be modified for production use.

| Variable name | Type | Default | Description |
|--------------------------|-----------|-----------|-------------|
| `MERGIN_BASE_URL`⭐️ | string | | Deployment URL where <MainPlatformName /> 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 <MainPlatformName /> 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.
Expand Down
27 changes: 22 additions & 5 deletions src/server/administer/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,9 +8,29 @@ Administration guide will help you to configure and maintain your <CommunityPlat

See the list of all [environment variables](./environment.md) that you can configure.

## Opt out of sending statistics
## Telemetry Service

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 <MainPlatformName />. 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 <CommunityPlatformName /> edition. For <EnterprisePlatformName /> deployments, as you'll check down below, this is [<b>mandatory</b> (section 4.5)](https://merginmaps.com/licenses/license-ee).

The <MainPlatformName /> telemetry service (`call-home`) requires https access to `https://api.merginmaps.com/monitoring` on `TCP` port `443`.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Does this service has stable IP address so when client want's to whitelists the api?

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Let's finish the discussion on Slack and create a new PR if needed


<ServerType type="EE" /> <SinceBadge type="Server" version="2023.2" />
::: warning
It is legally required by <EnterprisePlatformName /> servers to send usage information to monitor the usage of the License.

Double check your deployment. Make sure if `COLLECT_STATISTICS` environment variable is present, <b>it is set to `True`</b>.

:::

```
COLLECT_STATISTICS=true # Or you can ommit, default is True
```

<ServerType type="CE" />
<SinceBadge type="Server" version="2023.2" />


By default, <CommunityPlatformName /> collects anonymous usage information to make the service better. There is a variable named `COLLECT_STATISTICS` that controls if statistics are collected and sent.
Expand All @@ -20,6 +40,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 <EnterprisePlatformName /> servers to send usage information to monitor the usage of the License.
:::
3 changes: 2 additions & 1 deletion src/server/install/index.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,8 @@ The <EnterprisePlatformName /> enhanced features are only available on specific

Afterwards, you can follow [this guide](./ee/index.md) to retrieve your <EnterprisePlatformName /> images.

Once you have the images on your side, follow the deployment guidelines and have <EnterprisePlatformName /> running on a target instance in your infrastructure.
::: warning Enable <MainPlatformName /> Telemetry
Make sure you follow deployment guidelines to <b>ensure any firewalls in your infrastructure are configured to allow the [`call-home`](../administer/index.md#telemetry-service) functionality to send usage data</b>.

## Deployment

Expand Down
Loading