🚀 VPS Starter Kit

A production-ready VPS platform template for Ubuntu 24.04 built with Docker, security hardening, monitoring, and GitHub Actions CI/CD.

Transform your fresh VPS into a structured, reusable platform with reverse proxy, HTTPS, databases, caching, application deployment, backup workflows, and comprehensive monitoring.

✨ Features

Infrastructure

Docker Engine with Docker Compose plugin
UFW Firewall with sensible defaults
Fail2Ban for brute-force protection
Deploy User with sudo and Docker access

Databases & Cache

PostgreSQL with backups
MySQL/MariaDB with backups
Redis with persistence
SQL Server (optional)

Application Delivery

Generic App Template with Docker
Environment-aware Deploy Scripts
Health Checks & Rollback support
Migration Hooks
CI/CD-ready layout

Security

SSH Hardening templates
WAF with ModSecurity + OWASP CRS
Fail2Ban jail templates
Security Audit scripts
Port Review helpers

Monitoring

Netdata for real-time monitoring
Uptime Kuma for uptime tracking
Prometheus + Grafana stack
SSL Expiration monitoring
Disk & Container checks

Platform Tools

vps-cli - Central CLI tool
Service Registry - Track deployed services
Config Validation - Check configuration
Backup Verification - Verify backup integrity

🚀 Quick Start

Prerequisites

Ubuntu 24.04 LTS (or 22.04 LTS)
Fresh VPS or VM
Root or sudo access
Git

One-Line Install

git clone https://github.com/yourusername/vps-starter-kit.git
cd vps-starter-kit
chmod +x install.sh vps-cli
sudo ./install.sh

Custom Installation

sudo BOOTSTRAP_USER=deployer \
     VPS_ROOT=/opt/vps \
     INSTALL_NPM=yes \
     AUTO_START_NPM=yes \
     ENABLE_UFW=yes \
     ENABLE_FAIL2BAN=yes \
     TZ_VALUE=Asia/Ho_Chi_Minh \
     ./install.sh

After Installation

# Login as deploy user
sudo su - deployer

# Check platform status
cd /opt/vps && ./vps-cli status

# Start services
cd /opt/vps/vps-infra/nginx-proxy-manager && docker compose up -d

# Access Nginx Proxy Manager
# URL: http://your-vps-ip:81
# Default: admin@example.com / changeme

🏗️ Architecture

┌─────────────────────────────────────────────────────────────────────┐
│                         VPS STARTER KIT                              │
├─────────────────────────────────────────────────────────────────────┤
│                                                                      │
│  ┌──────────────────────────────────────────────────────────────┐  │
│  │                     SECURITY LAYER                            │  │
│  │  ┌─────────┐  ┌─────────┐  ┌─────────┐  ┌─────────┐       │  │
│  │  │   WAF   │  │Fail2Ban│  │   SSH   │  │  Audit  │       │  │
│  │  │ModSec   │  │        │  │Hardening│  │         │       │  │
│  │  └─────────┘  └─────────┘  └─────────┘  └─────────┘       │  │
│  └──────────────────────────────────────────────────────────────┘  │
│                                                                      │
│  ┌──────────────────────────────────────────────────────────────┐  │
│  │                    INFRASTRUCTURE LAYER                      │  │
│  │  ┌─────────┐  ┌─────────┐  ┌─────────┐  ┌─────────┐       │  │
│  │  │   NPM   │  │  Nginx  │  │  Redis  │  │ Network │       │  │
│  │  │ Proxy   │  │  Proxy  │  │  Cache  │  │ Segments│       │  │
│  │  └─────────┘  └─────────┘  └─────────┘  └─────────┘       │  │
│  └──────────────────────────────────────────────────────────────┘  │
│                                                                      │
│  ┌──────────────────────────────────────────────────────────────┐  │
│  │                      DATA LAYER                              │  │
│  │  ┌─────────┐  ┌─────────┐  ┌─────────┐  ┌─────────┐       │  │
│  │  │Postgres │  │  MySQL  │  │  Redis  │  │Backups  │       │  │
│  │  └─────────┘  └─────────┘  └─────────┘  └─────────┘       │  │
│  └──────────────────────────────────────────────────────────────┘  │
│                                                                      │
│  ┌──────────────────────────────────────────────────────────────┐  │
│  │                   MONITORING LAYER                            │  │
│  │  ┌─────────┐  ┌─────────┐  ┌─────────┐  ┌─────────┐       │  │
│  │  │Netdata  │  │Prometheus│ │ Grafana │  │  Uptime │       │  │
│  │  │         │  │         │  │         │  │  Kuma   │       │  │
│  │  └─────────┘  └─────────┘  └─────────┘  └─────────┘       │  │
│  └──────────────────────────────────────────────────────────────┘  │
│                                                                      │
│  ┌──────────────────────────────────────────────────────────────┐  │
│  │                     PLATFORM LAYER                            │  │
│  │  ┌─────────┐  ┌─────────┐  ┌─────────┐  ┌─────────┐       │  │
│  │  │vps-cli  │  │Registry │  │ Deploy  │  │ Secrets │       │  │
│  │  │         │  │         │  │ Scripts │  │         │       │  │
│  │  └─────────┘  └─────────┘  └─────────┘  └─────────┘       │  │
│  └──────────────────────────────────────────────────────────────┘  │
│                                                                      │
└─────────────────────────────────────────────────────────────────────┘

