2021-11-12 16:44:13 +00:00
|
|
|
![README](data/gfx/README.gif)
|
2018-09-13 12:17:34 +00:00
|
|
|
|
2020-10-22 15:27:04 +00:00
|
|
|
[![Zuul](https://zuul-ci.org/gated.svg)](https://softwarefactory-project.io/zuul/t/local/builds?project=containers/toolbox)
|
2021-02-10 13:35:05 +00:00
|
|
|
[![Daily Pipeline](https://softwarefactory-project.io/zuul/api/tenant/local/badge?project=containers/toolbox&pipeline=periodic)](https://softwarefactory-project.io/zuul/t/local/builds?project=containers%2Ftoolbox&pipeline=periodic)
|
2020-10-22 15:27:04 +00:00
|
|
|
|
|
|
|
[![Arch Linux package](https://img.shields.io/archlinux/v/community/x86_64/toolbox)](https://www.archlinux.org/packages/community/x86_64/toolbox/)
|
|
|
|
[![Fedora package](https://img.shields.io/fedora/v/toolbox/rawhide)](https://src.fedoraproject.org/rpms/toolbox/)
|
|
|
|
|
2022-11-29 14:32:52 +00:00
|
|
|
[Toolbox](https://containertoolbx.org/) is a tool for Linux, which allows the
|
|
|
|
use of interactive command line environments for development and
|
|
|
|
troubleshooting the host operating system, without having to install software
|
|
|
|
on the host. It is built on top of [Podman](https://podman.io/) and other
|
|
|
|
standard container technologies from [OCI](https://opencontainers.org/).
|
|
|
|
|
|
|
|
Toolbox environments have seamless access to the user's home directory,
|
|
|
|
the Wayland and X11 sockets, networking (including Avahi), removable devices
|
|
|
|
(like USB sticks), systemd journal, SSH agent, D-Bus, ulimits, /dev and the
|
|
|
|
udev database, etc..
|
2019-01-26 09:57:26 +00:00
|
|
|
|
|
|
|
This is particularly useful on
|
2019-10-14 10:49:29 +00:00
|
|
|
[OSTree](https://ostree.readthedocs.io/en/latest/) based operating systems like
|
2020-10-15 14:48:41 +00:00
|
|
|
[Fedora CoreOS](https://coreos.fedoraproject.org/) and
|
2021-01-25 20:42:39 +00:00
|
|
|
[Silverblue](https://silverblue.fedoraproject.org/). The intention of these
|
2019-01-26 09:57:26 +00:00
|
|
|
systems is to discourage installation of software on the host, and instead
|
2021-01-25 20:42:39 +00:00
|
|
|
install software as (or in) containers — they mostly don't even have package
|
|
|
|
managers like DNF or YUM. This makes it difficult to set up a development
|
2022-11-29 15:54:32 +00:00
|
|
|
environment or troubleshoot the operating system in the usual way.
|
2021-01-25 20:42:39 +00:00
|
|
|
|
|
|
|
Toolbox solves this problem by providing a fully mutable container within
|
2022-11-29 15:54:32 +00:00
|
|
|
which one can install their favourite development and troubleshooting tools,
|
|
|
|
editors and SDKs. For example, it's possible to do `yum install ansible`
|
|
|
|
without affecting the base operating system.
|
2019-01-26 09:57:26 +00:00
|
|
|
|
2021-01-25 20:42:39 +00:00
|
|
|
However, this tool doesn't *require* using an OSTree based system. It works
|
|
|
|
equally well on Fedora Workstation and Server, and that's a useful way to
|
|
|
|
incrementally adopt containerization.
|
2018-09-13 12:17:34 +00:00
|
|
|
|
2019-02-19 14:16:28 +00:00
|
|
|
The toolbox environment is based on an [OCI](https://www.opencontainers.org/)
|
2019-05-10 18:38:46 +00:00
|
|
|
image. On Fedora this is the `fedora-toolbox` image. This image is used to
|
2022-11-29 14:32:52 +00:00
|
|
|
create a toolbox container that offers the interactive command line
|
|
|
|
environment.
|
|
|
|
|
|
|
|
Note that Toolbox makes no promise about security beyond what's already
|
|
|
|
available in the usual command line environment on the host that everybody is
|
|
|
|
familiar with.
|
2021-06-26 09:07:24 +00:00
|
|
|
|
2018-08-31 16:02:49 +00:00
|
|
|
|
2021-12-08 14:54:07 +00:00
|
|
|
## Installation & Use
|
2021-01-25 19:19:48 +00:00
|
|
|
|
2021-12-08 14:54:07 +00:00
|
|
|
See our guides on
|
|
|
|
[installing & getting started](https://containertoolbx.org/install/) with
|
|
|
|
Toolbox and [Linux distro support](https://containertoolbx.org/distros/).
|