Skip to content
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
27 changes: 25 additions & 2 deletions en/docs/ai-gateway/1.0.0/llm-proxy/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ tags:
- llm
- quickstart
author: WSO2 API Platform Documentation Team
last_updated: 2026-06-30
last_updated: 2026-08-05
Comment thread
coderabbitai[bot] marked this conversation as resolved.
content_type: "quickstart"
---

Expand All @@ -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
Expand All @@ -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
```
Comment thread
coderabbitai[bot] marked this conversation as resolved.

On Windows PowerShell, run:

```powershell
Get-NetTCPConnection -State Listen -LocalPort 8080,8443,9090,9094 | Select-Object LocalAddress, LocalPort, OwningProcess
```
Comment thread
coderabbitai[bot] marked this conversation as resolved.

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 `<openai-apikey>` with your openai API key and run the following command to deploy a sample OpenAI LLM provider.
Expand Down
27 changes: 25 additions & 2 deletions en/docs/ai-gateway/1.0.0/mcp-proxy/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
---

Expand All @@ -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:
Comment thread
coderabbitai[bot] marked this conversation as resolved.

```bash
docker --version
Expand All @@ -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
Expand Down
27 changes: 25 additions & 2 deletions en/docs/ai-gateway/1.1.0/llm-proxy/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
---

Expand All @@ -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
Expand All @@ -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 `<openai-apikey>` with your openai API key and run the following command to deploy a sample OpenAI LLM provider.
Expand Down
27 changes: 25 additions & 2 deletions en/docs/ai-gateway/1.1.0/mcp-proxy/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
---

Expand All @@ -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
Expand All @@ -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
Expand Down
27 changes: 25 additions & 2 deletions en/docs/ai-gateway/next/llm-proxy/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
---

Expand All @@ -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
Expand Down Expand Up @@ -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:

Expand Down
27 changes: 25 additions & 2 deletions en/docs/ai-gateway/next/mcp-proxy/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
---

Expand All @@ -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
Expand Down Expand Up @@ -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:

Expand Down
29 changes: 25 additions & 4 deletions en/docs/api-gateway/1.0.0/quick-start-guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -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"
---

Expand All @@ -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
Expand All @@ -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:
Expand Down
Loading