yinghuoapi/deploy

Sub2API Deployment Files

This directory contains files for deploying Sub2API on Linux servers.

Deployment Methods

Method	Best For	Setup Wizard
Docker Compose	Quick setup, all-in-one	Not needed (auto-setup)
Binary Install	Production servers, systemd	Web-based wizard

Files

File	Description
docker-compose.yml	Docker Compose configuration
.env.example	Docker environment variables template
DOCKER.md	Docker Hub documentation
install.sh	One-click binary installation script
sub2api.service	Systemd service unit file
config.example.yaml	Example configuration file

---

Docker Deployment (Recommended)

Quick Start

# Clone repository
git clone https://github.com/Wei-Shaw/sub2api.git
cd sub2api/deploy

# Configure environment
cp .env.example .env
nano .env  # Set POSTGRES_PASSWORD (required)

# Start all services
docker-compose up -d

# View logs (check for auto-generated admin password)
docker-compose logs -f sub2api

# Access Web UI
# http://localhost:8080

How Auto-Setup Works

When using Docker Compose with AUTO_SETUP=true:

1. On first run, the system automatically:

   • Connects to PostgreSQL and Redis
   • Creates all database tables
   • Generates JWT secret (if not provided)
   • Creates admin account (password auto-generated if not provided)
   • Writes config.yaml

2. No manual Setup Wizard needed - just configure .env and start

3. If ADMIN_PASSWORD is not set, check logs for the generated password:

   docker-compose logs sub2api | grep "admin password"
   

Commands

# Start services
docker-compose up -d

# Stop services
docker-compose down

# View logs
docker-compose logs -f sub2api

# Restart Sub2API only
docker-compose restart sub2api

# Update to latest version
docker-compose pull
docker-compose up -d

# Remove all data (caution!)
docker-compose down -v

Environment Variables

Variable	Required	Default	Description
POSTGRES_PASSWORD	Yes	-	PostgreSQL password
SERVER_PORT	No	8080	Server port
ADMIN_EMAIL	No	admin@sub2api.local	Admin email
ADMIN_PASSWORD	No	(auto-generated)	Admin password
JWT_SECRET	No	(auto-generated)	JWT secret
TZ	No	Asia/Shanghai	Timezone

See .env.example for all available options.

---

Binary Installation

For production servers using systemd.

One-Line Installation

curl -sSL https://raw.githubusercontent.com/Wei-Shaw/sub2api/main/deploy/install.sh | sudo bash

Manual Installation

1. Download the latest release from GitHub Releases
2. Extract and copy the binary to /opt/sub2api/
3. Copy sub2api.service to /etc/systemd/system/
4. Run:

   sudo systemctl daemon-reload
   sudo systemctl enable sub2api
   sudo systemctl start sub2api
   

5. Open the Setup Wizard in your browser to complete configuration

Commands

# Install
sudo ./install.sh

# Upgrade
sudo ./install.sh upgrade

# Uninstall
sudo ./install.sh uninstall

Service Management

# Start the service
sudo systemctl start sub2api

# Stop the service
sudo systemctl stop sub2api

# Restart the service
sudo systemctl restart sub2api

# Check status
sudo systemctl status sub2api

# View logs
sudo journalctl -u sub2api -f

# Enable auto-start on boot
sudo systemctl enable sub2api

Configuration

Server Address and Port

During installation, you will be prompted to configure the server listen address and port. These settings are stored in the systemd service file as environment variables.

To change after installation:

1. Edit the systemd service:

   sudo systemctl edit sub2api
   

2. Add or modify:

   [Service]
   Environment=SERVER_HOST=0.0.0.0
   Environment=SERVER_PORT=3000
   

3. Reload and restart:

   sudo systemctl daemon-reload
   sudo systemctl restart sub2api
   

Application Configuration

The main config file is at /etc/sub2api/config.yaml (created by Setup Wizard).

Prerequisites

• Linux server (Ubuntu 20.04+, Debian 11+, CentOS 8+, etc.)
• PostgreSQL 14+
• Redis 6+
• systemd

Directory Structure

/opt/sub2api/
├── sub2api              # Main binary
├── sub2api.backup       # Backup (after upgrade)
└── data/                # Runtime data

/etc/sub2api/
└── config.yaml          # Configuration file

---

Troubleshooting

Docker

# Check container status
docker-compose ps

# View detailed logs
docker-compose logs --tail=100 sub2api

# Check database connection
docker-compose exec postgres pg_isready

# Check Redis connection
docker-compose exec redis redis-cli ping

# Restart all services
docker-compose restart

Binary Install

# Check service status
sudo systemctl status sub2api

# View recent logs
sudo journalctl -u sub2api -n 50

# Check config file
sudo cat /etc/sub2api/config.yaml

# Check PostgreSQL
sudo systemctl status postgresql

# Check Redis
sudo systemctl status redis

Common Issues

1. Port already in use: Change SERVER_PORT in .env or systemd config
2. Database connection failed: Check PostgreSQL is running and credentials are correct
3. Redis connection failed: Check Redis is running and password is correct
4. Permission denied: Ensure proper file ownership for binary install