wbrawner/toolbox
1
0
Fork 0
Code Issues Pull requests Projects Releases Packages Wiki Activity Actions
Tool for interactive command line environments on Linux
924 commits 1 branch 0 tags 9.2 MiB
Shell 54.9%
Go 36.1%
Dockerfile 5.8%
Meson 1.9%
Python 0.7%
Other 0.6%
Find a file
Debarshi Ray b85ab0a4f1 cmd/initContainer, cmd/run: Restore hints about unreachable code 
In the past, before commit d323143c46, there was either had a
dummy 'return' statement or a self-documenting 'panic' that said that
the code should not be reached.  Since neither golangci-lint nor
'go vet' likes those, a comment is the only option left.

Note that the core Go tools like 'go vet' [1], but also 'go lint' [2],
explicitly don't intend to add fine-grained configuration options,
including inline directives or pragmas, to silence specific warnings.
That's something golangci-lint offers [3], to the extent that it's
supported by its linters [4].  However, golangci-lint also uses 'go vet'
as one of those linters, so it's the same problem all over again.

Therefore, between the two extremes of leaving the code difficult to
read and using a very big hammer to disable a needlessly big chuck of
'go vet', a comment is the least worst option.

[1] https://github.com/golang/go/issues/17058
    https://github.com/golang/go/issues/18432

[2] https://github.com/golang/lint/issues/263

[3] https://golangci-lint.run/usage/false-positives/

[4] https://golangci-lint.run/usage/linters/

Fallout from d323143c46

https://github.com/containers/toolbox/pull/1185
2022-12-01 18:24:15 +01:00
.github Revert "ci: Build & Publish Fedora Toolbx images with GitHub Packages" 2022-03-20 21:11:32 +02:00
completion build: Enable changing the completion paths & drop install_completions 2022-10-21 16:42:29 +02:00
data build: Replace join_paths with the / operator 2022-10-21 17:24:03 +02:00
doc Fix spelling mistakes using codespell 2022-11-17 11:56:58 +01:00
images Add corrections to avoid duplicate packages 2022-10-20 07:15:34 -04:00
playbooks .zuul, playbooks: Add copyright and license notices 2022-11-28 22:47:15 +01:00
profile.d profile.d: Restore compatibility with Z shell 2022-11-25 18:36:31 +01:00
src cmd/initContainer, cmd/run: Restore hints about unreachable code 2022-12-01 18:24:15 +01:00
test/system test/system: Add copyright and license notices 2022-11-29 13:54:13 +01:00
.codespellexcludefile build, playbooks: Add a test that runs codespell 2022-11-19 15:32:13 +01:00
.gitignore test/system: Track bats libs as submodules & install them better 2021-07-22 10:23:53 +02:00
.gitmodules test/system: Track bats libs as submodules & install them better 2021-07-22 10:23:53 +02:00
.mailmap .mailmap: Canonicalize my email 2022-08-01 18:37:43 +02:00
.zuul.yaml .zuul, playbooks: Add copyright and license notices 2022-11-28 22:47:15 +01:00
CODE-OF-CONDUCT.md Add Code of Conduct 2020-02-12 17:12:23 +01:00
CONTRIBUTING.md Fix spelling mistakes using codespell 2022-11-17 11:56:58 +01:00
COPYING Rename LICENSE as COPYING 2018-10-19 18:24:23 +02:00
gen-docs-list Update copyright notices 2022-11-28 21:01:18 +01:00
GOALS.md GOALS.md: Cosmetics 2021-01-25 21:13:07 +01:00
meson.build build, playbooks: Add a test that runs codespell 2022-11-19 15:32:13 +01:00
meson_options.txt build: Enable changing the completion paths & drop install_completions 2022-10-21 16:42:29 +02:00
meson_post_install.py build: Skip a needless failure when running systemd-tmpfiles as non-root 2022-10-21 16:45:37 +02:00
NEWS Update copyright notices 2022-11-28 21:01:18 +01:00
README.md README.md: Clarify that Toolbx isn't a security mechanism 2022-11-29 17:46:34 +01:00
SECURITY.md Add Security Policy 2020-05-13 14:37:08 +02:00
toolbox Link to the installation guide from the shell Toolbox 2022-08-29 22:09:15 +02:00

README.md

README

Zuul Daily Pipeline

Arch Linux package Fedora package

Toolbox 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 and other standard container technologies from OCI.

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

This is particularly useful on OSTree based operating systems like Fedora CoreOS and Silverblue. The intention of these systems is to discourage installation of software on the host, and instead 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 environment or troubleshoot the operating system in the usual way.

Toolbox solves this problem by providing a fully mutable container within 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.

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.

The toolbox environment is based on an OCI image. On Fedora this is the fedora-toolbox image. This image is used to 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.

Installation & Use

See our guides on installing & getting started with Toolbox and Linux distro support.