tepene / box-bayou

Distrobox companion for ublue-bayou

box-bayou

This is my take on a Toolbox / Distrobox container based on the ideas of ublue-os/boxkit.

The goal of this project is to have a companion distrobox container for my custom ublue-bayou Fedora Silverblue setup. It's my default terminal for daily usage.

Tools

The container is based on the latest Alpine image from the Toolbx Community Images and and is spruced up with the following configuration.

Installed in the container

The following tools are shipped with the container:

• chezmoi for dotfile management
• cosign to sign OCI containers (and other artifacts) using Sigstore
• direnv to unclutter your .profile
• helix as post-modern text editor
• jq JSON command-line processor
• neofetch eye candy system information
• pipx to run python applications in isolated environments
• poetry for python venv management
• python-3 to run python applications
• starship cross-shell prompt for that <3
• yq YAML command-line processor
• zsh as the default shell

Mapped from Host OS

The following tools are symlinked from the host system:

• btop++
• flatpak
• just
• podman
• rmp-ostree

Usage

Creation

With Distrobox

distrobox create -i ghcr.io/tepene/box-bayou:latest -n box-bayou
distrobox enter box-bayou

With Toolbox

toolbox create -i ghcr.io/tepene/box-bayou:latest -c box-bayou
toolbox enter box-bayou

Initial Configuration

Once the box is running you can set the initial configuration with the setup.sh script.

You have the following options:

glitter

Use this option for all glitter and sparkle.

/opt/scripts/setup.sh glitter

This will set the needed file permissions for the /opt directory, change the default shell to ZSH and configure ZSH and Starship with an initial configuration. And just to be sure, if you already have a ZSH and / or Starship configuration, the script will create a backup of the files ~/.zshrc and ~/.config/starship.toml. (better safe than sorry...)

boring

Use this option if you just want to set ZSH as the default shell but no default configuration.

/opt/scripts/setup.sh boring

This will set the needed file permissions for the /opt directory and change the default shell to ZSH.

preserve

Use this option if you already have a ZSH and / or Starship configuration which you don't want to mess up.

/opt/scripts/setup.sh preserve

This will only set the needed file permissions for the /opt directory.

Verification

These images are signed with sisgstore's cosign. You can verify the signature by downloading the cosign.pub key from this repo and running the following command:

cosign verify --key cosign.pub ghcr.io/tepene/box-bayou:latest

If you're forking this repo you should read the docs on keeping secrets in github. You need to generate a new keypair with cosign. The public key can be in your public repo (your users need it to check the signatures), and you can paste the private key in Settings -> Secrets -> Actions.

box-bayou's Issues

Customize for my needs

Installed in the container

The following tools are shipped with the container:

• chezmoi for dotfile management
• Poetry for python venv management
• python-3 to run python tools
• starship cross-shell prompt for that <3

Mapped from Host OS

The following tools are symlinked from the host system:

• btop++
• flatpak
• just
• podman
• rmp-ostree

Add network tools

• nmap
• nmap-scripts
• bind-tools

add tmux

permissions for /opt are very loose

permissions for /opt are very loose -> chmod 777 -R /opt
this is a workaround since every user should be able to run pipx install ... without sudo. Maybe there's a better way to allow users running the box to write to the /opt/ folder without being root.

enhance starship experience

custom starship.toml as a starting point

Getting started

• Update Readme
• VSCode devcontainer
• Update cosign key
• ...

can't deploy from ghcr.io

distrobox create -i ghcr.io/tepene/ublue-box -n ublue-box
Image ghcr.io/tepene/ublue-box not found.
Do you want to pull the image now? [Y/n]: 
Trying to pull ghcr.io/tepene/ublue-box:latest...
Error: initializing source docker://ghcr.io/tepene/ublue-box:latest: Requesting bearer token: invalid status code from registry 403 (Forbidden)

enhance zsh experience

• zsh-autosuggestions-0.7.0-r0
• zsh-completions-0.34.0-r0
• oh-my-zsh

enhance chezmoi experience

chezmoi-bash-completion-2.33.1-r1
chezmoi-zsh-completion-2.33.1-r1

Add helix tree-sitter grammar

add cosign package

Set $EDITOR to /usr/bin/hx

The $EDITOR variable is pointing to "nano". Helix should be the default editor

add additional packages

• jq
• yq
• direnv
• neofetch
• helix

package name is wrong

it should be box-bayou not bayou-box

make container image smaller