toolbox.conf(5)

πŸ’– toolbox.conf β€” the vibe check on your Toolbx config πŸ’–

okay bestie, so this is toolbox.conf(5), from the File Formats Manual section of the man pages, and it's literally just the little config file that tells toolbox(1) how to behave. no cap. 🫢


✨ NAME ✨

toolbox.conf β€” the Toolbx configuration file. that's it, that's the whole name section, she's simple and she's iconic. πŸ’…


🌸 DESCRIPTION 🌸

so here's the tea: this file persistently overrides the default behaviour of toolbox(1). like, instead of typing the same flags every single time, you just write it down once and it remembers. main character energy fr. πŸ‘‘

the syntax is TOML, and β€” this is the cute part β€” the names of the options match their command line counterparts. so if you already know the flags, you already know the file. iykyk. ✨

and rn? currently, the only supported section is general. one section. she's the whole show. no others exist yet. periodt. πŸŽ€


πŸ’… OPTIONS πŸ’…

  • distro = "DISTRO" β€” makes a Toolbx container for a different operating system DISTRO than the host. that's the whole job. πŸ¦‹ Cannot be used with image. like, they do not coexist, pick a lane bestie.
  • image = "NAME" β€” changes the NAME of the image used to create the Toolbx container. this is the one you want when you're building containers from custom-built images, so slay for the DIY girlies. 🎨 Cannot be used with distro and release.

okay and this next bit is important so listen up: if NAME does not contain a registry, the local image storage will be consulted first, and if it's not present there, then it will be pulled from a suitable remote registry. local first, remote second. the way that it checks in order is so organized of it honestly. πŸ™ˆ

  • release = "RELEASE" β€” creates a Toolbx container for a different operating system RELEASE than the host. Cannot be used with image. again with the exclusivity, she's not sharing the spotlight. πŸ’€

πŸ—‚οΈ FILES πŸ—‚οΈ

these locations are looked up in increasing order of priority β€” so the ones further down the list win. later = louder. πŸ“’

  • /etc/containers/toolbox.conf

this one is meant to be provided by the operating system distributor or the system administrator, and it affects all users on the host. it's the communal one. 🏠

Fields specified here can be overridden by any of the files below. so don't get attached.

  • $XDG_CONFIG_HOME/containers/toolbox.conf

this one is meant for user-specific changes. Fields specified here override any of the files above. she's personal and she's got opinions. πŸ’œ


🌈 EXAMPLES 🌈

Override the default operating system distro:

[general]
distro = "fedora"
release = "36"

look at her go. so clean. πŸ“

Override the default image:

[general]
image = "registry.fedoraproject.org/fedora-toolbox:36"

that registry is right there in the name, so no local storage mystery hunt needed. chef's kiss. 😭πŸ”₯


πŸ‘€ SEE ALSO πŸ‘€

toolbox(1), toolbox-create(1) β€” go read those next, they're the sisters of this page and they're both giving. πŸ’–


and that's the whole page, bestie!! 🧚 this was toolbox.conf(5) from the File Formats Manual β€” footer says toolbox.conf(5) and the date, so consider yourself signed off on. ✨ stay configured, stay cute, and remember: [general] is the only section allowed in the club rn. πŸŒΈπŸ’…πŸ«Ά

πŸ“¦ where this page comes from