|
| 1 | +--- |
| 2 | +title: "Branding" |
| 3 | +linkTitle: "Branding" |
| 4 | +weight: 12 |
| 5 | +date: 2025-10-21 |
| 6 | +description: Customize the appearance and behavior of Kairos components |
| 7 | +--- |
| 8 | + |
| 9 | +Kairos supports branding customization to tailor the appearance and behavior of various components to match your organization's identity or requirements. Branding options are controlled through configuration files placed in the `/etc/kairos/branding/` directory. |
| 10 | + |
| 11 | +## Interactive Installer Branding |
| 12 | + |
| 13 | +The interactive installer supports customization options that allow you to modify its appearance and available options. |
| 14 | + |
| 15 | +### Color Scheme Customization |
| 16 | + |
| 17 | +You can customize the color scheme of the interactive installer by creating a file at `/etc/kairos/branding/interactive_install_colors`. This file should contain environment variable definitions for the colors you want to override. You can specify any, all, or none of these variables - they will override the corresponding default colors. |
| 18 | + |
| 19 | +The available color variables are: |
| 20 | + |
| 21 | +- `KAIROS_BG` - Background color |
| 22 | +- `KAIROS_TEXT` - Text color |
| 23 | +- `KAIROS_HIGHLIGHT` - Primary highlight color |
| 24 | +- `KAIROS_HIGHLIGHT2` - Secondary highlight color |
| 25 | +- `KAIROS_ACCENT` - Accent color |
| 26 | +- `KAIROS_BORDER` - Border color |
| 27 | +- `CHECK_MARK` - Check mark character/symbol |
| 28 | + |
| 29 | +#### Color Format |
| 30 | + |
| 31 | +Colors can be specified in two formats depending on your terminal capabilities: |
| 32 | + |
| 33 | +**For full color terminals (24-bit/true color)**: Use hex triplet format in RGB: |
| 34 | +```bash |
| 35 | +# /etc/kairos/branding/interactive_install_colors |
| 36 | +KAIROS_BG="#03153a" # Deep blue background |
| 37 | +KAIROS_TEXT="#ffffff" # White text |
| 38 | +KAIROS_HIGHLIGHT="#e56a44" # Orange highlight |
| 39 | +KAIROS_ACCENT="#ee5007" # Accent orange |
| 40 | +CHECK_MARK="✓" |
| 41 | +``` |
| 42 | + |
| 43 | +**For simple/dumb terminals (16 colors)**: Use numbers 0-9 for basic colors: |
| 44 | +```bash |
| 45 | +# /etc/kairos/branding/interactive_install_colors |
| 46 | +KAIROS_BG="0" # Black background |
| 47 | +KAIROS_TEXT="7" # White text |
| 48 | +KAIROS_HIGHLIGHT="9" # Bright red highlight |
| 49 | +KAIROS_BORDER="9" # Bright red border |
| 50 | +CHECK_MARK="*" |
| 51 | +``` |
| 52 | + |
| 53 | +{{% alert title="Note" color="info" %}} |
| 54 | +If you set values to 0-9, those simple colors will be used even on 256-color terminals. For the best experience on modern terminals, use hex triplet format. |
| 55 | +{{% /alert %}} |
| 56 | + |
| 57 | +### Disabling Advanced Options |
| 58 | + |
| 59 | +If you want to hide the "Customize Further" option in the interactive installer, you can create an empty file at `/etc/kairos/branding/interactive_install_advanced_disabled`. When this file exists, the installer will only show the "Start Install" option, simplifying the interface for users who don't need advanced customization. |
| 60 | + |
| 61 | +```bash |
| 62 | +# Create the file to disable advanced options |
| 63 | +touch /etc/kairos/branding/interactive_install_advanced_disabled |
| 64 | +``` |
| 65 | + |
| 66 | +### Applying Branding |
| 67 | + |
| 68 | +These branding files should be included in your Kairos image build process or deployed to the system before running the interactive installer. For details on building custom images, see the [Build from Scratch](/docs/reference/build-from-scratch) documentation. |
0 commit comments