diff --git a/public/docs/img/octopus-ai/assistant/cloud-portal.png b/public/docs/img/octopus-ai/assistant/cloud-portal.png new file mode 100644 index 0000000000..33b377d58d Binary files /dev/null and b/public/docs/img/octopus-ai/assistant/cloud-portal.png differ diff --git a/src/pages/docs/octopus-ai/assistant/getting-started.md b/src/pages/docs/octopus-ai/assistant/getting-started.md index dfc63227f8..5854c12d0a 100644 --- a/src/pages/docs/octopus-ai/assistant/getting-started.md +++ b/src/pages/docs/octopus-ai/assistant/getting-started.md @@ -9,7 +9,7 @@ navOrder: 3 ## Prerequisites -- An Octopus instance (cloud or on-premises with [public accessibility](#using-with-on-premises-instances)) +- An Octopus instance (cloud or on-premises with [public accessibility](#using-with-on-premises-instances-or-cloud-instance-allow-lists)) - A Chromium-based browser (Chrome, Brave, Edge, etc.) that supports Chrome Web Store extensions ## Installation @@ -18,10 +18,14 @@ navOrder: 3 2. Navigate to your Octopus Deploy instance. You will see a new icon in the bottom right corner of your Chrome browser 3. Click the AI Assistant icon in your browser to start using the assistant -## Using with on-premises instances +## Using with on-premises instances or cloud instance allow lists For on-premises Octopus instances, ensure your server accepts HTTPS requests from IP address `51.8.40.170` to enable AI Assistant functionality. The DNS entry of your Octopus Server will also need to be resolvable over the Internet for the IP address to be able to communicate with it. +Cloud instances with the `IP address allow list` feature activated will need to add `51.8.40.170` to the allow list to enable AI Assistant functionality: + +![Control Centre](/docs/img/octopus-ai/assistant/cloud-portal.png) + :::div{.warning} It is not possible to integrate Octopus AI Assistant with an on-premises Octopus instance that cannot accept HTTP requests from this public IP address. :::