These instructions guide you through installing Clear Linux* OS on bare metal from a bootable USB drive using a live server image.

Download the latest Clear Linux OS live server image

Get the latest Clear Linux OS installer image from the Downloads page. Look for the clear-[version number]-live-server.iso file.

  1. Follow your OS instructions to create a bootable USB drive.
  2. After downloading the image, verify and decompress the file per your OS.

Install Clear Linux OS on your target system

Ensure that your system is configured to boot UEFI. The installation method described below requires a wired Internet connection with DHCP.

Note

Alternatively, you can install Clear Linux OS over a wireless connection by first using nmtui. Follow the nmtui instructions shown in Figure 2.

Follow these steps to install Clear Linux OS on the target system:

  1. Insert the USB drive into an available USB slot.

  2. Power on the system.

  3. Open the system BIOS setup menu by pressing the F2 key. Your BIOS setup menu entry point may vary.

    Note

    Clear Linux OS supports UEFI boot. Some hardware may list UEFI and non-UEFI USB boot entries. In this case, you should select the UEFI boot option.

  4. In the setup menu, enable the UEFI boot and set the USB drive as the first option in the device boot order.

  5. Save these settings and exit.

  6. Reboot the target system.

  7. This action launches the Clear Linux OS installer boot menu, shown in figure 1.

    Clear Linux OS Installer boot menu

    Figure 1: Clear Linux OS Installer boot menu

  8. With Clear Linux OS highlighted, select Enter.

Launch the Clear Linux OS Installer

  1. At the login prompt, enter root.

  2. Follow the onscreen instructions, shown in Figure 2, and enter a temporary password.

    root login

    Figure 2: root login

  3. At the root prompt, enter clr-installer and press Enter.

    clr-installer command

    Figure 3: clr-installer command

Minimum installation requirements

To fulfill minimum installation requirements, complete the Required options. While not required, we encourage you to apply the Recommended options. Advanced options are optional.

Note

Required options

Choose Timezone

  1. From the Main Menu, navigate to Choose Timezone. UTC is the default.
  2. Select Enter.
  3. In Select System Timezone, use Up/Down arrows navigate to the desired timezone.
  1. Press Enter to confirm.

    Select System Timezone

    Figure 5: Select System Timezone

Choose Language

  1. From the Main Menu, navigate to Choose Language.

  2. Select Enter.

  3. In Select System Language, navigate to your desired language.

  4. Press Enter to confirm.

    Select System Language

    Figure 6: Select System Language

Configure the Keyboard

  1. From the Main Menu, select Configure the Keyboard.

  2. Select Enter.

  3. In Select Keyboard, navigate to the desired option.

  4. Select Enter to Confirm.

  5. Optional: In Test keyboard, type text to assure that the keys map to your keyboard.

    Select Keyboard menu

    Figure 7: Select Keyboard menu

Configure Installation Media

  1. From the Main Menu, select Configure Installation Media.

  2. Choose an installation method: * Safe Installation * Destructive Installation * Advanced Configuration

    Select Installation Media

    Figure 8: Select Installation Media

  3. Select Rescan Media to show available installation targets.

Safe Installation

Use this method to safely install Clear Linux OS on media with available space, or alongside existing partitions, and accept the Default partition schema. If enough free space exists, safe installation is allowed. See also Troubleshooting below.

Destructive Installation

Use this method to destroy the contents of the target device, install Clear Linux OS on it, and accept the Default partition schema.

Note

From the Select Installation Media menu, select Enable Encryption to encrypt the root filesystem for either option above. See also Disk encryption for more information.

Advanced Configuration

Use this method to manually configure partitions. These must meet Default partition schema. You may also choose Disk encryption during configuration of each partition.

Note

Advanced Configuration is available in the installer versions 1.2.0 and above.

  1. From Select Installation Media, shown in Figure 8 above, select Advanced Configuration.

  2. In Advanced Configuration, navigate to /dev/sda and then press Enter.

    Advanced configuration menu

    Figure 9: Advanced configuration menu

  3. Choose a partition method:

Manual Partition

We provide a simple example below.

  1. Navigate to the unallocated media (e.g.,`/dev/sda`) until highlighted, as shown in Figure 9.

  2. Press Enter to edit the partition.

  3. The Partition Setup menu appears, shown in Figure 10.

    Note

    After adding the first partition, select Free Space to add another partition.

root partition

  1. We configure the root partition as shown in Figure 10. Configuration of the root partition varies.

    root partition

    Figure 10: root partition

  2. Navigate to Add and press Enter.

boot partition

  1. We configure the boot partition as shown in Figure 11.

    boot partition

    Figure 11: boot partition

  2. Navigate to Add and press Enter.

