From 6def37abe874b2c7ea10c29776ad5211e54acc72 Mon Sep 17 00:00:00 2001 From: Reuben Miller Date: Thu, 17 Oct 2024 15:09:31 +0200 Subject: [PATCH] add required ports information Signed-off-by: Reuben Miller --- docs/src/references/supported-platforms.md | 10 ++++++++++ docs/src/start/getting-started.md | 2 ++ 2 files changed, 12 insertions(+) diff --git a/docs/src/references/supported-platforms.md b/docs/src/references/supported-platforms.md index e3087de0b1a..fa2542e2704 100644 --- a/docs/src/references/supported-platforms.md +++ b/docs/src/references/supported-platforms.md @@ -51,6 +51,16 @@ The following are the supported ARM processors: Generally the newer ARM processors should be supported, as they are mostly based on the arm64/aarch64 architecture, however please let us know if something does not work as expected. +### Network configuration {#network_configuration} + +If you using %%te%% in a controlled networked, for example, behind a corporate proxy or firewall/network manager like Palo Alto Networks, then the following port configuration is required to allow communication **to each** configured cloud (e.g. Cumulocity, AWS, Azure): + +|Destination|Direction|Port|Protocol|Description| +|-----------|---------|----|--------|-----------| +|Per cloud url| Outgoing | 443 | TCP | HTTPS (Hypertext Transfer Protocol Secure) | +|Per cloud url| Outgoing | 8883 | TCP | Secure MQTT (MQTT over TLS) | + + ## Memory Usage The exact memory usage of %%te%% and the MQTT broker depends on a many factors; such factors are listed below: diff --git a/docs/src/start/getting-started.md b/docs/src/start/getting-started.md index db304877be0..bd79d3b1e4f 100644 --- a/docs/src/start/getting-started.md +++ b/docs/src/start/getting-started.md @@ -39,6 +39,8 @@ To follow this guide, you only need the following: sudo apt-get update && sudo apt-get upgrade ``` +- A network which allows communication to the [following ports](../references/supported-platforms.md#network_configuration) for each cloud URL that you plan on using + ## Steps This tutorial is divided into small steps. The first three steps are needed to install and connect to Cumulocity IoT. The last three are optional but needed to get a good overview of the capabilities of %%te%%.