toolbox/doc/toolbox-create.1.md

83 lines
2.2 KiB
Markdown
Raw Normal View History

% toolbox-create(1)
## NAME
toolbox\-create - Create a new toolbox container
## SYNOPSIS
**toolbox create** [*--candidate-registry*]
[*--container NAME*]
[*--image NAME*]
[*--release RELEASE*]
## DESCRIPTION
Creates a new toolbox container. You can then use the `toolbox enter` command
to interact with the container at any point.
2019-03-05 12:55:11 +00:00
A toolbox container is an OCI container created from an OCI image. On Fedora
the base image is known as `fedora-toolbox`. If the image is not present
locally, then it is pulled from `registry.fedoraproject.org`. The base image is
locally customized for the current user to create a second image, from which
the container is finally created.
Toolbox containers and images are tagged with the version of the OS that
corresponds to the content inside them. The user-specific images and the
toolbox containers are prefixed with the name of the base image and suffixed
with the current user name.
## OPTIONS ##
The following options are understood:
**--candidate-registry**
Pull the base image from `candidate-registry.fedoraproject.org`. This is
useful for testing newly built images before they have moved to the stable
registry at `registry.fedoraproject.org`.
**--container** NAME
Assign a different NAME to the toolbox container. This is useful for creating
multiple toolbox containers from the same base image, or for entirely
customized containers from custom-built base images.
**--image** NAME
Change the NAME of the base image used to create the toolbox container. This
is useful for creating containers from custom-built base images.
**--release** RELEASE
Create a toolbox container for a different operating system RELEASE than the
host.
## EXAMPLES
### Create a toolbox container using the default image matching the host OS
```
$ toolbox create
```
### Create a toolbox container using the default image for Fedora 30
```
$ toolbox create --release f30
```
### Create a custom toolbox container from a custom image
```
$ toolbox create --container foo --image bar
```
### Create a toolbox using images from the unstable candidate registry
```
$ toolbox create --candidate-registry
```
## SEE ALSO
`buildah(1)`, `podman(1)`