Sellia

A fast, secure tunneling service written in Crystal that allows you to expose local services to the internet with custom subdomains.

Table of Contents

• Install
• Usage
  • Server
  • Client
  • Docker
• Environment Variables
• API
• Contributing
• License

Install

From Source

# Clone the repository
git clone https://github.com/your-github-user/sellia.git
cd sellia

# Install dependencies
shards install

# Build the project
shards build --release

Using Docker

# Build the Docker image
docker build -t sellia .

# Or pull from registry (if published)
docker pull sellia/sellia:latest

Usage

Server

Start the tunnel server:

# Basic usage
./bin/sellia serve

# With custom host and port
./bin/sellia serve --host 0.0.0.0 --port 3000

# With domain and SSL (Let's Encrypt)
./bin/sellia serve --domain yourdomain.com --acme --acme-email admin@yourdomain.com

Client

Create a tunnel to your local service:

# Basic tunnel to localhost:3000
./bin/sellia tunnel --port 3000

# With custom subdomain
./bin/sellia tunnel --port 3000 --subdomain myapp

# Connect to custom server
./bin/sellia tunnel --host https://your-server.com --port 3000

Docker

Using Docker Compose

# Copy environment file and customize
cp .env.example .env

# Start the server
docker-compose up sellia-server

# Stop all services
docker-compose down

Using Docker directly

# Start server
docker run -d \
  --name sellia-server \
  -p 3000:3000 \
  -e SELLIA_HOST=0.0.0.0 \
  -e SELLIA_PORT=3000 \
  sellia serve

# Start client (separate container)
docker run -d \
  --name sellia-client \
  -e SELLIA_SERVER_HOST=http://your-server.com \
  -e SELLIA_LOCAL_PORT=3000 \
  sellia tunnel

Environment Variables

Server Configuration

Client Configuration

API

Server Endpoints

• GET / - Landing page (redirects to documentation)
• GET /<subdomain> - Register new tunnel with subdomain
• GET /?new - Register new tunnel with random subdomain
• GET /api/tunnels/<id>/status - Get tunnel status

Response Format

{
  "id": "myapp",
  "port": 40001,
  "max_conn_count": 10,
  "url": "https://myapp.yourdomain.com"
}

Contributing

Contributions are welcome! Please feel free to submit a Pull Request. For major changes, please open an issue first to discuss what you would like to change.

Please make sure to update tests as appropriate and follow the existing code style.

Development

# Install development dependencies
shards install

# Run tests
crystal spec

# Run with development options
./bin/sellia serve --port 3000

License

MIT © Chris Watson - see the LICENSE file for details.