Managing Boxes

Boxes can be managed via the CLI or the dashboard.

Creating a box

To create a box via the CLI, run:


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

The --name flag is required. The --network flag is optional and allows you to attach the box to a network.

A box defines its workloads via docker-compose projects.

The above command will create an empty box without any compose projects. You can add compose projects afterward by running:


dboxed box add-compose <box-name> -f <compose-file>

This will add the compose project, with the name of the project extracted from the compose file itself.

To update an existing compose project, use the following command:


dboxed box update-compose <box-name> <compose-name> -f <compose-file>

The compose-file must contain a project with a project name that matches the previously used name. Renaming a compose project is not supported.

Removing of a compose project can be done via:


dboxed box rm-compose <box-name> <compose-name>

The <compose-name> must match the name given to the compose project at time of adding the project.

Volumes can be attached to boxes, so that they can be used inside compose projects. See Using Volumes for details.

A box can expose services via Load Balancers by using Load Balancer Services. See Using Load Balancers for details.