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 1 commit
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
5 changes: 4 additions & 1 deletion src/server/administer/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

<ServerType type="EE" />
::: warning
It is legally required by <EnterprisePlatformName /> servers to send usage information to monitor the usage of the License.
It is legally required by <EnterprisePlatformName /> 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 <EnterprisePlatformName /> terms.
Copy link
Contributor

Choose a reason for hiding this comment

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

This should not be part of the warning - warning is about legal bit - port is description how to set it up

Copy link
Contributor

Choose a reason for hiding this comment

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

In terms of the technical requirement, it should say that it requires outgoing https access to https://api.merginmaps.com/monitoring on TCP port 443

I think this page has some wider issues though - it looks like it's written as a call to action to disable monitoring (which we don't want). I would instead recommend:

  • changing the title so it describes monitoring, not how to disable it
  • update the example to show monitoring enabled
  • detail the technical requirements above
  • say what it's for (making mm better and required for monitoring of enterprise edition licence usage)
  • describe how to disable it if desired in the community edition while noting that this is now allowed in EE

:::
2 changes: 2 additions & 0 deletions src/server/install/index.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,8 @@ The <CommunityPlatformName /> images are stored on publicly accessible <DockerHu

Afterwards, you can follow [this guide](./ee/index.md) to retrieve your <EnterprisePlatformName /> 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 <MainPlatformName /> instance.
Expand Down
Loading