📦 Platform Components

Core Directories

Directory	Description
`vps-app/`	Generic application template
`vps-db/`	Database containers (PostgreSQL, MySQL, Redis)
`vps-infra/`	Infrastructure (Nginx Proxy Manager, shared scripts)
`vps-monitoring/`	Monitoring stack (Netdata, Prometheus, Grafana)
`vps-security/`	Security hardening (WAF, Fail2Ban, SSH)
`vps-secrets/`	Secrets management templates
`vps-alerting/`	Alert configurations
`vps-platform/`	Platform automation scripts
`vps-vpn/`	WireGuard VPN server
`plugins/`	Optional plugins (MinIO, Kafka, Elasticsearch)
`docs/`	Documentation
`config/`	Platform configuration

Service Ports

Service	Port	Description
HTTP	80	HTTP traffic
HTTPS	443	HTTPS traffic
NPM Admin	81	Nginx Proxy Manager UI
WireGuard	51820	VPN
WireGuard UI	51821	VPN Web UI

📚 Documentation

Getting Started

Security

Databases

Monitoring

Operations

VPN

💻 CLI Reference

vps-cli Commands

# Status & Info
./vps-cli status              # Show platform status
./vps-cli show-config         # Display configuration
./vps-cli validate-config     # Validate config files
./vps-cli list-services       # List all services

# Health Checks
./vps-cli check-containers    # Check container health
./vps-cli check-disk          # Check disk usage
./vps-cli check-endpoints     # Check HTTP endpoints
./vps-cli check-ssl           # Check SSL expiration

# Backup & Recovery
./vps-cli backup-all          # Run all backups
./vps-cli verify-backups      # Verify backup integrity

# Maintenance
./vps-cli cleanup             # Clean up old containers/images
./vps-cli audit-security      # Run security audit

Helper Scripts

# Application Management
/opt/vps/scripts/create-app.sh              # Create new application
/opt/vps/scripts/register-project.sh        # Register project
/opt/vps/scripts/register-service.sh        # Register service

# Database
/opt/vps/scripts/backup-db.sh               # Backup databases
/opt/vps/scripts/restore-db.sh              # Restore database

# Monitoring
/opt/vps/scripts/check-ssl.sh               # Check SSL certificates
/opt/vps/scripts/check-endpoints.sh        # Check endpoints

⚙️ Configuration

Environment Variables

Variable	Default	Description
`BOOTSTRAP_USER`	`deployer`	Deploy user name
`VPS_ROOT`	`/opt/vps`	Platform root directory
`INSTALL_NPM`	`yes`	Install Nginx Proxy Manager
`AUTO_START_NPM`	`yes`	Start NPM after install
`ENABLE_UFW`	`yes`	Enable UFW firewall
`ENABLE_FAIL2BAN`	`yes`	Enable Fail2Ban
`TZ_VALUE`	`UTC`	Timezone
`PROXY_NETWORK`	`proxy_network`	Docker proxy network
`DB_NETWORK`	`db_network`	Docker database network

Platform Configuration

# Edit platform config
nano /opt/vps/config/platform.yml

# View current config
./vps-cli show-config

🔧 Usage Examples

Deploy New Application

# 1. Create application from template
cd /opt/vps
./scripts/create-app.sh --name myapp --path /opt/myapp

# 2. Configure environment
cd /opt/myapp
cp .env.production.example .env
nano .env

# 3. Deploy
./scripts/deploy.sh --env production --backup

