Skip to content
All guides

ship

Pack and launch

Pack

From the project directory:

buraaq pack

Writes target/ship/<app>.bur. public/, cert.pem, and key.pem in the project root are packed when present.

The .bur includes:

  • bin/<exe>: release native binary
  • public/**: if present
  • cert.pem / key.pem: if present
  • buraaq.pkg

Every byte before the trailing digest is SHA-256 hashed. Tamper → refuse to launch. Max bundle size: 512 MiB.

Local launch

buraaq up

Packs, starts Dock if needed, and runs the ship.

Or step by step:

buraaq ship

Same as buraaq pack then buraaq launch target/ship/<app>.bur. Extract cwd is under %USERPROFILE%\.buraaq\run\ (or ~/.buraaq/run/ on Unix). Set BURAAQ_DATABASE_URL in this shell if the app needs Postgres.

buraaq launch .\target\ship\webapi.bur

Same OS as the host

Pack on Windows for a Windows dock. Pack on Linux for a Linux dock. A Windows .bur will not run on Linux.

Where files live

PathRole
target/ship/<app>.burPacked ship
~/.buraaq/run/<app>/<digest>/Local launch extract
~/.buraaq/dock/live/<app>/Dock extract + app.pid + app.log

On Windows, ~ is %USERPROFILE%.

Next: Dock.