e1saps/shortlinker repository overview

git clone https://github.com/AptS-1547/shortlinker
cd shortlinker
cargo run

# TCP port
docker run -d -p 8080:8080 -v $(pwd)/data:/data e1saps/shortlinker

# Unix socket
docker run -d -v $(pwd)/data:/data -v $(pwd)/sock:/sock \
  -e UNIX_SOCKET=/sock/shortlinker.sock e1saps/shortlinker

# Start the server
./shortlinker

# Add short links
./shortlinker add github https://github.com           # Custom code
./shortlinker add https://github.com                  # Random code
./shortlinker add github https://new-url.com --force  # Overwrite existing

# Using relative time format (v0.1.1+)
./shortlinker add daily https://example.com --expire 1d      # Expires in 1 day
./shortlinker add weekly https://example.com --expire 1w     # Expires in 1 week
./shortlinker add complex https://example.com --expire 1d2h30m  # Complex format

# Manage links
./shortlinker update github https://new-github.com --expire 30d
./shortlinker list                    # List all links
./shortlinker remove github           # Remove specific link

# Server control
./shortlinker start                   # Start server
./shortlinker stop                    # Stop server
./shortlinker restart                 # Restart server

export ADMIN_TOKEN=your_secret_token
export ADMIN_ROUTE_PREFIX=/admin  # optional

# Get all links
curl -H "Authorization: Bearer your_secret_token" \
     http://localhost:8080/admin/link

# Create link with relative time
curl -X POST \
     -H "Authorization: Bearer your_secret_token" \
     -H "Content-Type: application/json" \
     -d '{"code":"github","target":"https://github.com","expires_at":"7d"}' \
     http://localhost:8080/admin/link

# Auto-generate random code
curl -X POST \
     -H "Authorization: Bearer your_secret_token" \
     -H "Content-Type: application/json" \
     -d '{"target":"https://github.com","expires_at":"30d"}' \
     http://localhost:8080/admin/link

# Update link
curl -X PUT \
     -H "Authorization: Bearer your_secret_token" \
     -H "Content-Type: application/json" \
     -d '{"target":"https://new-url.com"}' \
     http://localhost:8080/admin/link/github

# Delete link
curl -X DELETE \
     -H "Authorization: Bearer your_secret_token" \
     http://localhost:8080/admin/link/github

# Setup
export HEALTH_TOKEN=your_health_token

# Health check
curl -H "Authorization: Bearer your_health_token" \
     http://localhost:8080/health

# Readiness check
curl http://localhost:8080/health/ready

# Liveness check  
curl http://localhost:8080/health/live

1s, 5m, 2h, 1d, 1w, 1M, 1y    # Single units
1d2h30m                        # Combined format

2024-12-31T23:59:59Z           # UTC time
2024-12-31T23:59:59+08:00      # With timezone

# Use custom config file
./shortlinker -c /path/to/your/config.toml
./shortlinker --config /path/to/your/config.toml

# If the specified file doesn't exist, it will be created automatically with default settings
./shortlinker -c /etc/shortlinker/custom.toml
# [INFO] Configuration file not found: /etc/shortlinker/custom.toml
# [INFO] Creating default configuration file...
# [INFO] Default configuration file created at: /etc/shortlinker/custom.toml

[server]
# Server listening address
host = "127.0.0.1"
# Server listening port
port = 8080
# Unix Socket path (if set, overrides host and port)
# unix_socket = "/tmp/shortlinker.sock"
# CPU core count (defaults to system cores)
cpu_count = 4

[storage]
# Storage backend type: sqlite, postgres, mysql, mariadb
# 💡 This field is now OPTIONAL - the database type can be automatically inferred from DATABASE_URL
# If specified, it will override auto-detection
type = "sqlite"
# Database connection URL or file path
# The database type is automatically detected from the URL scheme:
# - sqlite:// or .db/.sqlite files → SQLite
# - postgres:// or postgresql:// → PostgreSQL
# - mysql:// → MySQL
# - mariadb:// → MariaDB (uses MySQL protocol)
database_url = "shortlinks.db"
# Database connection pool size
pool_size = 10
# Database connection timeout (seconds)
timeout = 30

