Kongy 🦍

Kong Gateway Manager - Open source visual interface for managing routes, services, plugins, and consumers in Kong Gateway.

Note

Leia em Português: README.pt-BR.md

---

✨ Features

• 🔐 Self-contained Authentication - JWT with initial setup, no external service dependencies
• 🌍 Internationalization - Support for Portuguese (BR) and English (US) with automatic detection
• 🛡️ Security - Rate limiting, security headers, brute-force protection
• 📦 Docker Ready - Ready for deployment with Docker Compose
• 🧪 Kong Local - Development environment with integrated Kong
• 🔌 Plugin Management - Apply plugins to routes, services, and consumers
• 📤 Import/Export - Export and import route configurations
• ⚡ Vite + TypeScript - Modern frontend with Hot Module Replacement

---

📸 Screenshots

---

🚀 Quick Start

Using Docker (Recommended)

# Clone the repository
git clone https://github.com/your-username/kongy.git
cd kongy

# Copy the environment file
cp .env.example .env

# Start all services (Kong + Kongy)
docker compose up -d

# Access http://localhost:8081

If port 8081 is already in use, set another frontend port:

FRONTEND_PORT=8082 docker compose up -d
# Access http://localhost:8082

On first access, you will be redirected to create the administrator user.

Local Development

# Backend
cd backend
python -m venv venv
source venv/bin/activate
pip install -r requirements.txt
uvicorn app.main:app --reload --port 8000

# Frontend (in another terminal)
cd frontend
npm install
npm run dev

The frontend will be available at http://localhost:8081 with HMR.

---

🏗️ Architecture

┌─────────────────────────────────────────────────────────────┐
│                     Kongy Container                         │
│  ┌─────────────────────┐    ┌────────────────────────────┐  │
│  │   Frontend (Vite)   │───▶│  Backend (FastAPI)         │  │
│  │   :8081             │    │  :8000                     │  │
│  │   TypeScript/HTML   │    │  - Auth (JWT)              │  │
│  └─────────────────────┘    │  - Kong Proxy              │  │
│                              │  - Rate Limiting           │  │
│                              └──────────┬─────────────────┘  │
│                                         │                    │
│                                         ▼                    │
│                               ┌─────────────────────┐       │
│                               │   Kong Admin API    │       │
│                               │   :8001 (internal)  │       │
│                               └─────────────────────┘       │
└─────────────────────────────────────────┼───────────────────┘

---

📁 Project Structure

kongy/
├── backend/              # FastAPI backend
│   ├── app/
│   │   ├── auth/         # JWT authentication
│   │   ├── kong/         # Kong Admin API proxy
│   │   ├── storage/      # In-memory storage
│   │   └── middleware/   # Security, rate limiting
│   └── tests/            # Pytest tests
├── frontend/             # Vite + TypeScript frontend
│   ├── src/
│   │   ├── services/     # API, Auth, i18n
│   │   ├── types/        # TypeScript interfaces
│   │   ├── utils/        # Helpers, constants
│   │   ├── app.ts        # Main application
│   │   ├── ui.ts         # UI rendering
│   │   └── store.ts      # State management
│   ├── locales/          # Translations
│   └── vite.config.ts    # Vite configuration
├── docker-compose.yml    # Dev environment (with Kong)
├── docker-compose.prod.yml # Production (external Kong)
└── .env.example          # Environment template

---

⚙️ Configuration

Variable	Description	Default
SECRET_KEY	JWT signing key	change-me...
KONG_ADMIN_URL	Kong Admin API URL	http://kong:8001
DEBUG	Enable debug mode	false
JWT_EXPIRE_MINUTES	Token expiration	60
CORS_ORIGINS	Allowed CORS origins	["http://localhost:8081"]

See .env.example for all options.

KONG_ADMIN_URL is the initial Kong Admin API URL on each application startup. If initial setup provides a different URL, that override only lives in memory until the next restart.

---

🔒 Security

⚠️ Important: Data is stored in memory and lost upon restart. Configure the admin user at every startup.

• JWT Authentication
• Rate Limiting (configurable)
• Brute-force protection
• Security Headers (CSP, X-Frame-Options, etc.)
• Non-root containers

---

🧪 Testing

# Backend
cd backend
pip install -r requirements-dev.txt
pytest --cov=app

# Frontend Build
cd frontend
npm run build

On the routes screen, the actions bar includes a button to download a routes-import-example.json file with a valid import example.

The import flow now shows a summary before execution and a result modal afterwards with successes and failures per route/plugin. Route import always uses the currently selected service in the UI, and exported route JSON does not include service.id.

---

🐳 Docker Production

Build and Deploy

# Production Build
docker compose -f docker-compose.prod.yml build

# Deploy
docker compose -f docker-compose.prod.yml up -d

For container registry publishing, the frontend Dockerfile now builds the production Nginx image by default:

docker build \
  --provenance=false \
  --build-arg NPM_REGISTRY=https://nexus.example/repository/npm-group/ \
  -t kongy-frontend:1.0.0 \
  frontend

Use --target dev only when you explicitly want the Vite development image.

Kubernetes

Deployment example available in k8s/ (coming soon).

---

🤝 Contributing

Contributions are welcome! See CONTRIBUTING.md.

---

📄 License

MIT License - see LICENSE.

---

Made with ❤️ by the community