Skip to content

clarify call-home service and requirements #564

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 9 commits into from
Mar 28, 2025
Merged

clarify call-home service and requirements #564

Show file tree
Hide file tree
Changes from 7 commits
Commits
Show all changes
9 commits
Select commit Hold shift + click to select a range
f18e35f
clarify call-home service and requirements
fernandinand Feb 21, 2025
791d881
Further refinement for telemetry service information #548
fernandinand Feb 26, 2025
a26b4bd
fix broken link and aspell
fernandinand Feb 26, 2025
4c180ca
Minor refinment #564
fernandinand Feb 28, 2025
908c3ae
Merge branch 'main' into 548-adding-callback-network-requirements-to-…
fernandinand Feb 28, 2025
29ac04f
Add link to telemetry information
fernandinand Mar 4, 2025
63e4b8f
Merge branch '548-adding-callback-network-requirements-to-docs' of gi…
fernandinand Mar 4, 2025
8fb38bf
address remarks on GH
fernandinand Mar 19, 2025
23030fe
make spellcheck happy
fernandinand Mar 19, 2025
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
View file
Open in desktop
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
View file
Open in desktop
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
23 changes: 19 additions & 4 deletions src/server/administer/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,25 @@ 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

<MainPlatformName /> 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 <MainPlatformName />.
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>.

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" />
::: 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" />

Expand All @@ -20,6 +38,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
View file
Open in desktop
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