ZeroOps

ZeroOps is a simple CLI tool to deploy applications to your VPS using Docker Compose. It helps you manage deployment contexts, render docker-compose templates with environment variables, and automate remote deployments.

Features

• Manage multiple VPS deployment contexts
• Render and upload docker-compose files with environment variables
• Deploy, check status, list, and remove applications on your VPS
• Manage nginx proxy configurations remotely

Prerequisites

• Docker and Docker Compose installed on your VPS
• SSH access to your VPS
• scp and ssh available on your local machine
• Nginx installed on your VPS (for proxy management)

MacOS/Linus Installation

You can install ZeroOps using the provided install script:

curl -sL https://raw.githubusercontent.com/DominikPalatynski/zeroops/main/install.sh | bash

This will download the latest release and install it to ~/.local/bin/zeroops. Make sure ~/.local/bin is in your PATH.

Windows Installation

1. Go to the Releases page and download the latest zeroops_<version>_windows_amd64.zip (or arm64.zip if needed).
2. Extract the zeroops.exe file.
3. Add the folder containing zeroops.exe to your system PATH.
4. You can now use zeroops from Command Prompt or PowerShell.

Usage

1. Configure a VPS Context

A context defines the VPS you want to deploy to.

Add a new context:

zeroops context add my-vps --docker "host=ssh://user@your-vps-ip"

List available contexts:

zeroops context list

Set the current context:

zeroops context use --name my-vps

Show the current context:

zeroops context current

Remove a context:

zeroops context rm --name my-vps

2. Prepare Your Environment

Create a .env file in your project directory with the required environment variables. For example:

RESEND_API_KEY=your_api_key_here

The variables in .env will be injected into docker-compose.tpl.yml.

3. Prepare Your Docker Compose Template

Edit docker-compose.tpl.yml to define your services. Example:

version: "3"
services:
  nextjs:
    image: <your-image>
    ports:
      - "3004:3000"
    environment:
      - RESEND_API_KEY={{ .RESEND_API_KEY }}

4. Deploy an Application

Deploy your app to the current context:

zeroops deploy add my-app

You can specify custom paths for environment and template files:

zeroops deploy add --env_file prod.env --template docker-compose.prod.yml my-app

By default:

• Environment file: .env in current directory
• Template file: docker-compose.tpl.yml in current directory

The deployment process will:

• Render the template file with your environment values
• Upload the rendered docker-compose.yml and environment file to your VPS
• Run docker compose up --build -d remotely

5. Manage Deployments

Check status of a deployed app:

zeroops deploy status my-app

List all deployed apps:

zeroops deploy list

Remove an app (stops containers and removes files):

zeroops deploy rm my-app

6. Manage Nginx Proxy Configurations

ZeroOps allows you to manage nginx proxy configurations on your VPS directly from your local machine.

Add a new nginx configuration:

zeroops proxy add --conf nginx.conf my-app

This will:

• Copy your local nginx configuration to the VPS
• Install it in /etc/nginx/sites-enabled/
• Reload nginx to apply changes

View an existing configuration:

zeroops proxy status my-app

List all proxy configurations:

zeroops proxy list

Remove a proxy configuration:

zeroops proxy rm my-app

This will remove the configuration and reload nginx automatically.

Troubleshooting

If you see errors about sudo requiring a password for remote commands, you may need to allow passwordless sudo for your user on the VPS. You can do this by running:

sudo visudo

And adding a line like:

youruser ALL=(ALL) NOPASSWD:ALL

Replace youruser with your VPS username.