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..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 @@ -8,7 +8,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-06-30 +last_updated: 2026-08-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 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..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 @@ -8,7 +8,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-06-30 +last_updated: 2026-08-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 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..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 @@ -8,7 +8,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-07-02 +last_updated: 2026-08-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 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..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 @@ -8,7 +8,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-07-02 +last_updated: 2026-08-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 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..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 @@ -8,7 +8,7 @@ tags: - llm - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-07-02 +last_updated: 2026-08-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 fc0c38223..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 @@ -8,7 +8,7 @@ tags: - mcp - quickstart author: WSO2 API Platform Documentation Team -last_updated: 2026-07-02 +last_updated: 2026-08-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 b7bb9994d..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 @@ -8,7 +8,7 @@ tags: - quickstart - docker author: WSO2 API Platform Documentation Team -last_updated: 2026-06-11 +last_updated: 2026-08-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 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..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 @@ -8,7 +8,7 @@ tags: - quickstart - docker author: WSO2 API Platform Documentation Team -last_updated: 2026-06-11 +last_updated: 2026-08-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 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..b2133f394 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-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 ccc6a6b09..7b488126f 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-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 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..32de8e65f 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-05 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,26 @@ 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: + + On macOS or Linux, run: + + ```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 + ``` + + 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 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 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..fa4013199 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-05 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,22 @@ 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: + + 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 `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