[cache]
# Cache type: memory, redis (currently only memory is supported)
type = "memory"
# Default cache expiration time (seconds)
default_ttl = 3600

[cache.redis]
# Redis connection URL
url = "redis://127.0.0.1:6379/"
# Redis key prefix
key_prefix = "shortlinker:"
# Redis connection pool size
pool_size = 10

[cache.memory]
# Memory cache maximum capacity (entries)
max_capacity = 10000

[api]
# Admin API Token (leave empty to disable admin API)
admin_token = ""
# Health check API Token (leave empty to use admin_token)
health_token = ""

[routes]
# Admin API route prefix
admin_prefix = "/admin"
# Health check route prefix
health_prefix = "/health"
# Frontend panel route prefix
frontend_prefix = "/panel"

[features]
# Whether to enable Web admin panel
enable_admin_panel = false
# Random short code length
random_code_length = 6
# Default redirect URL
default_url = "https://esap.cc/repo"

[logging]
# Log level: trace, debug, info, warn, error
level = "info"

# Server - TCP
SERVER_HOST=0.0.0.0
SERVER_PORT=8080
CPU_COUNT=4

# Server - Unix socket
# UNIX_SOCKET=/tmp/shortlinker.sock

# Storage (DATABASE_BACKEND is optional - auto-detected from DATABASE_URL)
# SQLite (file path or URL)
DATABASE_URL=data/links.db
# Or: DATABASE_URL=sqlite://data/links.db

# PostgreSQL
# DATABASE_URL=postgres://user:password@localhost:5432/shortlinker

# MySQL
# DATABASE_URL=mysql://user:password@localhost:3306/shortlinker

# MariaDB
# DATABASE_URL=mariadb://user:password@localhost:3306/shortlinker

# APIs
ADMIN_TOKEN=your_admin_token
HEALTH_TOKEN=your_health_token

# Features
DEFAULT_URL=https://example.com
RANDOM_CODE_LENGTH=8
RUST_LOG=info

# SQLite - Auto-detected
DATABASE_URL=links.db                    # Relative path
DATABASE_URL=/var/lib/shortlinker/links.db  # Absolute path
DATABASE_URL=sqlite://data/links.db      # Explicit SQLite URL

# PostgreSQL - Auto-detected
DATABASE_URL=postgres://user:pass@localhost:5432/shortlinker
DATABASE_URL=postgresql://user:pass@host:5432/db?sslmode=require

# MySQL - Auto-detected
DATABASE_URL=mysql://user:pass@localhost:3306/shortlinker
DATABASE_URL=mysql://user:pass@host:3306/db?charset=utf8mb4

# MariaDB - Auto-detected (uses MySQL protocol)
DATABASE_URL=mariadb://user:pass@localhost:3306/shortlinker

# TCP port
server {
    listen 80;
    server_name esap.cc;
    location / {
        proxy_pass http://127.0.0.1:8080;
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }
}

# Unix socket
server {
    listen 80;
    server_name esap.cc;
    location / {
        proxy_pass http://unix:/tmp/shortlinker.sock;
        add_header Cache-Control "no-cache, no-store, must-revalidate";
    }
}

[Unit]
Description=ShortLinker Service
After=network.target

[Service]
Type=simple
User=www-data
WorkingDirectory=/opt/shortlinker
ExecStart=/opt/shortlinker/shortlinker
Restart=always
Environment=SERVER_HOST=127.0.0.1
Environment=SERVER_PORT=8080

[Install]
WantedBy=multi-user.target

# Development
cargo run

# Production build
cargo build --release

# Run tests
cargo test

# Code quality
cargo fmt && cargo clippy

        ／＞　 フ
       | 　_　_|    AptS:1547
     ／` ミ＿xノ    — shortlinker assistant bot —
    /　　　　 |
   /　 ヽ　　 ﾉ      Rust / SQLite / Bloom / CLI
   │　　|　|　|
／￣|　　 |　|　|
(￣ヽ＿_ヽ_)__)
＼二)

   「ready to 307 !」