Get started with Rivetr

Introduction

What Rivetr is, how the single-binary design works, and how it compares to Coolify and Dokploy.

Quick Start

Install, create an admin, connect a repository, and deploy your first app in under ten minutes.

Installation

Requirements, the one-line installer, systemd, manual and development setup, and Ansible provisioning.

Upgrading

Update checks, applying a release, backups first, version pinning, and what to know before a downgrade.

Deployments

The clone, build, health check, and atomic switch pipeline. Previews, approvals, freeze windows, rollback, and data snapshots.

Build Types

Dockerfile, Nixpacks, Railpack, Cloud Native Buildpacks, static sites, and prebuilt images.

Webhooks

GitHub, GitLab, Gitea, Bitbucket, and Docker Hub. Signature verification, skip markers, and watch paths.

Compose Services

Docker Compose deployments with build sources, hooks, image digests, per-container terminals, and rollback.

Environment Variables

AES-256-GCM encryption, shared inheritance from team to app, and database link injection.

Domains and HTTPS

Per-domain certificates, DNS-01 wildcards, HTTP/2, preview URLs, and the embedded proxy.

Databases

Nine managed engines, app linking, extensions, live resource limits, and engine-specific notes.

Backups

Database, volume, and instance backups to local disk or S3, with retention, checksums, and tested restore.

Secret Managers

Resolve secret:// references from Vault, OpenBao, Infisical, Doppler, and AWS Secrets Manager at deploy time.

Monitoring and Logs

Live streams, search and retention, host metrics, Prometheus, traffic analytics, and log drains.

Teams and RBAC

Role presets and 24 abilities, custom roles, resource overrides, 2FA enforcement, and audit logs.

Remote Servers and Scale

SSH servers, multi-server app placements, build servers, Docker Swarm, replicas, and server maintenance.

Security

Encryption at rest, token scopes, SSH host key pinning, rate limiting, CSP, and a hardening checklist.

Configuration

Every rivetr.toml table and the important defaults, plus a minimal production example.

REST API

Authentication, scoped tokens, the endpoint catalog, streams, rate limits, and curl examples.

CLI

Remote commands, local maintenance commands, and the optional terminal UI.

MCP Server

The built-in Model Context Protocol server and its 11 tools for AI assistants.

FAQ

Footprint, production readiness, Docker vs Podman, licensing, telemetry, and migration.

Troubleshooting

Install, startup, DNS, certificates, builds, webhooks, databases, SSH, updates, and disk.

Contributing

Development setup, tests, migrations, templates, pull request checklist, and conventions.