swap partition

  1. In the File System pulldown menu, select swap, and enter a label. We enter the minimum required size (e.g., 256M).

    swap partition

    Figure 12: swap partition

  2. Navigate to Add and press Enter.

  3. Next, navigate to Confirm and press Enter, shown in Figure 13.

    Manual partitioning is complete.

    Final configuration of disk partitions

    Figure 13: Final configuration of disk partitions

  4. You may skip to the Telemetry section below.

Disk encryption

For greater security, disk encryption is supported using LUKS for the any partition except /boot on Clear Linux OS. To encrypt the root partition, see the example below. Encryption is optional.

Encryption Passphrase

Clear Linux OS uses a single passphrase for encrypted partitions. Additional keys may be configured post-installation using the cryptsetup tool.

  1. Optional: Select [X] Encrypt to encrypt the root partition, as shown in Figure 14.

    Encrypt partition

    Figure 14: Encrypt partition

  2. The Encryption Passphrase dialogue appears.

    Note

    Minimum length is 8 characters. Maximum length is 94 characters.

    Encryption Passphrase

    Figure 15: Encryption Passphrase

  3. Enter the same passphrase in the first and second field.

  4. Navigate to Confirm and press Enter.

    Note

    Confirm is only highlighted if passphrases match.

Telemetry

Telemetrics is a Clear Linux OS feature that reports failures and crashes to the Clear Linux OS development team for improvements. For more detailed information, visit our Telemetrics page.

Select your desired option on whether to participate in telemetry.

  1. In the Main Menu, navigate to Telemetry and select Enter.

  2. Select Tab to highlight your choice.

  3. Select Enter to confirm.

    Enable Telemetry

    Figure 16: Enable Telemetry

Advanced options

Configure Network Interfaces

By default, Clear Linux OS is configured to automatically detect the host network interface using DHCP. However, if you want to use a static IP address or if you do not have a DHCP server on your network, follow these instructions to manually configure the network interface. Otherwise, default network interface settings are automatically applied.

Note

If DHCP is available, no user selection may be required.

  1. Navigate to Configure Network Interfaces and select Enter.

  2. Navigate to the network interface you wish to change.

  3. When the desired interface is highlighted, select Enter to edit.

    Note

    Multiple network interfaces may appear.

    Configure Network Interfaces

    Figure 17: Configure Network Interfaces

  4. Notice Automatic / dhcp is selected by default (at bottom).

    Optional: Navigate to the checkbox Automatic / dhcp and select Spacebar to deselect.

    Network interface configuration

    Figure 18: Network interface configuration

  5. Navigate to the appropriate fields and assign the desired network configuration.

  6. To save settings, navigate to Confirm and select Enter.

    Note

    To revert to previous settings, navigate to the Cancel and select Enter.

  7. Upon confirming network configuration, the Testing Networking dialogue appears. Assure the result shows success. If a failure occurs, your changes will not be saved.

  8. Upon confirmation, you are returned to Network interface settings.

  9. Navigate to and select Main Menu.

Optional: Skip to Finish installation.

Proxy

Clear Linux OS automatically attempts to detect proxy settings, as described in Autoproxy. If you need to manually assign proxy settings, follow this instruction.

  1. From the Advanced options menu, navigate to Proxy, and select Enter.

  2. Navigate to the field HTTPS Proxy.

    Configure the network proxy

    Figure 19: Configure the network proxy

  3. Enter the desired proxy address and port using conventional syntax, such as: http://address:port.

  4. Navigate to Confirm and select Enter.

  5. To revert to previous settings, navigate to Cancel and select Cancel.

Optional: Skip to Finish installation.

Test Network Settings

To manually assure network connectivity before installing Clear Linux OS, select Test Network Settings and select Enter.

A progress bar appears as shown in Figure 20.

Testing Networking dialogue

Figure 20: Testing Networking dialogue

Note

Any changes made to network settings are automatically tested during configuration.

Optional: Skip to Finish installation.

Bundle Selection

  1. On the Advanced menu, select Bundle Selection

  2. Navigate to the desired bundle using Tab or Up/Down arrows.

  3. Select Spacebar to select the checkbox for each desired bundle.

    Bundle Selection

    Figure 21: Bundle Selection

  4. Optional: To start developing with Clear Linux OS, we recommend adding os-clr-on-clr.

  5. Navigate to and select Confirm.

    You are returned to the Advanced options menu.

Optional: Skip to Finish installation.

Manage User