# 4. Access via Nginx Proxy Manager
# Add proxy host pointing to myapp:3000

Database Backup

# Backup all databases
cd /opt/vps
./scripts/backup-db.sh all

# Backup specific database
./scripts/backup-db.sh postgres

# List backups
ls -la /opt/vps/backups/

SSL Certificate Check

# Check all SSL certificates
./vps-cli check-ssl

# Check specific domain
./vps-cli check-ssl example.com

🛡️ Security Notes

After Installation

Change default passwords for Nginx Proxy Manager
Configure SSH keys for deploy user
Review firewall rules with ufw status
Set up Fail2Ban notifications
Enable SSL for all services
Review security audit with ./vps-cli audit-security

Best Practices

Use strong passwords and SSH keys
Enable 2FA where possible
Regularly update system packages
Monitor logs for suspicious activity
Test backup restoration procedures

📊 Repository Structure

vps-starter-kit/
├── install.sh                      # Bootstrap script
├── vps-cli                         # CLI tool
├── README.md                       # This file
├── CHANGELOG.md                    # Version history
├── config/
│   ├── platform.yml               # Platform config
│   └── README.md
├── vps-app/
│   └── app-template/              # App template
├── vps-db/
│   ├── postgres/
│   ├── mysql/
│   ├── redis/
│   └── sqlserver/
├── vps-infra/
│   ├── nginx-proxy-manager/
│   └── shared/
│       └── scripts/
├── vps-monitoring/
│   ├── netdata/
│   ├── prometheus-grafana/
│   └── uptime-kuma/
├── vps-security/
│   ├── ssh/
│   ├── fail2ban/
│   ├── waf/
│   └── audit/
├── vps-secrets/
│   └── scripts/
├── vps-alerting/
├── vps-platform/
│   ├── scripts/
│   └── registry/
├── vps-vpn/
│   └── wireguard/
├── plugins/
│   ├── minio/
│   ├── kafka/
│   └── elasticsearch/
└── docs/
    ├── OPERATIONS.md
    ├── SECURITY.md
    ├── BACKUP_AND_RESTORE.md
    ├── DISASTER_RECOVERY.md
    ├── MONITORING.md
    └── CICD_V3.md

🤝 Contributing

Contributions are welcome! Please feel free to submit a Pull Request.

Fork the repository
Create a feature branch (git checkout -b feature/amazing-feature)
Commit your changes (git commit -m 'Add amazing feature')
Push to the branch (git push origin feature/amazing-feature)
Open a Pull Request

📄 License

This project is licensed under the MIT License - see the LICENSE file for details.

🙏 Acknowledgments

Docker and the Docker Compose community
Nginx Proxy Manager team
OWASP for the Core Rule Set
All contributors and maintainers

Made with ❤️ for the self-hosted community

Name		Name	Last commit message	Last commit date
Latest commit History 18 Commits
.github/workflows		.github/workflows
config		config
docs		docs
plugins		plugins
vps-alerting		vps-alerting
vps-app		vps-app
vps-backup		vps-backup
vps-db		vps-db
vps-infra		vps-infra
vps-k8s		vps-k8s
vps-monitoring		vps-monitoring
vps-platform		vps-platform
vps-secrets		vps-secrets
vps-security		vps-security
vps-vpn		vps-vpn
.gitignore		.gitignore
CHANGELOG.md		CHANGELOG.md
README.md		README.md
VERSION		VERSION
install.sh		install.sh
vps-cli		vps-cli

Folders and files

Latest commit

History

Repository files navigation

🚀 VPS Starter Kit

📋 Table of Contents

✨ Features

Infrastructure

Databases & Cache

Application Delivery

Security

Monitoring

Platform Tools

🚀 Quick Start

Prerequisites

One-Line Install

Custom Installation

After Installation

🏗️ Architecture

📦 Platform Components

Core Directories

Service Ports

📚 Documentation

Getting Started

Security

Databases

Monitoring

Operations

VPN

💻 CLI Reference

vps-cli Commands

Helper Scripts

⚙️ Configuration

Environment Variables

Platform Configuration

🔧 Usage Examples

Deploy New Application

Database Backup

SSL Certificate Check

🛡️ Security Notes

After Installation

Best Practices

📊 Repository Structure

🤝 Contributing

📄 License

🙏 Acknowledgments

About

Topics

Resources

Security policy

Uh oh!

Stars

Watchers

Forks

Releases 11

Packages 0

Uh oh!

Contributors

Uh oh!

Languages

Packages