Whonix Derivative Maker

https://github.com/whonix/derivative-maker
Admin
Whonix Derivative Maker is a tool for creating custom Whonix derivatives, allowing users to build...
Tokens:2,657
Snippets:9
Trust Score:7
Update:1 year ago
Show doc for...
Tokens:
Raw
### Configure Help Bar

Source: https://github.com/whonix/derivative-maker/blob/master/live-build-data/grub-config/live-theme/theme.txt

Defines the appearance and behavior of the help bar displayed at the bottom of the screen. It includes text, alignment, color, and font settings.

```bash
+ label {
        top = 100%-50
        left = 0
        width = 100%
        height = 20
        text = "@KEYMAP_SHORT@"
        align = "center"
        color = "#ffffff"
	font = "Unifont Regular 16"
}
```

--------------------------------

### Configure Boot Menu

Source: https://github.com/whonix/derivative-maker/blob/master/live-build-data/grub-config/live-theme/theme.txt

Customizes the visual elements of the boot menu, including item colors, fonts, spacing, and icon properties. This allows for tailored boot selection interfaces.

```bash
+ boot_menu {
        left = 10%
        width = 80%
        top = 52%
        height = 48%-80
        item_color = "#a8a8a8"
	item_font = "Unifont Regular 16"
        selected_item_color= "#ffffff"
	selected_item_font = "Unifont Regular 16"
        item_height = 16
        item_padding = 0
        item_spacing = 4
	icon_width = 0
	icon_heigh = 0
	item_icon_space = 0
}
```

--------------------------------

### Configure Splash Screen Appearance

Source: https://github.com/whonix/derivative-maker/blob/master/live-build-data/grub-config/live-theme/theme.txt

Sets the background image, text color, and font for the splash screen. This configuration is applied directly to the derivative maker's startup display.

```bash
desktop-image: "../splash.png"
title-color: "#ffffff"
title-font: "Unifont Regular 16"
title-text: ""
message-font: "Unifont Regular 16"
terminal-font: "Unifont Regular 16"
```

--------------------------------

### Configure Progress Bar

Source: https://github.com/whonix/derivative-maker/blob/master/live-build-data/grub-config/live-theme/theme.txt

Sets the styling for the progress bar, including its position, dimensions, colors, and text. It also defines the text displayed, such as timeout notifications.

```bash
+ progress_bar {
        id = "__timeout__"
        left = 15%
        top = 100%-80
        height = 16
        width = 70%
        font = "Unifont Regular 16"
        text_color = "#000000"
        fg_color = "#ffffff"
        bg_color = "#a8a8a8"
        border_color = "#ffffff"
        text = "@TIMEOUT_NOTIFICATION_LONG@"
}
```

--------------------------------

### Define Docker Volume Mounts

Source: https://github.com/whonix/derivative-maker/blob/master/docker/README.md

These shell variables define the default locations for Docker volumes used by derivative-maker. These volumes store build artifacts, logs, and cache data. Users can customize these paths.

```Shell
BINARY_VOLUME="$HOME/binary_mnt"
CACHER_VOLUME="$HOME/approx_cache_mnt"
KEY_VOLUME="$HOME/.key_mnt"
```

--------------------------------

### Run derivative-maker Docker Container

Source: https://github.com/whonix/derivative-maker/blob/master/docker/README.md

This is the primary command to run the derivative-maker Docker container. It can be used with various options to specify build steps, custom commands, or custom volume mounts.

```Shell
./derivative-maker-docker-run -- <build arguments>
```

```Shell
./derivative-maker-docker-run -b 2800_create-lb-iso -- <build arguments>
```

```Shell
./derivative-maker-docker-run -c /bin/bash --
```

```Shell
./derivative-maker-docker-run --binary-mount /home/user/whonix/dm-binary --cacher-mount /home/user/whonix/apt-cache -- <build arguments>
```

--------------------------------

### Clone derivative-maker Repository

Source: https://github.com/whonix/derivative-maker/blob/master/docker/README.md

This command clones the derivative-maker repository from GitHub with specific options for depth, branch, jobs, and submodule handling. It's a prerequisite for building Whonix/Kicksecure images.

```Shell
git clone --depth=1 --branch 17.3.9.9-stable --jobs=4 --recurse-submodules --shallow-submodules https://github.com/Whonix/derivative-maker.git
```

--------------------------------

### Manage Docker Images

Source: https://github.com/whonix/derivative-maker/blob/master/docker/README.md

These commands are used to inspect and manage Docker images for derivative-maker. 'docker images' lists available images, while 'docker rmi -f derivative-maker/derivative-maker-docker:latest' forcefully removes the latest image, triggering a re-creation.

```Shell
docker images
```

```Shell
docker rmi -f derivative-maker/derivative-maker-docker:latest
```

--------------------------------

### Ansible Vault Decryption and Variable Configuration

Source: https://github.com/whonix/derivative-maker/blob/master/automated_builder/README.md

This snippet demonstrates how to decrypt the Ansible Vault file and configure necessary variables for building Whonix derivatives. It includes placeholders for VPS IP and SSH keys, and explains the use of the ANSIBLE_VAULT_PASSWORD environment variable.

```Bash
ansible-vault decrypt automated_builder/vars/main.yml
```

```YAML
VPS_IP: # Put your VPS ip here
SSH_KEY: |
  # Put the Ansible user's configured private key here
SSH_PUBLIC_KEY: |
  # Put the ansible user's configured public key here
```
Tokens:
Raw