Skip to content

Commit

Permalink
doc/toolbox: Clarify that Toolbx isn't a security mechanism
Browse files Browse the repository at this point in the history
Using the word 'containerized' gives the false impression of heightened
security.  As if it's a mechanism to run untrusted software in a
sandboxed environment without access to the user's private data (such as
$HOME), hardware peripherals (such as cameras and microphones), etc..
That's not what Toolbx is for.

Toolbx aims to offer an interactive command line environment for
development and troubleshooting the host operating system, without
having to install software on the host.  That's all.  It makes no
promise about security beyond what's already available in the usual
command line environment on the host that everybody is familiar with.

containers#1020
  • Loading branch information
debarshiray committed Sep 26, 2024
1 parent ebf6933 commit 861cf85
Showing 1 changed file with 14 additions and 7 deletions.
21 changes: 14 additions & 7 deletions doc/toolbox.1.md
Original file line number Diff line number Diff line change
Expand Up @@ -13,9 +13,15 @@ toolbox - Tool for interactive command line environments on Linux

## DESCRIPTION

Toolbx is a tool for Linux operating systems, which allows the use of
containerized command line environments. It is built on top of Podman and
other standard container technologies from OCI.
Toolbx is a tool for Linux, which allows the use of interactive command line
environments for software development and troubleshooting the host operating
system, without having to install software on the host. It is built on top of
Podman and other standard container technologies from OCI.

Toolbx 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..

This is particularly useful on OSTree based operating systems like Fedora
CoreOS and Silverblue. The intention of these systems is to discourage
Expand All @@ -35,10 +41,11 @@ incrementally adopt containerization.

The Toolbx environment is based on an OCI image. On Fedora this is the
`fedora-toolbox` image. This image is used to create a Toolbx container that
seamlessly integrates with the rest of the operating system by providing
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..
offers the interactive command line environment.

Note that Toolbx makes no promise about security beyond what’s already
available in the usual command line environment on the host that everybody is
familiar with.

## Supported operating system distributions

Expand Down

0 comments on commit 861cf85

Please sign in to comment.