From e918f409f2904718771f3588ac3a3ba0d88cd201 Mon Sep 17 00:00:00 2001 From: arshardh Date: Tue, 4 Aug 2026 18:24:39 +0530 Subject: [PATCH 1/3] Enhance Docker instructions across multiple quick start guides --- .../1.0.0/llm-proxy/quick-start-guide.md | 19 +++++++++++++++-- .../1.0.0/mcp-proxy/quick-start-guide.md | 19 +++++++++++++++-- .../1.1.0/llm-proxy/quick-start-guide.md | 19 +++++++++++++++-- .../1.1.0/mcp-proxy/quick-start-guide.md | 19 +++++++++++++++-- .../next/llm-proxy/quick-start-guide.md | 19 +++++++++++++++-- .../next/mcp-proxy/quick-start-guide.md | 19 +++++++++++++++-- .../api-gateway/1.0.0/quick-start-guide.md | 21 +++++++++++++++---- .../api-gateway/1.1.0/quick-start-guide.md | 19 +++++++++++++++-- en/docs/api-gateway/next/quick-start-guide.md | 19 +++++++++++++++-- .../cloud/ai-gateway/llm/quick-start-guide.md | 19 +++++++++++++++-- .../cloud/ai-gateway/mcp/quick-start-guide.md | 19 +++++++++++++++-- en/docs/next/ai-workspace/getting-started.md | 15 ++++++++++--- 12 files changed, 199 insertions(+), 27 deletions(-) diff --git a/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md index dc48cf13e..19d699ec4 100644 --- a/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-06-30 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -35,11 +35,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -63,6 +66,18 @@ docker compose up -d curl http://localhost:9094/health ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + ## Deploy an OpenAI LLM provider configuration The API Platform Gateway currently includes first-class support for the OpenAI LLM provider. As a platform administrator, replace `` with your openai API key and run the following command to deploy a sample OpenAI LLM provider. diff --git a/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md index d176c4e93..659d93ae2 100644 --- a/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-06-30 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -35,11 +35,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -62,6 +65,18 @@ docker compose -p ai-gateway up -d curl http://localhost:9094/health ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + ## Deploy an MCP proxy configuration Start the sample MCP server diff --git a/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md index fe3d37558..80456bdc0 100644 --- a/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-07-02 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -35,11 +35,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -63,6 +66,18 @@ docker compose up -d curl http://localhost:9094/health ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + ## Deploy an OpenAI LLM provider configuration The API Platform Gateway currently includes first-class support for the OpenAI LLM provider. As a platform administrator, replace `` with your openai API key and run the following command to deploy a sample OpenAI LLM provider. diff --git a/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md index 617c14e60..659d93ae2 100644 --- a/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-07-02 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -35,11 +35,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -62,6 +65,18 @@ docker compose -p ai-gateway up -d curl http://localhost:9094/health ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + ## Deploy an MCP proxy configuration Start the sample MCP server diff --git a/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md b/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md index 3b0e0d9d5..18b149fea 100644 --- a/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-07-02 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -35,11 +35,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -73,6 +76,18 @@ docker compose up -d curl http://localhost:9094/api/admin/v1/health ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + !!! note "Running on Windows" The commands above assume a Linux/macOS shell. On Windows, run the one-time setup with the PowerShell script instead — it takes the same flags and provisions the same files: diff --git a/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md b/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md index fc0c38223..403b0735e 100644 --- a/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-07-02 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -35,11 +35,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -72,6 +75,18 @@ docker compose -p ai-gateway up -d curl http://localhost:9094/api/admin/v1/health ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + !!! note "Running on Windows" The commands above assume a Linux/macOS shell. On Windows, run the one-time setup with the PowerShell script instead — it takes the same flags and provisions the same files: diff --git a/en/docs/api-gateway/1.0.0/quick-start-guide.md b/en/docs/api-gateway/1.0.0/quick-start-guide.md index b7bb9994d..9fc134d7b 100644 --- a/en/docs/api-gateway/1.0.0/quick-start-guide.md +++ b/en/docs/api-gateway/1.0.0/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - quickstart - docker author: WSO2 API Platform Documentation Team -last_updated: 2026-06-11 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -26,10 +26,11 @@ Before you begin, ensure you have: - **wget** or **curl** installed - **unzip** installed -- **Docker** installed and running -- **Docker Compose** installed +- A Compose-compatible container runtime, such as Docker Desktop, Podman Desktop or Podman, Rancher Desktop, Colima, or Docker Engine with the Compose plugin -Verify that both `docker` and `docker compose` commands are available: +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -56,6 +57,18 @@ cd wso2apip-api-gateway-1.1.0/ docker compose up -d ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + ### Step 3: Verify the Gateway Check that the gateway controller is up and healthy: diff --git a/en/docs/api-gateway/1.1.0/quick-start-guide.md b/en/docs/api-gateway/1.1.0/quick-start-guide.md index 1b236aa1a..ca3db0637 100644 --- a/en/docs/api-gateway/1.1.0/quick-start-guide.md +++ b/en/docs/api-gateway/1.1.0/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - quickstart - docker author: WSO2 API Platform Documentation Team -last_updated: 2026-06-11 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -21,11 +21,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -96,6 +99,18 @@ curl -i http://localhost:8080/reading-list/v1.0/books curl -ik https://localhost:8443/reading-list/v1.0/books ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + ### Stopping the Gateway When stopping the gateway, you have two options: diff --git a/en/docs/api-gateway/next/quick-start-guide.md b/en/docs/api-gateway/next/quick-start-guide.md index 381a2e995..580c9d90b 100644 --- a/en/docs/api-gateway/next/quick-start-guide.md +++ b/en/docs/api-gateway/next/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - quickstart - docker author: WSO2 API Platform Documentation Team -last_updated: 2026-06-11 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -21,11 +21,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -106,6 +109,18 @@ curl -i http://localhost:8080/reading-list/v1.0/books curl -ik https://localhost:8443/reading-list/v1.0/books ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + !!! note "Running on Windows" The commands above assume a Linux/macOS shell. On Windows, run the one-time setup with the PowerShell script instead — it takes the same flags and provisions the same files: diff --git a/en/docs/cloud/ai-gateway/llm/quick-start-guide.md b/en/docs/cloud/ai-gateway/llm/quick-start-guide.md index ccc6a6b09..2fa285eda 100644 --- a/en/docs/cloud/ai-gateway/llm/quick-start-guide.md +++ b/en/docs/cloud/ai-gateway/llm/quick-start-guide.md @@ -9,7 +9,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-06-22 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -23,11 +23,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -51,6 +54,18 @@ docker compose up -d curl http://localhost:9094/health ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + ## Deploy an OpenAI LLM provider configuration The API Platform Gateway currently includes first-class support for the OpenAI LLM provider. As a platform administrator, replace `` with your openai API key and run the following command to deploy a sample OpenAI LLM provider. diff --git a/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md b/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md index 0efe88b42..99ab8dea4 100644 --- a/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md +++ b/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md @@ -9,7 +9,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-06-22 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -23,11 +23,14 @@ content_type: "quickstart" A Docker-compatible container runtime such as: - Docker Desktop (Windows / macOS) +- Podman Desktop or Podman (Windows / macOS / Linux) - Rancher Desktop (Windows / macOS) - Colima (macOS) - Docker Engine + Compose plugin (Linux) -Ensure `docker` and `docker compose` commands are available. +These examples use `docker compose`. If you use another Compose-compatible runtime, use the equivalent commands. + +Verify the commands for your runtime are available. For Docker: ```bash docker --version @@ -52,6 +55,18 @@ docker compose -p ai-gateway up -d curl http://localhost:9094/health ``` +!!! tip "Port 8080, 8443, 9090, or 9094 already taken?" + If the start command fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:8080 -sTCP:LISTEN + lsof -nP -iTCP:8443 -sTCP:LISTEN + lsof -nP -iTCP:9090 -sTCP:LISTEN + lsof -nP -iTCP:9094 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + ## Deploy an MCP proxy configuration Start the sample MCP server diff --git a/en/docs/next/ai-workspace/getting-started.md b/en/docs/next/ai-workspace/getting-started.md index cd9068d19..9a387ff51 100644 --- a/en/docs/next/ai-workspace/getting-started.md +++ b/en/docs/next/ai-workspace/getting-started.md @@ -8,7 +8,7 @@ tags: - ai-workspace - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-07-31 +last_updated: 2026-08-04 content_type: "quickstart" --- @@ -18,10 +18,12 @@ The AI Workspace lets you manage AI gateways and large language model (LLM) prov ## Prerequisites -- [Docker](https://docs.docker.com/get-docker/) with the Compose plugin (`docker compose version`) +- [Docker](https://docs.docker.com/get-docker/) with the Compose plugin, or another Compose-compatible container runtime such as Podman - Ports **9643** and **9243** available on your machine. If either one is taken, see [Change the ports AI Workspace uses](setting-up/ports.md). - `curl` and `unzip` installed +This guide shows commands with `docker compose`. If you use Podman or another Compose-compatible runtime, run the equivalent compose command instead, such as `podman compose up -d`. + ## Step 1: Download AI Workspace Run this command in your terminal to download and unzip AI Workspace: @@ -66,7 +68,14 @@ docker compose up -d ``` !!! tip "Port 9643 or 9243 already taken?" - Change the host side of the `ports:` mappings in `docker-compose.yaml` before you start—for example `"9743:9643"` for the AI Workspace. Open AI Workspace on the remapped host port in the next step, such as `https://localhost:9743` instead of `https://localhost:9643`. See [Change the ports AI Workspace uses](setting-up/ports.md) for the two config keys that need to match. + If `docker compose up -d` fails with a port binding error, identify what is already listening on the default ports: + + ```bash + lsof -nP -iTCP:9643 -sTCP:LISTEN + lsof -nP -iTCP:9243 -sTCP:LISTEN + ``` + + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the `ports:` mappings in `docker-compose.yaml` before you start, for example `"9743:9643"` for AI Workspace. Open AI Workspace on the remapped host port in the next step, such as `https://localhost:9743` instead of `https://localhost:9643`. See [Change the ports AI Workspace uses](setting-up/ports.md) for the two config keys that need to match. ## Step 4: Open AI Workspace From cc6b22b32718221c8f54a9d3231de801aeeb611e Mon Sep 17 00:00:00 2001 From: arshardh Date: Wed, 5 Aug 2026 02:22:33 +0530 Subject: [PATCH 2/3] Fix powershell command for port finding --- .../ai-gateway/1.0.0/llm-proxy/quick-start-guide.md | 10 +++++++++- .../ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md | 10 +++++++++- .../ai-gateway/1.1.0/llm-proxy/quick-start-guide.md | 10 +++++++++- .../ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md | 10 +++++++++- en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md | 10 +++++++++- en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md | 10 +++++++++- en/docs/api-gateway/1.0.0/quick-start-guide.md | 10 +++++++++- en/docs/api-gateway/1.1.0/quick-start-guide.md | 10 +++++++++- en/docs/api-gateway/next/quick-start-guide.md | 10 +++++++++- en/docs/cloud/ai-gateway/llm/quick-start-guide.md | 10 +++++++++- en/docs/cloud/ai-gateway/mcp/quick-start-guide.md | 10 +++++++++- en/docs/next/ai-workspace/getting-started.md | 10 +++++++++- 12 files changed, 108 insertions(+), 12 deletions(-) diff --git a/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md index 19d699ec4..4be5c4e34 100644 --- a/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -69,6 +69,8 @@ curl http://localhost:9094/health !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -76,6 +78,12 @@ curl http://localhost:9094/health lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. ## Deploy an OpenAI LLM provider configuration diff --git a/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md index 659d93ae2..6d48735bd 100644 --- a/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -68,6 +68,8 @@ curl http://localhost:9094/health !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -75,6 +77,12 @@ curl http://localhost:9094/health lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. ## Deploy an MCP proxy configuration diff --git a/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md index 80456bdc0..f5623c97f 100644 --- a/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -69,6 +69,8 @@ curl http://localhost:9094/health !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -76,6 +78,12 @@ curl http://localhost:9094/health lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. ## Deploy an OpenAI LLM provider configuration diff --git a/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md index 659d93ae2..6d48735bd 100644 --- a/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -68,6 +68,8 @@ curl http://localhost:9094/health !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -75,6 +77,12 @@ curl http://localhost:9094/health lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. ## Deploy an MCP proxy configuration diff --git a/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md b/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md index 18b149fea..9130d92a0 100644 --- a/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -79,6 +79,8 @@ curl http://localhost:9094/api/admin/v1/health !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -86,6 +88,12 @@ curl http://localhost:9094/api/admin/v1/health lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. !!! note "Running on Windows" diff --git a/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md b/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md index 403b0735e..c69c33841 100644 --- a/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -78,6 +78,8 @@ curl http://localhost:9094/api/admin/v1/health !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -85,6 +87,12 @@ curl http://localhost:9094/api/admin/v1/health lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. !!! note "Running on Windows" diff --git a/en/docs/api-gateway/1.0.0/quick-start-guide.md b/en/docs/api-gateway/1.0.0/quick-start-guide.md index 9fc134d7b..bc40bbe30 100644 --- a/en/docs/api-gateway/1.0.0/quick-start-guide.md +++ b/en/docs/api-gateway/1.0.0/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - quickstart - docker author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -60,6 +60,8 @@ docker compose up -d !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -67,6 +69,12 @@ docker compose up -d lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. ### Step 3: Verify the Gateway diff --git a/en/docs/api-gateway/1.1.0/quick-start-guide.md b/en/docs/api-gateway/1.1.0/quick-start-guide.md index ca3db0637..695e3f7a1 100644 --- a/en/docs/api-gateway/1.1.0/quick-start-guide.md +++ b/en/docs/api-gateway/1.1.0/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - quickstart - docker author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -102,6 +102,8 @@ curl -ik https://localhost:8443/reading-list/v1.0/books !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -109,6 +111,12 @@ curl -ik https://localhost:8443/reading-list/v1.0/books lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. ### Stopping the Gateway diff --git a/en/docs/api-gateway/next/quick-start-guide.md b/en/docs/api-gateway/next/quick-start-guide.md index 580c9d90b..4699fc70a 100644 --- a/en/docs/api-gateway/next/quick-start-guide.md +++ b/en/docs/api-gateway/next/quick-start-guide.md @@ -8,7 +8,7 @@ tags: - quickstart - docker author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -112,6 +112,8 @@ curl -ik https://localhost:8443/reading-list/v1.0/books !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -119,6 +121,12 @@ curl -ik https://localhost:8443/reading-list/v1.0/books lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. !!! note "Running on Windows" diff --git a/en/docs/cloud/ai-gateway/llm/quick-start-guide.md b/en/docs/cloud/ai-gateway/llm/quick-start-guide.md index 2fa285eda..698d82778 100644 --- a/en/docs/cloud/ai-gateway/llm/quick-start-guide.md +++ b/en/docs/cloud/ai-gateway/llm/quick-start-guide.md @@ -9,7 +9,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -57,6 +57,8 @@ curl http://localhost:9094/health !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -64,6 +66,12 @@ curl http://localhost:9094/health lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. ## Deploy an OpenAI LLM provider configuration diff --git a/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md b/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md index 99ab8dea4..d79b3dbcf 100644 --- a/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md +++ b/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md @@ -9,7 +9,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -58,6 +58,8 @@ curl http://localhost:9094/health !!! tip "Port 8080, 8443, 9090, or 9094 already taken?" If the start command fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:8080 -sTCP:LISTEN lsof -nP -iTCP:8443 -sTCP:LISTEN @@ -65,6 +67,12 @@ curl http://localhost:9094/health lsof -nP -iTCP:9094 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. ## Deploy an MCP proxy configuration diff --git a/en/docs/next/ai-workspace/getting-started.md b/en/docs/next/ai-workspace/getting-started.md index 9a387ff51..b6606401a 100644 --- a/en/docs/next/ai-workspace/getting-started.md +++ b/en/docs/next/ai-workspace/getting-started.md @@ -8,7 +8,7 @@ tags: - ai-workspace - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-08-04 +last_updated: 2026-08-05 content_type: "quickstart" --- @@ -70,11 +70,19 @@ docker compose up -d !!! tip "Port 9643 or 9243 already taken?" If `docker compose up -d` fails with a port binding error, identify what is already listening on the default ports: + On macOS or Linux, run: + ```bash lsof -nP -iTCP:9643 -sTCP:LISTEN lsof -nP -iTCP:9243 -sTCP:LISTEN ``` + On Windows PowerShell, run: + + ```powershell + Get-NetTCPConnection -State Listen -LocalPort 9643,9243 | Select-Object LocalAddress, LocalPort, OwningProcess + ``` + Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the `ports:` mappings in `docker-compose.yaml` before you start, for example `"9743:9643"` for AI Workspace. Open AI Workspace on the remapped host port in the next step, such as `https://localhost:9743` instead of `https://localhost:9643`. See [Change the ports AI Workspace uses](setting-up/ports.md) for the two config keys that need to match. ## Step 4: Open AI Workspace From b5ed729bc2b55da38340fb039c41253870111f94 Mon Sep 17 00:00:00 2001 From: arshardh Date: Wed, 5 Aug 2026 02:30:36 +0530 Subject: [PATCH 3/3] Refine instructions for handling conflicting services in quick start guides --- en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md | 2 +- en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md | 2 +- en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md | 2 +- en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md | 2 +- en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md | 2 +- en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md | 2 +- en/docs/api-gateway/1.0.0/quick-start-guide.md | 2 +- en/docs/api-gateway/1.1.0/quick-start-guide.md | 2 +- en/docs/api-gateway/next/quick-start-guide.md | 2 +- en/docs/cloud/ai-gateway/llm/quick-start-guide.md | 2 +- en/docs/cloud/ai-gateway/mcp/quick-start-guide.md | 2 +- en/docs/next/ai-workspace/getting-started.md | 2 +- 12 files changed, 12 insertions(+), 12 deletions(-) diff --git a/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md index 4be5c4e34..23e7b6bab 100644 --- a/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md @@ -84,7 +84,7 @@ curl http://localhost:9094/health Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. ## Deploy an OpenAI LLM provider configuration diff --git a/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md index 6d48735bd..275730704 100644 --- a/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md @@ -83,7 +83,7 @@ curl http://localhost:9094/health Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. ## Deploy an MCP proxy configuration diff --git a/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md index f5623c97f..34d4901a3 100644 --- a/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md @@ -84,7 +84,7 @@ curl http://localhost:9094/health Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. ## Deploy an OpenAI LLM provider configuration diff --git a/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md b/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md index 6d48735bd..275730704 100644 --- a/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md @@ -83,7 +83,7 @@ curl http://localhost:9094/health Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. ## Deploy an MCP proxy configuration diff --git a/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md b/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md index 9130d92a0..ef0331322 100644 --- a/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md @@ -94,7 +94,7 @@ curl http://localhost:9094/api/admin/v1/health Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. !!! note "Running on Windows" The commands above assume a Linux/macOS shell. On Windows, run the one-time setup with the PowerShell script instead — it takes the same flags and provisions the same files: diff --git a/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md b/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md index c69c33841..0ae488a6d 100644 --- a/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md +++ b/en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md @@ -93,7 +93,7 @@ curl http://localhost:9094/api/admin/v1/health Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. !!! note "Running on Windows" The commands above assume a Linux/macOS shell. On Windows, run the one-time setup with the PowerShell script instead — it takes the same flags and provisions the same files: diff --git a/en/docs/api-gateway/1.0.0/quick-start-guide.md b/en/docs/api-gateway/1.0.0/quick-start-guide.md index bc40bbe30..d452357e3 100644 --- a/en/docs/api-gateway/1.0.0/quick-start-guide.md +++ b/en/docs/api-gateway/1.0.0/quick-start-guide.md @@ -75,7 +75,7 @@ docker compose up -d Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. ### Step 3: Verify the Gateway diff --git a/en/docs/api-gateway/1.1.0/quick-start-guide.md b/en/docs/api-gateway/1.1.0/quick-start-guide.md index 695e3f7a1..4b0951695 100644 --- a/en/docs/api-gateway/1.1.0/quick-start-guide.md +++ b/en/docs/api-gateway/1.1.0/quick-start-guide.md @@ -117,7 +117,7 @@ curl -ik https://localhost:8443/reading-list/v1.0/books Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. ### Stopping the Gateway diff --git a/en/docs/api-gateway/next/quick-start-guide.md b/en/docs/api-gateway/next/quick-start-guide.md index 4699fc70a..b2133f394 100644 --- a/en/docs/api-gateway/next/quick-start-guide.md +++ b/en/docs/api-gateway/next/quick-start-guide.md @@ -127,7 +127,7 @@ curl -ik https://localhost:8443/reading-list/v1.0/books Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. !!! note "Running on Windows" The commands above assume a Linux/macOS shell. On Windows, run the one-time setup with the PowerShell script instead — it takes the same flags and provisions the same files: diff --git a/en/docs/cloud/ai-gateway/llm/quick-start-guide.md b/en/docs/cloud/ai-gateway/llm/quick-start-guide.md index 698d82778..7b488126f 100644 --- a/en/docs/cloud/ai-gateway/llm/quick-start-guide.md +++ b/en/docs/cloud/ai-gateway/llm/quick-start-guide.md @@ -72,7 +72,7 @@ curl http://localhost:9094/health Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. ## Deploy an OpenAI LLM provider configuration diff --git a/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md b/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md index d79b3dbcf..32de8e65f 100644 --- a/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md +++ b/en/docs/cloud/ai-gateway/mcp/quick-start-guide.md @@ -73,7 +73,7 @@ curl http://localhost:9094/health Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the relevant `ports:` mapping in `docker-compose.yaml`, then use the remapped host port in the verification and test commands on this page. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side value of the relevant `ports:` mapping in `docker-compose.yaml`. Then use the remapped host port in the verification and test commands on this page. ## Deploy an MCP proxy configuration diff --git a/en/docs/next/ai-workspace/getting-started.md b/en/docs/next/ai-workspace/getting-started.md index b6606401a..fa4013199 100644 --- a/en/docs/next/ai-workspace/getting-started.md +++ b/en/docs/next/ai-workspace/getting-started.md @@ -83,7 +83,7 @@ docker compose up -d Get-NetTCPConnection -State Listen -LocalPort 9643,9243 | Select-Object LocalAddress, LocalPort, OwningProcess ``` - Stop the conflicting service if you don't need it. If you need to keep it running, change the host side of the `ports:` mappings in `docker-compose.yaml` before you start, for example `"9743:9643"` for AI Workspace. Open AI Workspace on the remapped host port in the next step, such as `https://localhost:9743` instead of `https://localhost:9643`. See [Change the ports AI Workspace uses](setting-up/ports.md) for the two config keys that need to match. + Stop the conflicting service if you don't need it. If you need to keep it running, change the host-side `ports:` mapping in `docker-compose.yaml` before you start. For example, use `"9743:9643"` for AI Workspace. Open AI Workspace on the remapped host port in the next step. For example, use `https://localhost:9743` instead of `https://localhost:9643`. See [Change the ports AI Workspace uses](setting-up/ports.md) for the two config keys that need to match. ## Step 4: Open AI Workspace