Skip to content

Configurations#

This section is about the settings for Zephyr ✳️ itself. Do not confuse this with the Customization section, which is about how to apply different configurations and customizations (defined in Profiles) to your system using Zephyr.

You can find all Zephyr settings in the zephyr.cfg file. To alter any of these settings, create a copy of this file and modify the parameters as needed. You can store your local config file at various locations. Zephyr searches for it in the following order: in the file set by the environment variable ZEPHYR_CONFIG, /profiles/zephyr.local.cfg or /zephyr.local.cfg in the project root. The first file found will take precedence.

Info

Configuration files will be sourced by Bash, so you can use Bash syntax to define variables, set values or use environment variables.

Here is a list of options with their descriptions.

INSTALL_DIR#

This option specifies the installation directory for Zephyr. Default is /usr/local/share/zephyr.

ASSETS_DIR#

Zephyr assets will be stored in this directory. This can include various media or other files that are required. Default is /usr/local/share/zephyr/assets.

ISO_FILE_NAME#

Default file name for the remixed ISO file when Zephyr crafts a new disk image. This will be used if no explicit file name was given to zephyrctl remix command. Default is zephyr.iso.

ISO_LABEL#

The value of this setting determines the label for the remixed ISO file. Default is zephyr.

MODULE_BLACKLIST#

Comma-separated list of modules to be blacklisted. These modules won't be executed during customization (zephyrctl customize). Modules listed here are practically disabled, they cannot be run, even explicitly requested with zephyrctl customize BLACKLISTED_MODULE. Use this setting to skip modules that are not needed. You can give category names too to blacklist all modules in that category. Default is ''.

MODULE_WHITELIST#

Comma-separated list of modules to be whitelisted. Only these modules are executed during customization if no other module was specified (zephyrctl customize). You can still run any module if requested explicitly with zephyrctl customize NOT_WHITELISTED_MODULE. Use this setting to run only a few selected modules by default. If you just want to disable some modules, use MODULE_BLACKLIST instead. It's possible to set category names also to whitelist all modules in that category. Default is ''.