clarify call-home service and requirements #564
Conversation
fernandinand
requested review from
PeterPetrik,
alex-cit and
mostlyAtNight
and removed request for
PeterPetrik and
alex-cit
src/server/administer/index.md
Outdated
| 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. |
There was a problem hiding this comment.
This should not be part of the warning - warning is about legal bit - port is description how to set it up
There was a problem hiding this comment.
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
src/server/install/index.md
Outdated
| Make sure you follow deployment guidelines, namely enabling [`call-home`](../administer/index.md#opt-out-of-sending-statistics) functionality. | ||
|
|
There was a problem hiding this comment.
This part could be clearer - I don't like the enabling -> opt out - I fear it could be misinterpreted as people being told they should opt-out.
As this part is in the EE install guide, I would instead turn it into an instruction for them to ensure any firewalls in your infrastructure are configured to allow the call-home functionality to send usage data
src/server/administer/index.md
Outdated
| 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. |
There was a problem hiding this comment.
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
src/server/administer/index.md
Outdated
| ::: 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 enabled, <b>it must not be set to `False`</b>. |
There was a problem hiding this comment.
Could you please update to read:
Double check your deployment. Make sure if `COLLECT_STATISTICS` environment variable is present, <b>it is set to `True`</b>.
|
Hey guys. Just wondering about this page https://merginmaps.com/docs/server/administer/environment/ and COLLECT_STATISTICS variable description. Could we add here some link to this Telemetry section or some short explanation of licensing related to 🔝 comments? @mostlyAtNight @fernandinand |
Sounds like a good idea - it would be good if everything reflected our recent discussions |
…thub.com:MerginMaps/docs into 548-adding-callback-network-requirements-to-docs
I added some info and link to the Telemetry section page @MarcelGeo |
| ## 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 />. |
There was a problem hiding this comment.
| <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 />. | |
| The 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 />. |
Unfortunately, there is a thing in vuepress that if the paragraph starts with a component, it won't be formatted properly. So you need to either write "Mergin Maps" instead of using the component or rephrase the sentence.
|
|
||
| <ServerType type="EE" /> | ||
| ::: warning | ||
| It is legally required by <EnterprisePlatformName /> servers to send usage information to monitor the usage of the License. |
There was a problem hiding this comment.
I would consider adding the link to the EE License here (if the license contains this requirement)
PR for #548