Blame README.md

47193f4
# Toolbox — Unprivileged development environment
b2678e8
47193f4
[Toolbox](https://github.com/debarshiray/toolbox) is a tool that offers a
47193f4
familiar RPM based environment for developing and debugging software that runs
47193f4
fully unprivileged using [Podman](https://podman.io/).
b2678e8
47193f4
The toolbox container is a fully *mutable* container; when you see
47193f4
`yum install ansible` for example, that's something you can do inside your
47193f4
toolbox container, without affecting the base operating system.
47193f4
47193f4
This is particularly useful on
47193f4
[OSTree](https://ostree.readthedocs.io/en/latest/) based Fedora systems like
47193f4
[Silverblue](https://silverblue.fedoraproject.org/).  The intention of these
47193f4
systems is to discourage installation of software on the host, and instead
47193f4
install software as (or in) containers.
47193f4
a427cd4
However, this tool doesn't *require* using an OSTree based system — it
47193f4
works equally well if you're running e.g. existing Fedora Workstation or
47193f4
Server, and that's a useful way to incrementally adopt containerization.
b2678e8
47193f4
The toolbox environment is based on an [OCI](https://www.opencontainers.org/)
47193f4
image. On Fedora this is the `fedora-toolbox` image. This image is then
47193f4
customized for the current user to create a toolbox container that seamlessly
47193f4
integrates with the rest of the operating system.
47193f4
47193f4
## Usage
47193f4
47193f4
### Create your toolbox container:
b2678e8
```
47193f4
[user@hostname ~]$ toolbox create
47193f4
[user@hostname ~]$
b2678e8
```
b2678e8
This will create a container, and an image, called
47193f4
`fedora-toolbox-<your-username>:<version-id>` that's specifically customised
47193f4
for your host user.
b2678e8
47193f4
### Enter the toolbox:
b2678e8
```
47193f4
[user@hostname ~]$ toolbox enter
b2678e8
🔹[user@toolbox ~]$
b2678e8
```