Skip to content
/ boxkit Public template

Build your own custom OCI distrobox container

License

Notifications You must be signed in to change notification settings

ublue-os/boxkit

Folders and files

NameName
Last commit message
Last commit date

Latest commit

 

History

83 Commits
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 
 

boxkit

Description

boxkit is a set of GitHub actions and skeleton files to build toolbox and distrobox images. Basically, clone this repo, make the changes you want, and then build what you need. Some examples include:

  • DaVinci Box - Container for DaVinci Resolve installation and runtime dependencies on Linux
  • obs-studio-portable - OCI container image of OBS Studio that bundles a curated collection of 3rd party plugins
  • bazzite-arch - A ready-to-game Arch Linux based OCI designed for use exclusively in distrobox

Boxkit Alpine Example

You can use whatever distribution you want with boxkit, this is the initial example (here are more):

How to use

Create Box

If you use distrobox:

distrobox create -i ghcr.io/ublue-os/boxkit -n boxkit
distrobox enter boxkit

If you use toolbx:

toolbox create -i ghcr.io/ublue-os/boxkit -c boxkit
toolbox enter boxkit

Pull down your config

Use chezmoi to pull down your dotfiles and set up git sync.

Make your own

Fork and add programs to this this image - over time you'll end up with the perfect CLI for you. Keeping it as a pet works, though the author recommends leaving all your config in git and routinely pulling a new image.

The user experience is much nicer if you set use Ptyxis and is the intended experience.

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/ublue-os/boxkit

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.

Finding Good Base Images

Of course you can make this however you want, but start with the Toolbx Community images. These are a set of mostly-stock images with packages needed to run as a toolbox/distrobox already installed.

Try to derive your blingbox from those base images so we can all help maintain them over time, you can't have bling without good stock!

Tag your image with boxkit to share with others!

Repography logo / Recent activity Time period

Timeline graph Issue status graph Pull request status graph Trending topics Top contributors Activity map