Skip to content

Centralized repository of containers designed for Toolbox/Distrobox

License

Notifications You must be signed in to change notification settings

kitten-lily/toolboxes

 
 

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

Repository files navigation

toolboxes

Centralized repository of containers designed for Toolbox/Distrobox with batteries included. These toolboxes strive for:

  • Instant launch
  • Include quadlets and systemd service units for management
  • Intended to be used as general purpose toolboxes for "daily driver" usage
  • Can be used with boxkit as base images to manage your own custom setup

Images

  • ubuntu-toolbox - an Ubuntu base image
  • fedora-toolbox - a Fedora base image
  • wolfi-toolbox - a WolfiOS base image
  • bluefin-cli - a WolfiOS based image with Homebrew and a strongly opinionated default experience
  • powershell-toolbox - a WolfiOS based image with PowerShell and other Microsoft related tooling
  • docker-distrobox - an Ubuntu distrobox with Docker-CE. It will export the docker socket to the host.
  • incus-distrobox - an Ubuntu distrobox with Incus packages from Zabbly.

It is strongly recommended that the Ptyxis terminal be used with these toolboxes and is the default experience in both Bazzite and Bluefin.

Automatic Toolbox Startup

Quadlets

Podman supports starting containers via a systemd generator. Quadlets replaced the podman generate systemd command and provide a method to create a systemd service for managing your container. The generated unit file can automatically start your container on login, automatically check for updates from the registry, and automatically clean-up the container and any transient volumes when the container stops. This provides an ideal way to have a clean slate on each login.

Inside the quadlets directory are example quadlets each of the toolboxes listed above. Distrobox and Toolbox provide a convenient way to integrate the containers into your host.ubuntu-toolbox and fedora-toolbox can use either toolbox or distrobox. wolfi-toolbox, bluefin-cli and powershell-toolbox (WolfiOS base) are currently only compatible with distrobox.

The quadlets mimic the create and enter commands to setup the container. You can use these by copying them to ~/.config/containers/systemd. When using the Prompt terminal, they will appear in the menu as available containers. The Exec= line of the distrobox quadlets can be modified to include additional packages.

To get automatic updates you will need to enable podman-auto-update.timer which by default will auto-update at midnight. Quadlets support creating volumes using a .volume unit. These volumes can be accessed by other containers by prepending the name of .volume with systemd.

Systemd one-shots

An alternative method for having automatic toolbox startup is to leverage systemd one-shot services and distrobox assemble commands.

Distrobox assemble enables the user to declare a setup without going through the process of creating a customized image. Instead, an ini style file can be used with distrobox-assemble and distrobox-enter to setup and enter a modified container. Example assemble files are available here and on the universal-blue discourse.

To utilize these, place the user service file in ~/.config/systemd/user and make sure the assemble file is in place. The ones inside the repo are set to replace the existing container of the same to behave similar to the quadlet. Again you can access .volume by using the name of the volume unit prepended with systemd.

Bluefin-CLI

bluefin-cli is built from wolfi-toolbox. It contains Homebrew configured out of the box. The brew state is bind mounted to a directory from your $HOME. Unlike the other toolboxes, bluefin-cli is intended for CLI applications only.

Its primary purpose is to be the command line companion to Flathub-enabled systems by providing access to one of the largest command line repositories in the world via homebrew. Developer dependencies should be managed seperately via devcontainers.

The default configuration destroys and updates this container daily so that the toolbox is built from scratch.

Updates to brew itself happen automatically when the container rebuilds. Brew will automatically upgrade packages as you use it. Brew's state is also volume mounted to a file in your home directory so your container is fresh but your packages remain untouched. At this time it is strongly recommended to maintain a backup of your brew package list via the brew bundle subcommand.

The WolfiOS apk package manager is preferred for fully declarative setups with boxkit. You can file package requests on the WolfiOS repository for packages that you may need. We are working on a way to do this locally as well.

The intended endstate of bluefin-cli is a fully automated declarative config managed via git using Wolfi packages for clean rebuilds daily. brew is used to fill out the "long tail" of existing software.

Both bluefin-cli and wolfi-toolbox have Wolfi developer variants built from the Wolfi SDK image, intended for Wolfi package and image development. They include utilities such as melange, wolfictl, and apko. These images are labelled bluefin-dx-cli and wolfi-dx-toolbox.

PowerShell-Toolbox

powershell-toolbox is based on WolfiOS. Its primary purpose is to be a dedicated container for Microsoft related technologies used during development. It contains PowerShell, Azure CLI and .NET (latest LTS) configured out of the box. It also includes a small selection of other useful CLI utilities to improve the overall experience.

Incus and Docker Distrobox

Both incus-distrobox and docker-distrobox are designed to be run with a rootful, init distrobox. Incus uses packages built by Zabbly. Docker uses the convience install script from Docker. Both are built from the ubuntu-toolbox built in this repo. Example distrobox-assemble files are with each of them. Both work well with a volume mount for their respective files in /var/lib/{docker,incus}. Both can be setup to autostart on boot with a systemd service. However, your user sockets for Xorg, Wayland, and Pulseaudio will not be setup until you login. For the docker-distrobox you can customize the group of the exported docker socket by setting an environment variable at distrobox creation time for DOCKERGROUP. The assemble file has more information. Both the incus-distrobox and docker-distrobox set the unix-groups. For incus, matching incus-admin inside the distrobox and on the host will enable you to use the incus socket from the host.

Stats

Star History

Alt

Star History Chart

About

Centralized repository of containers designed for Toolbox/Distrobox

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

 
 
 

Languages

  • Shell 77.7%
  • PowerShell 22.3%