From 876accf2e823481fc9785bbfcee13fc721113638 Mon Sep 17 00:00:00 2001 From: Mandy Michael Date: Fri, 13 Dec 2024 07:05:50 +0800 Subject: [PATCH 1/2] update outbound requests documentation with in app messaging information --- dictionary-octopus.txt | 1 + .../docs/security/outbound-requests/index.md | 38 ++++++++++--------- 2 files changed, 21 insertions(+), 18 deletions(-) diff --git a/dictionary-octopus.txt b/dictionary-octopus.txt index e6ba846986..a26c492ff3 100644 --- a/dictionary-octopus.txt +++ b/dictionary-octopus.txt @@ -392,6 +392,7 @@ SSPI SSRS statefulset statefulsets +stepsprodpackages.blob.core.windows.net sthumb strconv struct diff --git a/src/pages/docs/security/outbound-requests/index.md b/src/pages/docs/security/outbound-requests/index.md index 60af582ced..2e53fc20dd 100644 --- a/src/pages/docs/security/outbound-requests/index.md +++ b/src/pages/docs/security/outbound-requests/index.md @@ -1,7 +1,7 @@ --- layout: src/layouts/Default.astro pubDate: 2023-01-01 -modDate: 2023-01-01 +modDate: 2024-12-13 title: Outbound requests description: Traffic details of network requests made by Octopus and Tentacle, and what information is included when Octopus checks for updates. navOrder: 25 @@ -9,7 +9,7 @@ navOrder: 25 This page describes any outbound network requests made by Octopus and Tentacle, and what information is included when Octopus checks for updates. -## Outbound requests by Tentacle {#Outboundrequests-OutboundrequestsbyTentacle} +## Outbound requests by Tentacle For security reasons, we minimize the number of outbound requests made by the Tentacle deployment agent. The only outbound requests you should see are for: @@ -20,7 +20,7 @@ For security reasons, we minimize the number of outbound requests made by the Te It's possible that scripts in your packages may make outbound requests; in this case you should take care when deploying packages created by a third party. -## Outbound requests by Octopus {#Outboundrequests-OutboundrequestsbyOctopus} +## Outbound requests by Octopus The Octopus Server makes the following outbound requests: @@ -30,7 +30,8 @@ The Octopus Server makes the following outbound requests: 4. Checking for updates (if enabled). 5. Checking for updated [built-in step templates](/docs/projects/built-in-step-templates) (if enabled). 6. Checking for updated [community contributed step templates](/docs/projects/community-step-templates) (if enabled). -7. Behavioral telemetry is sent to https://telemetry.octopus.com (if enabled). +7. Behavioral telemetry is sent to `https://telemetry.octopus.com` (if enabled). +8. Email address is sent to `https://experiences.octopus.com` via In-App messaging (if enabled). ### Built-in step templates @@ -43,7 +44,7 @@ From **Octopus 2022.1** some built-in step templates can be automatically update Our community contributed step template integration queries `library.octopus.com` for updates. -## What information is included when Octopus checks for updates? {#Outboundrequests-WhatinformationisincludedwhenOctopuschecksforupdates?} +## What information is included when Octopus checks for updates? By default, Octopus will periodically check for new releases. You can opt-out of checking for updates by navigating to **Configuration ➜ Settings ➜ Updates** in Octopus. @@ -59,16 +60,17 @@ The Octopus.com site is hosted on Microsoft Azure, so you will see traffic going ## Disabling outbound requests -In isolated/air-gapped scenarios without access to the internet, it may prove beneficial to disable attempts to contact these external services to prevent failed tasks and/or errors in the logs. Details on how to disable each feature are as follows: -* Octopus Server updates - * Via the Web Portal: **Configuration ➜ Settings ➜ Updates** - * Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --upgradeCheck=false` -* Built-in step template updates - * Via the Web Portal: **Configuration ➜ Features ➜ Step Template Updates** -* Community step updates - * Via the Web Portal: **Configuration ➜ Features ➜ Community Step Templates** -* Telemetry - * Via the Web Portal: **Configuration ➜ Telemetry** - * Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --sendTelemetry=false` -* Dynamic Extensions - * Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --dynamicExtensionsEnabled=false` +- Octopus Server updates + - Via the Web Portal: **Configuration ➜ Settings ➜ Updates** + - Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --upgradeCheck=false` +- Built-in step template updates + - Via the Web Portal: **Configuration ➜ Features ➜ Step Template Updates** +- Community step updates + - Via the Web Portal: **Configuration ➜ Features ➜ Community Step Templates** +- Telemetry + - Via the Web Portal: **Configuration ➜ Telemetry** + - Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --sendTelemetry=false` +- Dynamic Extensions + - Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --dynamicExtensionsEnabled=false` +- In-App Messaging via Chameleon + - Please contact [support@octopus.com](mailto:support@octopus.com) for assistance disabling In-App Messaging From 5623b40568f354beb1d5e8aabf41c1b4bf2795f9 Mon Sep 17 00:00:00 2001 From: Mandy Michael Date: Fri, 13 Dec 2024 07:12:11 +0800 Subject: [PATCH 2/2] add back in content i accidentally removed --- src/pages/docs/security/outbound-requests/index.md | 2 ++ 1 file changed, 2 insertions(+) diff --git a/src/pages/docs/security/outbound-requests/index.md b/src/pages/docs/security/outbound-requests/index.md index 2e53fc20dd..6f2e4905f6 100644 --- a/src/pages/docs/security/outbound-requests/index.md +++ b/src/pages/docs/security/outbound-requests/index.md @@ -60,6 +60,8 @@ The Octopus.com site is hosted on Microsoft Azure, so you will see traffic going ## Disabling outbound requests +In isolated/air-gapped scenarios without access to the internet, it may prove beneficial to disable attempts to contact these external services to prevent failed tasks and/or errors in the logs. Details on how to disable each feature are as follows: + - Octopus Server updates - Via the Web Portal: **Configuration ➜ Settings ➜ Updates** - Via the CLI [configure command](/docs/octopus-rest-api/octopus.server.exe-command-line/configure): `Octopus.Server.exe configure --upgradeCheck=false`