Public site · installer and docs

VPS Deployer

Documentation

Guides for the VPS installation. The local dashboard at 127.0.0.1:5100 is a different system from this website.

Start

Getting started

Install VPS Deployer on your VPS and open the local dashboard.

Requirements

Operating systems and hardware for a VPS Deployer installation.

First project

Add, deploy, and publish an application on this VPS.

Operate

GitHub

Store a GitHub App on your VPS and queue deploys from webhooks.

Projects

Create, import, inspect and manage applications on this VPS.

Deployments

How a release is fetched, built, health-checked, and activated.

Domains

Attach hostnames on this VPS and write nginx site files.

HTTPS

Use Let's Encrypt or existing certificates, including Cloudflare Origin CA.

Nginx

How site files are written, tested, and reloaded.

Rollback

Restore the previous healthy release on this VPS.

Logs

Read deployment logs and application process logs on this VPS.

Reference

CLI

Commands for this VPS Deployer installation.

API

Localhost JSON API and HTML dashboard.

Security

Localhost API, a whitelist helper, and no telemetry.

Updating

Update VPS Deployer on this VPS.

This website distributes the installer and documentation. It does not register your VPS, store credentials, or run deployments.

After install, your VPS keeps working if this site is down. Changelog