self-deployment

A fly.io-inspired deploy tool for self-managed SSH servers. Build Docker images locally and deploy them to your own VPS/servers via SSH.

Installation

npm install -g self-deployment

Or install locally:

npm install self-deployment

Quick Start

1. Initialize a project:

   self-deploy init

2. Edit deploy.toml with your server configuration.

3. Build and deploy:

   self-deploy build
   self-deploy deploy

Configuration (deploy.toml)

app = "my-app"
registry = "localhost:5000"

[build]
  dockerfile = "Dockerfile"
  context = "."
  buildArgs = { NODE_ENV = "production" }

[[servers]]
  name = "prod-1"
  host = "192.168.1.10"
  port = 22
  user = "ubuntu"
  password = "your-password-here"

[[servers]]
  name = "prod-2"
  host = "192.168.1.11"
  port = 22
  user = "ubuntu"
  privateKey = "~/.ssh/id_rsa"

[deploy]
  image = "my-app:latest"
  port = 3000
  restartPolicy = "unless-stopped"
  env = { NODE_ENV = "production" }

Required Fields

• app - Application name
• [[servers]] - At least one server configuration
• [deploy] section with:
  • image - Docker image name
  • port - Port to expose

Server Options

Each server requires:

• name - Server identifier (e.g., "prod-1")
• host - IP address or hostname
• port - SSH port (default: 22)
• user - SSH username
• Either password or privateKey for authentication

Commands

self-deploy init

Creates a sample deploy.toml in the current directory.

self-deploy build

Builds the Docker image locally using the configuration in deploy.toml.

self-deploy build                    # Uses deploy.toml
self-deploy build -c custom.toml    # Custom config

self-deploy push

Pushes the built image to a Docker registry.

self-deploy push                    # Push to registry in config

self-deploy deploy

Deploys the application to all configured SSH servers.

self-deploy deploy                  # Deploy to all servers
self-deploy deploy -s prod-1       # Deploy to specific server

self-deploy status

Shows deployment status on all servers.

self-deploy status

self-deploy logs

Fetches logs from the deployed container.

self-deploy logs                   # Logs from first server
self-deploy logs -s prod-1        # Logs from specific server

self-deploy stop

Stops the running container on a server.

self-deploy stop                  # Stop on first server
self-deploy stop -s prod-1       # Stop on specific server

Docker Registry

For local development, you can run a local Docker registry:

docker run -d -p 5000:5000 --name registry registry:2

Then set registry = "localhost:5000" in your deploy.toml.

License

MIT