Running Boxes

A box must be run on a machine and inside a sandbox.

Get a box token

Running a box requires that the box can authenticate itself to the Dboxed control plane. Box tokens are used for this. First, create a box token via the CLI or the dashboard. To use the CLI, run:

dboxed token create --name=<token-name> --box=<box-name>

Copy the token secret so that you can use later.

As an alternative, use the dashboard to create the token. Either do this through the tokens page or after entering the box details page and clicking on Generate CLI Command inside the Run tab.

Manually running a box

First, use SSH to connect to the machine you want to run the box on. Then install the Dboxed CLI on the machine. Now run:

dboxed sandbox run <box-name> --api-token <box-token>

This will create a sandbox and run the box inside the sandbox.

Managing the sandbox

When a box has been created and started on a machine, the resulting sandbox can be controlled via the dboxed sandbox sub-commands. Look into the output of dboxed sandbox --help for details.

As an example, you can run this to stop the sandbox:

dboded sandbox stop <box-name>

Or this to remove it:

dboxed sandbox rm <box-name>