Add New User

  1. In Advanced Options, select Manage User.

  2. Select Add New User as shown in Figure 22.

    Add New User, User Name

    Figure 22: Add New User

  3. Optional: Enter a User Name.

    User Name

    Figure 23: User Name

  4. Enter a Login.

    Note

    The User Login must be alphanumeric and can include hyphens and underscores. Maximum length is 31 characters.

  5. Enter a Password.

  6. In Confirm, enter the same password.

  7. Optional: Navigate to the Administrative checkbox and select Spacebar to assign administrative rights to the user.

    Note

    Selecting this option enables sudo privileges for the user.

  8. Select Confirm.

    Note

    If desired, select Reset to reset the form.

  9. In Manage User, navigate to Confirm.

  10. With Confirm highlighted, select Enter.

Modify / Delete User

  1. In Manage User, navigate to the user you wish to modify until highlighted, as shown in Figure 24.

  2. Select Enter to modify the user.

    Modify User

    Figure 24: Modify User

  3. Modify user details as desired.

  4. Navigate to Confirm until highlighted.

    Note

    Optional: Select Reset to rest the form.

  5. Select Confirm to save the changes you made.

  6. Optional: In Modify User, to delete the user, navigate to the Delete button and select Enter.

    Delete User

    Figure 25: Delete User

You are returned to Manage User.

  1. Navigate to Confirm until highlighted.
  2. Select Enter to complete Manage User options.

Optional: Skip to Finish installation.

Kernel Command Line

For advanced users, Clear Linux OS provides the ability to add or remove kernel arguments. If you want to append a new argument, enter the argument here. This argument will be used every time you install or update a new kernel.

  1. In Advanced Options, select Tab to highlight Kernel Command Line.

  2. Select Enter.

    kernel command line

    Figure 26: kernel command line

  3. Choose from the following options.

    • To add arguments, enter the argument in Add Extra Arguments.
    • To remove an argument, enter the argument in Remove Arguments.
  4. Select Confirm.

Optional: Skip to Finish installation.

Kernel Selection

  1. Select a kernel option. By default, the latest kernel release is selected. Native kernel is shown in Figure 27.

  2. To select a different kernel, navigate to it using Tab.

    Kernel selection

    Figure 27: Kernel selection

  3. Select Spacebar to select the desired option.

  4. Navigate to Confirm and select Enter.

Optional: Skip to Finish installation.

Swupd Mirror

If you have your own custom mirror of Clear Linux OS, you can add its URL.

  1. In Advanced Options, select Swupd Mirror.

  2. To add a local swupd mirror, enter a valid URL in Mirror URL:

  3. Select Confirm.

    Swupd Mirror

    Figure 28: Swupd Mirror

Optional: Skip to Finish installation.

Assign Hostname

  1. In Advanced Options, select Assign Hostname.

  2. In Hostname, enter the hostname only (excluding the domain).

    Note

    Hostname does not allow empty spaces. Hostname must start with an alphanumeric character but may also contain hyphens. Maximum length of 63 characters.

    Assign Hostname

    Figure 29: Assign Hostname

  3. Navigate to Confirm until highlighted.

  4. Select Confirm.

Optional: Skip to Finish installation.

Automatic OS Updates

Automatical OS updates are enabled by default. In the rare case that you need to disable automatic software updates, follow the onscreen instructions, shown in Figure 30.

  1. In Advanced Options, select Automatic OS Updates.

  2. Select the desired option.

    Automatic OS Updates

    Figure 30: Automatic OS Updates

You are returned to the Main Menu.

Save Configuration Settings

  1. In Advanced Options, select Save Configuration Settings.

  2. A dialogue box shows the installation configuration was saved to clr-installer.yaml

    Automatic OS Updates

    Figure 31: Automatic OS Updates

  3. Use the clr-installer.yaml file to install Clear Linux OS, with the same configuration, on multiple targets.

Finish installation

  1. When you are satisfied with your installation configuration, navigate to Install and select Enter.

    Select Install

    Figure 32: Select Install

  2. Select reboot.

    Note

    If you do not assign an administrative user, upon rebooting, enter root and set the root password immediately.

  3. When the system reboots, remove any installation media present.

Default partition schema

To add partitions manually, see Advanced configuration below, and create partitions per requirements in Table 1.

Table 1. Disk Partition Setup
FileSystem Mount Point Minimum size
VFAT /boot 150M
swap   256MB
root / Size depends upon use case/desired bundles.

Troubleshooting

For Configure Installation Media

If a warning message appears that no media or space is available after entering Configure Installation Media:

  • Verify that target media has enough free space.
  • Confirm the USB is properly connected to and mounted on target media.
  • Review the size of existing partitions on the target media:
    • Linux* OS: lsblk -a
    • Windows* OS: diskpart, then list disk
    • macOS* platform: diskutil list