waylume_server/README.md

# Waylume Server

## About

Waylume Server is the backend component of the Waylume premium VPN service. It provides a REST API for WireGuard VPN management and integrates with Supabase for server registration and heartbeat monitoring. The server is designed to be easily deployed with Docker and can be spun up quickly to expand VPN infrastructure.

The server is written in Dart and uses process execution to interact with WireGuard tools. It is designed to be lightweight and efficient, making it suitable for deployment on various platforms, including cloud services and local servers.

## Architecture

```
┌─────────────────┐    ┌─────────────────┐    ┌─────────────────┐
│   Client Apps   │───▶│    Supabase     │◄───│ Waylume Server  │
└─────────────────┘    └─────────────────┘    └─────────────────┘
                                                        │
                                                        ▼
                                               ┌─────────────────┐
                                               │   WireGuard     │
                                               └─────────────────┘
```

Client applications communicate through Supabase to discover available Waylume servers. Each server manages WireGuard connections via REST API and registers itself with Supabase for automatic discovery and load distribution.

## Features

### Core Functionality
- **WireGuard Interface Management**: Automatic initialization and configuration of WireGuard server interface
- **Peer Management**: Create, delete, and configure VPN peers dynamically
- **Traffic Control**: Speed limiting and data cap enforcement per peer
- **Server Registration**: Automatic registration with Supabase backend
- **Health Monitoring**: Continuous heartbeat system for server availability

### API Endpoints

#### `POST /api/peers`
Create a new VPN peer with automatically generated WireGuard keys and IP assignment.

**Request:** No body required
**Response:**
```json
{
  "success": true,
  "peer": {
    "privateKey": "base64_private_key",
    "publicKey": "base64_public_key", 
    "ip": "10.0.0.x"
  },
  "config": "complete_wireguard_client_config"
}
```

#### `POST /api/peers/delete`
Remove a VPN peer and clean up associated WireGuard configuration.

**Request Body:**
```json
{
  "publicKey": "peer_public_key_here"
}
```

#### `POST /api/peers/speed-limit`
Set bidirectional bandwidth limits for a peer (controls both upload and download speeds).

**Request Body:**
```json
{
  "publicKey": "peer_public_key_here",
  "bytesPerSecond": 125000
}
```
*Note: 125000 bytes/s = 1000 kbps = 1 Mbps*

**Common Speed Conversions:**
- 125 KB/s = 1 Mbps
- 1,250 KB/s = 10 Mbps  
- 12,500 KB/s = 100 Mbps

#### `POST /api/peers/data-cap`
Set total data usage limits for a peer using iptables quota rules.

**Request Body:**
```json
{
  "publicKey": "peer_public_key_here", 
  "quotaBytes": 1073741824
}
```
*Note: 1073741824 bytes = 1 GB*

**Common Data Conversions:**
- 1 GB = 1,073,741,824 bytes
- 10 GB = 10,737,418,240 bytes
- 100 GB = 107,374,182,400 bytes

#### `POST /api/peers/config`
Retrieve peer configuration (currently not implemented - returns 404).

### Security Features
- Peer isolation using iptables rules (prevents peer-to-peer communication)
- Traffic shaping and quota enforcement
- Automatic IP address assignment within 10.0.0.0/8 range
- Secure key generation for each peer

## Prerequisites

- Docker and Docker Compose
- WireGuard kernel module support
- Supabase project with `waylume_servers` table

## Environment Variables

Create a `.env` file with the following variables:

```env
# Supabase Configuration
SUPABASE_URL=your_supabase_url
SUPABASE_KEY=your_supabase_anon_key

# Server Configuration
SERVER_ID=unique_server_identifier
EXTERNAL_PORT=3000
```

## Quick Start

### Using Docker Compose (Recommended)

1. Clone the repository
2. Create your `.env` file with required variables
3. Run the server:

```bash
docker-compose up -d
```

The server will be available on port 3000 (or your configured `EXTERNAL_PORT`).

### Building from Source

1. Install Dart SDK (3.9.0-100.2.beta or later)
2. Install dependencies:
```bash
dart pub get
```
3. Compile and run:
```bash
dart compile exe lib/main.dart -o waylume_server
./waylume_server
```

## Docker Configuration

The Docker setup includes:
- WireGuard tools and kernel module support
- iptables for traffic control and peer isolation
- Network capabilities (`NET_ADMIN`) for interface management
- UDP port 51820 for WireGuard traffic
- TCP port 3000 for REST API

## API Usage Examples

### Create a new peer
```bash
curl -X POST http://localhost:3000/api/peers
```

Response:
```json
{
  "success": true,
  "peer": {
    "privateKey": "...",
    "publicKey": "...",
    "ip": "10.0.0.2"
  },
  "config": "[Interface]\nPrivateKey = ...\n..."
}
```

### Delete a peer
```bash
curl -X POST http://localhost:3000/api/peers/delete \
  -H "Content-Type: application/json" \
  -d '{"publicKey": "PEER_PUBLIC_KEY_HERE"}'
```

### Set speed limit for peer
```bash
curl -X POST http://localhost:3000/api/peers/speed-limit \
  -H "Content-Type: application/json" \
  -d '{"publicKey": "PEER_PUBLIC_KEY_HERE", "bytesPerSecond": 125000}' # 125000 bytes/s = 1000 kbps
```

### Set data cap for peer
```bash
curl -X POST http://localhost:3000/api/peers/data-cap \
  -H "Content-Type: application/json" \
  -d '{"publicKey": "PEER_PUBLIC_KEY_HERE", "quotaBytes": 1073741824}' # 1073741824 bytes = 1024 MB
```

### Get peer config
```bash
curl -X POST http://localhost:3000/api/peers/config \
  -H "Content-Type: application/json" \
  -d '{"publicKey": "PEER_PUBLIC_KEY_HERE"}'
```

## Network Architecture

- **WireGuard Interface**: `wg0` on `10.0.0.1/24`
- **Peer IP Range**: `10.0.0.2` - `10.255.255.254`
- **WireGuard Port**: `51820/udp`
- **API Port**: `3000/tcp`

## Logging

The server provides detailed request logging including:
- Client IP addresses (with proxy header support)
- User agents
- Request methods and paths
- Timestamps

## Development

The project structure:
```
lib/
├── config/          # Supabase configuration
├── core/            # Utility functions
├── services/        # Core services (server, heartbeat, wireguard)
├── web/             # HTTP routes and handlers
├── wireguard/       # WireGuard-specific functionality
└── main.dart        # Application entry point
```