Docs

Quick start

Six steps from zero to a working deploy.

01
Create a master password

On first run, Optizen prints a one-time setup code to the API log and asks for it along with a new master password, so only someone with access to the machine can claim the instance. The password encrypts all credentials stored on disk. Keep it somewhere safe — there is no recovery path.

02
Add a server

Go to Servers and add a host with the SSH user, port, and key path. Use a dedicated deploy user when possible. Optizen never stores your private key — only the path.

03
Test the SSH connection

After saving, click "Test SSH". This confirms Optizen can reach the machine and pulls a telemetry snapshot. If it fails, check the key path and user permissions first.

04
Add a project

Open the server and add a project. Choose the right type (compose, image, custom, etc.), set the working directory, and write out the exact deploy commands.

05
Configure a health check

Add a health endpoint like /health or a TCP port check. This gives you a signal beyond "container is running" — Optizen polls it after every deploy.

06
Run a test deploy

Review the command preview, confirm the target, and watch the live log stream. Check the health status after it finishes. If everything is green, you are ready for production.

Example project config

name:         marketing-site
type:         compose
working_dir:  /var/www/marketing-site
env_path:     /var/www/marketing-site/.env
health:       GET /health
deploy:
  docker compose pull
  docker compose up -d