traefik-route-manager

Category: Development & Coding | Uploader: jae-jae | Downloads: 0 | Version: v1.0（Latest）

Use when an AI agent needs to manage Traefik Route Manager routes through its HTTP API, including authenticating, listing routes, and creating, updating, or deleting managed route entries that map domains to backend services.

Changelog: Source: GitHub https://github.com/jae-jae/traefik-route-manager

Directory Structure

Current level: tree/main/

📁 .github/
- 📁 workflows/
  - 📄 docker.yml 1.5 KB
📁 config/
- 📄 config.go 737 B
📁 docs/
- 📄 screenshot.png 296.1 KB
- 📄 screenshot2.png 234.9 KB
- 📄 screenshot3.png 293.4 KB
📁 internal/
- 📁 handler/
  - 📄 auth.go 646 B
  - 📄 routes.go 2.0 KB
- 📁 middleware/
  - 📄 auth.go 465 B
- 📁 model/
  - 📄 route.go 2.0 KB
- 📁 server/
  - 📄 router.go 1.5 KB
  - 📄 router_test.go 3.5 KB
- 📁 service/
  - 📄 route_service.go 8.4 KB
  - 📄 route_service_test.go 2.9 KB
📁 third_party/
- 📁 gin/
  - 📄 gin.go 6.8 KB
  - 📄 go.mod 43 B
📁 web/
- 📁 public/
  - 📄 favicon.svg 541 B
- 📁 src/
  - 📁 api/
    
    📄 client.ts 1.9 KB
  - 📁 components/
    
    📁 ui/
    
    📄 alert-dialog.tsx 262 B
    
    📄 badge.tsx 801 B
    
    📄 button.tsx 1.6 KB
    
    📄 card.tsx 1.0 KB
    
    📄 dialog.tsx 2.8 KB
    
    📄 input.tsx 563 B
    
    📄 label.tsx 260 B
    
    📄 switch.tsx 1.1 KB
    
    📄 table.tsx 1.4 KB
    
    📄 RouteForm.tsx 27.1 KB
    
    📄 RouteList.tsx 4.2 KB
  - 📁 lib/
    
    📄 utils.ts 169 B
  - 📁 pages/
    
    📄 Dashboard.tsx 7.8 KB
    
    📄 Login.tsx 2.2 KB
  - 📄 App.tsx 686 B
  - 📄 index.css 1.3 KB
  - 📄 main.tsx 238 B
  - 📄 vite-env.d.ts 38 B
- 📄 bun.lock 48.8 KB
- 📄 components.json 352 B
- 📄 index.html 499 B
- 📄 package-lock.json 102.9 KB
- 📄 package.json 825 B
- 📄 postcss.config.js 81 B
- 📄 tailwind.config.d.ts 1.8 KB
- 📄 tailwind.config.js 2.2 KB
- 📄 tailwind.config.ts 1.9 KB
- 📄 tsconfig.json 658 B
- 📄 tsconfig.node.json 256 B
- 📄 tsconfig.node.tsbuildinfo 35.7 KB
- 📄 tsconfig.tsbuildinfo 541 B
- 📄 vite.config.d.ts 76 B
- 📄 vite.config.ts 450 B
📄 .gitignore 74 B
📄 AGENTS.md 3.3 KB
📄 docker-compose.yml 292 B
📄 Dockerfile 961 B
📄 go.mod 136 B
📄 main.go 574 B
📄 README.md 4.6 KB
📄 SKILL.md 3.3 KB

SKILL.md

---
name: traefik-route-manager
description: Use when an AI agent needs to manage Traefik Route Manager routes through its HTTP API, including authenticating, listing routes, and creating, updating, or deleting managed route entries that map domains to backend services.
---

# Traefik Route Manager

Use this skill to help an AI agent operate a deployed Traefik Route Manager instance over HTTP.

## Setup

Collect these values before the first API call:

1. Base URL for the Traefik Route Manager instance, such as `https://routes.example.com` or `http://192.168.1.100:8892`
2. Shared auth token configured by the server's `AUTH_TOKEN`

Reuse previously supplied credentials only when the runtime supports secure state or the user explicitly provides them again.

## Authentication

Validate the token with:

```http
POST {baseUrl}/api/auth/login
Content-Type: application/json

{
  "token": "your-secret-token"
}
```

Send this header on every route request:

```http
Authorization: Bearer <token>
```

## Route Operations

List managed routes:

```http
GET {baseUrl}/api/routes
Authorization: Bearer <token>
```

Create a route:

```http
POST {baseUrl}/api/routes
Authorization: Bearer <token>
Content-Type: application/json

{
  "domain": "app.example.com",
  "backend": "http://192.168.1.100:3000",
  "https": true,
  "redirectHttps": false
}
```

Update a route by current domain:

```http
PUT {baseUrl}/api/routes/app.example.com
Authorization: Bearer <token>
Content-Type: application/json

{
  "domain": "app.example.com",
  "backend": "http://192.168.1.100:3001",
  "https": true,
  "redirectHttps": true
}
```

Delete a route:

```http
DELETE {baseUrl}/api/routes/app.example.com
Authorization: Bearer <token>
```

## Request Rules

Use these payload rules when creating or updating routes:

| Field | Type | Required | Rule |
|-------|------|----------|------|
| `domain` | string | Yes | Use a valid hostname such as `app.example.com` |
| `backend` | string | Yes | Include a scheme, such as `http://192.168.1.100:3000` |
| `https` | boolean | No | Enable TLS routing when `true` |
| `redirectHttps` | boolean | No | Redirect HTTP to HTTPS; only enable when `https` is also `true` |

## Responses

Expect these common responses:

- `POST /api/auth/login`: `200` on success, `401` when the token is invalid
- `GET /api/routes`: `200` with `{"routes":[...]}`
- `POST /api/routes`: `201` on success, `409` when the domain already exists, `400` on validation failure
- `PUT /api/routes/:domain`: `200` on success, `404` when the route does not exist
- `DELETE /api/routes/:domain`: `204` on success, `404` when the route does not exist

## Workflow

Follow this sequence for user requests:

1. Confirm the base URL and auth token if they are not already available in safe runtime state.
2. Validate the token with `/api/auth/login` when authentication status is unknown.
3. Choose the matching route endpoint for list, create, update, or delete.
4. Return a concise summary that includes the domain, backend, and HTTPS behavior after the API call.

## Notes

- Manage only routes handled by Traefik Route Manager.
- Expect managed files to use the `trm-` prefix, such as `trm-plex.example.com.yml`.
- Expect changes to take effect through Traefik File Provider without a service restart when the target instance is configured correctly.

Comments 0

Latest | Hot

Please login before commenting.

No comments yet. Be the first one!

traefik-route-manager

Directory Structure

SKILL.md

Report

Notice