Keyboard shortcuts

Press or to navigate between chapters

Press S or / to search in the book

Press ? to show this help

Press Esc to hide this help

Deploy

Mental model

install atlantus binary → copy your app → migrate → start (+ optional worker)

No Rust toolchain on the server for app deploy.

1. Install the CLI on the server

Same as Install — download the release binary onto the VPS:

# example: linux x86_64 asset from GitHub Releases v0.2.1
sudo install -m 0755 ./atlantus-v0.2.1-linux-x86_64 /usr/local/bin/atlantus
atlantus --version

2. Copy your app

# from your machine — your project, not the framework source
rsync -a ./my-api/ user@server:/opt/my-api/

3. Environment

export ATL_ENV=production
export ATL_AUTH_SECRET='…'          # if using auth
export ATL_DATABASE_URL='postgres://…'
export ATL_CORS_ORIGINS='https://app.example.com'

4. Migrate & start

cd /opt/my-api
atlantus db migrate --path .
atlantus start --path . --host 0.0.0.0 --port 3000

Optional worker:

atlantus job work --path .    # if available in your version

Put Nginx/Caddy in front for TLS.

systemd sketch

[Unit]
Description=Atlantus app
After=network.target

[Service]
Type=simple
WorkingDirectory=/opt/my-api
Environment=ATL_ENV=production
Environment=ATL_AUTH_SECRET=change-me
Environment=ATL_DATABASE_URL=postgres://…
ExecStart=/usr/local/bin/atlantus start --path /opt/my-api --host 0.0.0.0 --port 3000
Restart=on-failure

[Install]
WantedBy=multi-user.target

Health

curl -fsS http://127.0.0.1:3000/health
curl -fsS http://127.0.0.1:3000/ready

Docker

If your team ships a container image that already contains atlantus, deploy that image and mount/copy the app directory. You still do not need Rust on the host — only the image build pipeline (CI) compiles the runtime.

Next: Examples.