Docs menu

Operate

Exporting a project (no lock-in)

Download everything needed to run a project somewhere else: a Docker Compose file, every variable, database dumps and a machine-readable manifest.

Explain it

You can leave CLI whenever you like and take everything with you. The export is one file with your apps, settings and database copies that runs anywhere Docker Compose does.

How to do it: open a project's Settings and choose Export project. You'll get a download with a README explaining how to start it elsewhere.

You can also bring an export back into CLI later.

You can leave CLI whenever you like, and take everything with you. The export is one archive that runs anywhere Docker Compose does.

What's in it

FileWhat it is
docker-compose.ymlEvery app (built from its repository at the live commit, or its image) and every database, on one network with the same hostnames as on CLI
env/<service>.envEach service's variables, resolved, secrets included
databases/<name>.dumpThe latest snapshot of each database (taken now if there isn't one)
cli-export.jsonThe whole project described in the protocol's export format (cli-export/1)
README.mdHow to start it, and how to load each dump

Not included: custom domains and certificates (they're listed, point DNS at the new host), bucket contents, queue messages, volume files, logs and history.

Download it

In the dashboard: Project settings → Export project. From the terminal or an agent:

cli export                 # or --no-dumps
GET /v1/projects/:id/export

The archive holds secrets, so it's guarded like reading them: developers and above, API keys only with the secrets scope, your second factor if you have one, and the download is logged. Anyone on the project can see what an export would hold, without secrets, at GET /v1/projects/:id/export/manifest.

Run it elsewhere

Unpack it and follow its README: start the databases, load the dumps, then docker compose up -d. Connection URLs keep working because the hostnames match.

Bring it back

cli-export.json imports into any CLI (cli import in the unpacked folder): the services, settings, variables and cron jobs come back, and databases are created fresh for you to load the dumps into.