Revert "Merge of latest changes into RTD theme to enable multi-language support (#604)"

This reverts commit 186f1e02b8.
This commit is contained in:
Kevin Putnam
2019-07-10 15:20:53 -07:00
committed by GitHub
parent 186f1e02b8
commit f2a5c5a46b
407 changed files with 2660 additions and 2918 deletions
@@ -0,0 +1,496 @@
.. _bare-metal-install-desktop:
Install |CL-ATTR| from the live desktop
#######################################
The live desktop allows you to boot |CL-ATTR| in a GNOME desktop without
modifying the host system, offering the chance to explore developing
on |CL|. Better yet, launch the |CL| installer to install on your target
system.
.. contents:: :local:
:depth: 1
System requirements
*******************
Assure that your target system supports the installation:
* :ref:`system-requirements`
* :ref:`compatibility-check`
Preliminary steps
*****************
#. `Visit our Downloads page`_.
#. Download the file :file:`clear-<release number>-live-desktop.iso`
.. note::
<release-number> is the latest |CL| auto-numbered release.
#. Follow your OS instructions to create a bootable USB drive.
* :ref:`bootable-usb`
.. _install-on-target-start:
Install from live image
***********************
After you download and burn the live desktop image on a USB drive, follow
these steps.
#. Insert the USB drive into an available USB slot.
#. Power on the system.
#. Open the system BIOS setup menu by pressing the :kbd:`F2` key.
Your BIOS setup menu entry point may vary.
#. In the setup menu, enable the UEFI boot and set the USB drive as the
first option in the device boot order.
#. Save these settings, e.g. :kbd:`F10`, and exit.
#. Reboot the target system.
#. Select :guilabel:`Clear Linux OS` in the boot menu, shown in Figure 1.
.. figure:: figures/bare-metal-install-desktop-01.png
:scale: 100%
:alt: Clear Linux OS in boot menu
Figure 1: Clear Linux OS in boot menu
.. _install-on-target-end:
Confirm network connection
==========================
Confirm there is a network connection before launching the installer.
Choose a method: `Wired Connection`, or `WiFi Connected`.
This guide shows an example of a **Wired Connection**.
#. In the upper right of the top menu bar, select the square icon to view
Network settings, shown in Figure 2.
#. Select :guilabel:`Wired Connected` and then :guilabel:`Wired Settings`.
.. figure:: figures/bare-metal-install-desktop-02.png
:scale: 100%
:alt: Software icon, Network settings
Figure 2: Software icon, Network settings
#. View the :guilabel:`Wired` menu to assure that you're target system and
installer are connected to a network.
#. Optional: Configure Proxy settings.
#. To view :guilabel:`Network Proxy`, select its :guilabel:`Gear` icon.
#. Select from `Automatic`, `Manual` or `Disabled` as desired.
#. Close the dialogue box.
#. Select the :guilabel:`Gear` icon to view Network settings.
#. If desired, select :guilabel:`Connect automatically`.
Select other options as desired.
#. Select :guilabel:`Apply` button to confirm change to settings.
Software
--------
Optional: Explore |CL| bundles and other software available. Double-click the :guilabel:`Software` icon from the Activities menu, shown in Figure 2.
.. note::
`Sofware` application is *only intended for exploring* available bundles,
applications, and images. Do not attempt to install them.
Assure there is a network connection before launching `Software`.
Launch the |CL| installer
=========================
#. After the live desktop image boots, find the |CL| icon in
the :guilabel:`Activities` menu at left, shown in Figure 3.
#. Click the icon, :guilabel:`Install Clear Linux OS`.
.. figure:: figures/bare-metal-install-desktop-02.png
:scale: 100%
:alt: Install Clear Linux OS icon
Figure 3: Install Clear Linux OS icon
#. The installer is launched, as shown in Figure 4.
.. figure:: figures/bare-metal-install-desktop-04.png
:scale: 100%
:alt: |CL| Desktop Installer
Figure 4: |CL| OS Desktop Installer
#. In :guilabel:`Select Language`, select a language from the options, or
type your preferred language in the search bar.
#. Select :guilabel:`Next`.
.. _incl-bare-metal-beta-start:
Minimum installation requirements
*********************************
To fulfill minimum installation requirements, complete the
`Required options`_. We also recommend completing `Advanced options`_.
.. note::
* The :kbd:`Install` button is only highlighted **after** you complete
`Required options`_.
* Checkmarks indicate a selection has been made.
* An Internet connection is required. You may want to launch a browser
prior to installation to verify your Internet connection.
|CL| Desktop Installer
**********************
The |CL| Desktop Installer Main Menu appears as shown in Figure 5. To meet
the minimum requirements, enter values in all submenus for the
:guilabel:`Required options`. After you complete them, your selections appear
below submenus and a checkmark appears at right.
.. figure:: figures/bare-metal-install-desktop-05.png
:scale: 100%
:alt: Clear Linux OS Desktop Installer - Main Menu
Figure 5: Clear Linux OS Desktop Installer - Main Menu
Navigation
**********
* Use the :kbd:`mouse` to navigate or select options.
* Use :kbd:`Tab` key to navigate between :guilabel:`Required options`
and :guilabel:`Advanced options`
* Use :kbd:`Up` or :kbd:`Down` arrow keys to navigate submenu list.
* Select :kbd:`Confirm`, or :kbd:`Cancel` in submenus.
Required options
****************
Select Time Zone
================
#. From the Main Menu, select :guilabel:`Select Time Zone`. `UTC` is selected
by default.
#. In :guilabel:`Select Time Zone`, navigate to the desired time zone.
Or start typing the region and then city.
(.e.g., :file:`America/Los_Angeles`).
#. Select :guilabel:`Confirm`.
.. figure:: figures/bare-metal-install-desktop-06.png
:scale: 100%
:alt: Select System Timezone
Figure 6: Select System Time Zone
Select Keyboard
===============
#. From the Main Menu, select :guilabel:`Select Keyboard`.
#. Navigate to your desired keyboard layout. We select "us" for the
United States.
#. Select :guilabel:`Confirm`.
.. figure:: figures/bare-metal-install-desktop-07.png
:scale: 100%
:alt: Select Keyboard menu
Figure 7: Select Keyboard menu
Select Installation Media
=========================
#. From the Main Menu, select :guilabel:`Select Installation Media`.
#. Choose an installation method: `Safe Installation`_ or
`Destructive Installation`_.
.. figure:: figures/bare-metal-install-desktop-08.png
:scale: 100%
:alt: Select Installation Media
Figure 8: Select Installation Media
Safe Installation
-----------------
Use this method to safely install |CL| on media with available space, or
alongside existing partitions, and accept the `Default partition schema`_.
If enough free space exists, safe installation is allowed.
Destructive Installation
------------------------
Use this method to destroy the contents of the target device, install |CL| on it, and accept the `Default partition schema`_.
Disk encryption
===============
For greater security, disk encryption is supported using LUKS. Encryption is
optional.
#. To encrypt the root partition, select :guilabel:`Enable Encryption`,
as shown in Figure 9.
.. figure:: figures/bare-metal-install-desktop-09.png
:scale: 100%
:alt: Enable Encryption
Figure 9: Enable Encryption
#. When :guilabel:`Encryption Passphrase` appears, enter a passphrase.
.. figure:: figures/bare-metal-install-desktop-10.png
:scale: 100%
:alt: Encryption Passphrase
Figure 10: Encryption Passphrase
.. note::
Minimum length is 8 characters. Maximum length is 94 characters.
#. Enter the same passphrase in the second field.
#. Select :guilabel:`Confirm` in the dialogue box.
.. note::
:guilabel:`Confirm` is only highlighted if passphrases match.
#. Select :guilabel:`Confirm` in submenu.
Manage User
===========
#. In Required Options, select :guilabel:`Manage User`.
#. In :guilabel:`User Name`, enter a user name.
.. figure:: figures/bare-metal-install-desktop-11.png
:scale: 100%
:alt: Manage User
Figure 11: Manage User
#. In :guilabel:`Login`, create a login name. It must start with a letter
and can use numbers, hyphens, and underscores. Maximum length is 31
characters.
#. In :guilabel:`Password`, enter a password. Minimum length is
8 characters. Maximum length is 255 characters.
#. In :guilabel:`Confirm`, enter the same password.
.. note::
:guilabel:`Administrator` rights are selected by default.
For security purposes, the default user must be assigned as an
Administrator.
#. Select :kbd:`Confirm`.
.. note::
Select :guilabel:`Cancel` to return to the Main Menu.
Modify User
-----------
#. In Manager User, select :guilabel:`Manage User`.
#. Modify user details as desired.
#. Select :guilabel:`Confirm` to save the changes you made.
.. note::
Optional: Select :guilabel:`Cancel` to return to the Main Menu to
revert changes.
Optional: Skip to `Finish installation`_.
Telemetry
=========
Choose whether to participate in `telemetry`. :ref:`telem-guide` is a |CL|
feature that reports failures and crashes to the |CL| development
team for improvements. For more information, see :ref:`telemetry-about`.
#. From :guilabel:`Required Options`, select :guilabel:`Telemetry`.
#. Select :kbd:`Confirm`.
#. If you don't wish to participate, deselect :kbd:`Enable Telemetry`.
#. Select :kbd:`Confirm`.
.. figure:: figures/bare-metal-install-desktop-12.png
:scale: 100%
:alt: Enable Telemetry
Figure 12: Enable Telemetry
Advanced options
****************
After you complete the `Required options`_, we recommend completing
:guilabel:`Advanced options`--though they're not required. Doing so
customizes your development environment, so you're ready to go immediately
after reboot.
* `Bundle Selection`_
* `Assign Hostname`_
As for bundles, you can always add more later with :ref:`swupd-guide`.
Bundle Selection
================
#. On the Advanced menu, select :guilabel:`Bundle Selection`
#. Select your desired bundles.
.. figure:: figures/bare-metal-install-desktop-13.png
:scale: 100%
:alt: Bundle Selection
Figure 13: Bundle Selection
#. Select :kbd:`Confirm`.
#. View the bundles that you selected.
.. figure:: figures/bare-metal-install-desktop-14.png
:scale: 100%
:alt: Bundle Selections - Advanced Options
Figure 14: Bundle Selections - Advanced Options
Optional: Skip to `Finish installation`_.
Assign Hostname
===============
#. In Advanced Options, select :guilabel:`Assign Hostname`.
#. In :guilabel:`Hostname`, enter the hostname only (excluding the domain).
.. figure:: figures/bare-metal-install-desktop-15.png
:scale: 100%
:alt: Assign Hostname
Figure 15: Assign Hostname
.. note::
Hostname does not allow empty spaces. Hostname must start with an
alphanumeric character but may also contain hyphens. Maximum length of
63 characters.
#. Navigate to :kbd:`Confirm` until highlighted.
#. Select :kbd:`Confirm`.
Optional: Skip to `Finish installation`_.
Finish installation
*******************
#. When you are satisfied with your installation configuration, select
:guilabel:`Install`.
.. figure:: figures/bare-metal-install-desktop-16.png
:scale: 100%
:alt: Assign Hostname
Figure 16: Finish installation
.. note:
All checkmarks must be visible in :guilabel:`Required Options` for you to select :guilabel:`Install`.
#. If you do not enter a selection for all :guilabel:`Required Options`,
the :guilabel:`Install` button remains greyed out, as shown
in Figure 17. Return to `Required Options`_ and make selections.
.. figure:: figures/bare-metal-install-desktop-17.png
:scale: 100%
:alt: Required Options - Incomplete
Figure 17: Required Options - Incomplete
#. After installation is complete, select :guilabel:`Exit`.
#. Shut down the target system.
#. Remove the USB or any installation media.
#. Power on your system.
.. note::
Allow time for the graphical login to appear. A login prompt shows the administrative user that you created.
#. Log in as the adminstrative user.
Congratulations. You successfully installed |CL|.
Default partition schema
========================
Table 1 shows the defult partition schema with the exception of root,
which varies.
.. list-table:: **Table 1. Disk Partition Setup**
:widths: 33, 33, 33
:header-rows: 1
* - FileSystem
- Mount Point
- Minimum size
* - ``VFAT``
- /boot
- 150M
* - ``swap``
-
- 256MB
* - ``root``
- /
- *Size depends upon use case/desired bundles.*
Next steps
**********
:ref:`guides`
.. _Visit our downloads page: https://clearlinux.org/downloads
.. _Autoproxy: https://clearlinux.org/features/autoproxy
Binary file not shown.

After

Width:  |  Height:  |  Size: 100 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 196 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 214 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 60 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 75 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 16 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 74 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

@@ -0,0 +1,855 @@
.. _bare-metal-install-server:
Install |CL-ATTR| on bare metal with live server
################################################
These instructions guide you through installing |CL-ATTR| on bare metal from a bootable USB drive using a live server image.
.. contents::
:local:
:depth: 1
System requirements
*******************
Assure that your target system supports the installation:
* :ref:`system-requirements`
* :ref:`compatibility-check`
Download the latest |CL| live server image
******************************************
Get the latest |CL| installer image from the `downloads page`_. Look for the
:file:`clear-[version number]-live-server.iso` file.
#. Follow your OS instructions to create a bootable USB drive.
* :ref:`bootable-usb`
#. After downloading the image, verify and decompress the file per your OS.
Install |CL| 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 |CL| over a wireless connection by first
using `nmtui`. Follow the `nmtui` instructions shown in Figure 2.
Follow these steps to install |CL| on the target system:
#. Insert the USB drive into an available USB slot.
#. Power on the system.
#. Open the system BIOS setup menu by pressing the :kbd:`F2` key.
Your BIOS setup menu entry point may vary.
#. In the setup menu, enable the UEFI boot and set the USB drive as the first
option in the device boot order.
#. Save these settings and exit.
#. Reboot the target system.
#. This action launches the |CL| installer boot menu, shown in figure 1.
.. figure:: figures/bare-metal-install-server-01.png
:scale: 100%
:alt: Clear Linux OS Installer boot menu
Figure 1: Clear Linux OS Installer boot menu
#. With :guilabel:`Clear Linux OS` highlighted, select :kbd:`Enter`.
Launch the |CL| Installer
*************************
#. At the :guilabel:`login` prompt, enter :command:`root`.
#. Follow the onscreen instructions, shown in Figure 2, and
enter a temporary password.
.. figure:: figures/bare-metal-install-server-02.png
:scale: 100%
:alt: root login
Figure 2: root login
#. At the :guilabel:`root` prompt, enter :command:`clr-installer` and
press :kbd:`Enter`.
.. figure:: figures/bare-metal-install-server-03.png
:scale: 100%
:alt: 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::
* The :kbd:`Install` button is **only highlighted after** you complete
`Required options`_.
Main Menu
*********
The |CL| Installer Main Menu appears as shown in Figure 4.
.. figure:: figures/bare-metal-install-server-04.png
:scale: 100%
:alt: Clear Linux OS Installer
Figure 4: Clear Linux OS Installer
The |CL| Installer Main Menu has two tabs: :guilabel:`[R] Required options`
and :guilabel:`[A] Advanced options`. Navigate between tabs using the arrow
these shortcut keys:
* :kbd:`Shift+A` for :guilabel:`[A] Advanced options`
* :kbd:`Shift+R` for :guilabel:`[R] Required options`
To meet the minimum requirements, enter your choices in the
:guilabel:`Required options`. After confirmation, your selections appear
beside the :guilabel:`>>` chevron, below the menu options.
Navigation
**********
* Select :kbd:`Tab` or :kbd:`Up/Down` arrows to highlight your choice.
* Select :kbd:`Enter` or :kbd:`Spacebar` to confirm your choice.
* Select :kbd:`Cancel` or :kbd:`Esc` to cancel your choice.
Required options
****************
Choose Timezone
===============
#. From the Main Menu, navigate to :guilabel:`Choose Timezone`.
`UTC` is the default.
#. Select :kbd:`Enter`.
#. In :guilabel:`Select System Timezone`, use :kbd:`Up/Down` arrows
navigate to the desired timezone.
.. todo: User need only select Enter; can only select Confirm with mouse.
#. Press :kbd:`Enter` to confirm.
.. figure:: figures/bare-metal-install-server-05.png
:scale: 100%
:alt: Select System Timezone
Figure 5: Select System Timezone
Choose Language
===============
#. From the Main Menu, navigate to :guilabel:`Choose Language`.
#. Select :kbd:`Enter`.
#. In :guilabel:`Select System Language`, navigate to your desired language.
#. Press :kbd:`Enter` to confirm.
.. figure:: figures/bare-metal-install-server-06.png
:scale: 100%
:alt: Select System Language
Figure 6: Select System Language
Configure the Keyboard
======================
#. From the Main Menu, select :guilabel:`Configure the Keyboard`.
#. Select :kbd:`Enter`.
#. In :guilabel:`Select Keyboard`, navigate to the desired option.
#. Select :kbd:`Enter` to :kbd:`Confirm`.
#. Optional: In :guilabel:`Test keyboard`, type text to assure
that the keys map to your keyboard.
.. figure:: figures/bare-metal-install-server-07.png
:scale: 100%
:alt: Select Keyboard menu
Figure 7: Select Keyboard menu
Configure Installation Media
============================
#. From the Main Menu, select :guilabel:`Configure Installation Media`.
#. Choose an installation method:
* `Safe Installation`_
* `Destructive Installation`_
* `Advanced Configuration`_
.. figure:: figures/bare-metal-install-server-08.png
:scale: 100%
:alt: Select Installation Media
Figure 8: Select Installation Media
#. Select :guilabel:`Rescan Media` to show available installation targets.
.. todo: Revise below section to match the dev-gui-00
Safe Installation
-----------------
Use this method to safely install |CL| 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 |CL|
on it, and accept the `Default partition schema`_.
.. note::
From the :guilabel:`Select Installation Media` menu, select
:guilabel:`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.
#. From :guilabel:`Select Installation Media`, shown in Figure 8 above,
select :guilabel:`Advanced Configuration`.
#. In :guilabel:`Advanced Configuration`, navigate to :file:`/dev/sda`
and then press :kbd:`Enter`.
.. figure:: figures/bare-metal-install-server-09.png
:scale: 100%
:alt: Advanced configuration menu
Figure 9: Advanced configuration menu
#. Choose a partition method:
* :guilabel:`Auto Partition` Select this option to accept the
`Default partition schema`_.
#. Navigate to and press :guilabel:`Confirm`.
#. Continue with installation configuration. Jump to `Telemetry`_.
* `Manual Partition`_ Continue below.
Manual Partition
----------------
We provide a simple example below.
#. Navigate to the unallocated media (e.g.,`/dev/sda`) until highlighted, as
shown in Figure 9.
#. Press :guilabel:`Enter` to edit the partition.
#. The :guilabel:`Partition Setup` menu appears, shown in Figure 10.
.. note::
After adding the first partition, select :guilabel:`Free Space` to add another partition.
root partition
--------------
#. We configure the `root` partition as shown in Figure 10.
Configuration of the `root` partition varies.
.. figure:: figures/bare-metal-install-server-10.png
:scale: 100%
:alt: root partition
Figure 10: root partition
#. Navigate to :guilabel:`Add` and press :guilabel:`Enter`.
boot partition
--------------
#. We configure the `boot` partition as shown in Figure 11.
.. figure:: figures/bare-metal-install-server-11.png
:scale: 100%
:alt: boot partition
Figure 11: boot partition
#. Navigate to :guilabel:`Add` and press :guilabel:`Enter`.
swap partition
--------------
#. In the :guilabel:`File System` pulldown menu, select `swap`, and
enter a label. We enter the minimum required size (e.g., 256M).
.. figure:: figures/bare-metal-install-server-12.png
:scale: 100%
:alt: swap partition
Figure 12: swap partition
#. Navigate to :guilabel:`Add` and press :guilabel:`Enter`.
#. Next, navigate to :guilabel:`Confirm` and press :guilabel:`Enter`,
shown in Figure 13.
Manual partitioning is complete.
.. figure:: figures/bare-metal-install-server-13.png
:scale: 100%
:alt: Final configuration of disk partitions
Figure 13: Final configuration of disk partitions
#. 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 |CL|. To encrypt the root partition, see the
example below. Encryption is optional.
Encryption Passphrase
---------------------
|CL| uses a single passphrase for encrypted partitions. Additional keys may
be configured post-installation using the ``cryptsetup`` tool.
#. Optional: Select :guilabel:`[X] Encrypt` to encrypt the root partition,
as shown in Figure 14.
.. figure:: figures/bare-metal-install-server-14.png
:scale: 100%
:alt: Encrypt partition
Figure 14: Encrypt partition
#. The :guilabel:`Encryption Passphrase` dialogue appears.
.. note::
Minimum length is 8 characters. Maximum length is 94 characters.
.. figure:: figures/bare-metal-install-server-15.png
:scale: 100%
:alt: Encryption Passphrase
Figure 15: Encryption Passphrase
#. Enter the same passphrase in the first and second field.
#. Navigate to :guilabel:`Confirm` and press :kbd:`Enter`.
.. note::
:guilabel:`Confirm` is only highlighted if passphrases match.
Telemetry
=========
:ref:`telem-guide` is a |CL| feature that reports failures and crashes to
the |CL| development team for improvements. For more detailed information,
visit our :ref:`telemetry-about` page.
Select your desired option on whether to participate in `telemetry`.
#. In the Main Menu, navigate to :guilabel:`Telemetry` and select
:kbd:`Enter`.
#. Select :kbd:`Tab` to highlight your choice.
#. Select :kbd:`Enter` to confirm.
.. figure:: figures/bare-metal-install-server-16.png
:scale: 100%
:alt: Enable Telemetry
Figure 16: Enable Telemetry
Recommended options
*******************
After you complete the `Required options`_, we highly recommend completing
these selected `Advanced options`_ at minimum:
* `Manage User`_ Assign a new user with administrative rights
* `Assign Hostname`_ Simplify your development environment
Skip to finish installation
===========================
After selecting values for all :guilabel:`Required options`, you may skip
to `Finish installation`_.
Otherwise, continue below. In the Main Menu, select
:guilabel:`Advanced options` for additional configuration.
Advanced options
****************
Configure Network Interfaces
============================
By default, |CL| 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.
#. Navigate to :guilabel:`Configure Network Interfaces` and
select :kbd:`Enter`.
#. Navigate to the network :guilabel:`interface` you wish to change.
#. When the desired :guilabel:`interface` is highlighted, select
:guilabel:`Enter` to edit.
.. note:: Multiple network interfaces may appear.
.. figure:: figures/bare-metal-install-server-17.png
:scale: 100%
:alt: Configure Network Interfaces
Figure 17: Configure Network Interfaces
#. Notice :guilabel:`Automatic / dhcp` is selected by default (at bottom).
Optional: Navigate to the checkbox :guilabel:`Automatic / dhcp` and select
:kbd:`Spacebar` to deselect.
.. figure:: figures/bare-metal-install-server-18.png
:scale: 100%
:alt: Network interface configuration
Figure 18: Network interface configuration
#. Navigate to the appropriate fields and assign the desired
network configuration.
#. To save settings, navigate to :guilabel:`Confirm` and select
:kbd:`Enter`.
.. note::
To revert to previous settings, navigate to the :guilabel:`Cancel`
and select :kbd:`Enter`.
#. Upon confirming network configuration, the :guilabel:`Testing Networking`
dialogue appears. Assure the result shows success. If a failure occurs,
your changes will not be saved.
#. Upon confirmation, you are returned to :guilabel:`Network interface`
settings.
#. Navigate to and select :guilabel:`Main Menu`.
Optional: Skip to `Finish installation`_.
Proxy
=====
|CL| automatically attempts to detect proxy settings, as described in
`Autoproxy`_. If you need to manually assign proxy settings, follow this
instruction.
#. From the Advanced options menu, navigate to :guilabel:`Proxy`, and
select :kbd:`Enter`.
#. Navigate to the field :guilabel:`HTTPS Proxy`.
.. figure:: figures/bare-metal-install-server-19.png
:scale: 100%
:alt: Configure the network proxy
Figure 19: Configure the network proxy
#. Enter the desired proxy address and port using conventional syntax,
such as: \http://address:port.
#. Navigate to :guilabel:`Confirm` and select :kbd:`Enter`.
#. To revert to previous settings, navigate to :guilabel:`Cancel`
and select :guilabel:`Cancel`.
Optional: Skip to `Finish installation`_.
Test Network Settings
=====================
To manually assure network connectivity before installing |CL|,
select :guilabel:`Test Network Settings` and select :guilabel:`Enter`.
A progress bar appears as shown in Figure 20.
.. figure:: figures/bare-metal-install-server-20.png
:scale: 100%
:alt: 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
================
#. On the Advanced menu, select :guilabel:`Bundle Selection`
#. Navigate to the desired bundle using :kbd:`Tab` or :kbd:`Up/Down` arrows.
#. Select :kbd:`Spacebar` to select the checkbox for each desired bundle.
.. figure:: figures/bare-metal-install-server-21.png
:scale: 100%
:alt: Bundle Selection
Figure 21: Bundle Selection
#. Optional: To start developing with |CL|, we recommend
adding :file:`os-clr-on-clr`.
#. Navigate to and select :kbd:`Confirm`.
You are returned to the :guilabel:`Advanced options` menu.
Optional: Skip to `Finish installation`_.
Manage User
===========
Add New User
------------
#. In Advanced Options, select :guilabel:`Manage User`.
#. Select :guilabel:`Add New User` as shown in Figure 22.
.. figure:: figures/bare-metal-install-server-22.png
:scale: 100%
:alt: Add New User, User Name
Figure 22: Add New User
#. Optional: Enter a :guilabel:`User Name`.
.. note:
The User Name must be alphanumeric and can include spaces, commas, or hyphens. Maximum length is 64 characters.
.. figure:: figures/bare-metal-install-server-23.png
:scale: 100%
:alt: User Name
Figure 23: User Name
#. Enter a :guilabel:`Login`.
.. note::
The User Login must be alphanumeric and can include hyphens and underscores. Maximum length is 31 characters.
#. Enter a :guilabel:`Password`.
.. note:
Minimum length is 8 characters. Maximum length is 255 characters.
#. In :guilabel:`Confirm`, enter the same password.
#. Optional: Navigate to the :guilabel:`Administrative` checkbox and select
:kbd:`Spacebar` to assign administrative rights to the user.
.. note::
Selecting this option enables sudo privileges for the user.
#. Select :kbd:`Confirm`.
.. note::
If desired, select :guilabel:`Reset` to reset the form.
#. In :guilabel:`Manage User`, navigate to :guilabel:`Confirm`.
#. With :guilabel:`Confirm` highlighted, select :kbd:`Enter`.
Modify / Delete User
--------------------
#. In :guilabel:`Manage User`, navigate to the user you wish
to modify until highlighted, as shown in Figure 24.
#. Select :kbd:`Enter` to modify the user.
.. figure:: figures/bare-metal-install-server-24.png
:scale: 100%
:alt: Modify User
Figure 24: Modify User
#. Modify user details as desired.
#. Navigate to :kbd:`Confirm` until highlighted.
.. note::
Optional: Select :guilabel:`Reset` to rest the form.
#. Select :guilabel:`Confirm` to save the changes you made.
#. Optional: In :guilabel:`Modify User`, to delete the user, navigate to
the :guilabel:`Delete` button and select :kbd:`Enter`.
.. figure:: figures/bare-metal-install-server-25.png
:scale: 100%
:alt: Delete User
Figure 25: Delete User
You are returned to :guilabel:`Manage User`.
#. Navigate to :kbd:`Confirm` until highlighted.
#. Select :guilabel:`Enter` to complete :guilabel:`Manage User` options.
Optional: Skip to `Finish installation`_.
Kernel Command Line
===================
For advanced users, |CL| 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.
#. In Advanced Options, select :guilabel:`Tab` to highlight
:guilabel:`Kernel Command Line`.
#. Select :kbd:`Enter`.
.. figure:: figures/bare-metal-install-server-26.png
:scale: 100%
:alt: kernel command line
Figure 26: kernel command line
#. Choose from the following options.
* To add arguments, enter the argument in :guilabel:`Add Extra Arguments`.
* To remove an argument, enter the argument in
:guilabel:`Remove Arguments`.
#. Select :kbd:`Confirm`.
Optional: Skip to `Finish installation`_.
Kernel Selection
================
#. Select a kernel option. By default, the latest kernel release is
selected. Native kernel is shown in Figure 27.
#. To select a different kernel, navigate to it using :guilabel:`Tab`.
.. figure:: figures/bare-metal-install-server-27.png
:scale: 100%
:alt: Kernel selection
Figure 27: Kernel selection
#. Select :kbd:`Spacebar` to select the desired option.
#. Navigate to :kbd:`Confirm` and select :kbd:`Enter`.
Optional: Skip to `Finish installation`_.
Swupd Mirror
============
If you have your own custom mirror of |CL|, you can add its URL.
#. In Advanced Options, select :guilabel:`Swupd Mirror`.
#. To add a local swupd mirror, enter a valid URL in :guilabel:`Mirror URL:`
#. Select :kbd:`Confirm`.
.. figure:: figures/bare-metal-install-server-28.png
:scale: 100%
:alt: Swupd Mirror
Figure 28: Swupd Mirror
Optional: Skip to `Finish installation`_.
Assign Hostname
===============
#. In Advanced Options, select :guilabel:`Assign Hostname`.
#. In :guilabel:`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.
.. figure:: figures/bare-metal-install-server-29.png
:scale: 100%
:alt: Assign Hostname
Figure 29: Assign Hostname
#. Navigate to :kbd:`Confirm` until highlighted.
#. Select :kbd:`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.
#. In Advanced Options, select :guilabel:`Automatic OS Updates`.
#. Select the desired option.
.. figure:: figures/bare-metal-install-server-30.png
:scale: 100%
:alt: Automatic OS Updates
Figure 30: Automatic OS Updates
You are returned to the :guilabel:`Main Menu`.
Save Configuration Settings
===========================
#. In Advanced Options, select :guilabel:`Save Configuration Settings`.
#. A dialogue box shows the installation configuration was saved to
:file:`clr-installer.yaml`
.. figure:: figures/bare-metal-install-server-31.png
:scale: 100%
:alt: Automatic OS Updates
Figure 31: Automatic OS Updates
#. Use the :file:`clr-installer.yaml` file to install |CL|, with the same
configuration, on multiple targets.
Finish installation
*******************
#. When you are satisfied with your installation configuration, navigate to
:guilabel:`Install` and select :kbd:`Enter`.
.. figure:: figures/bare-metal-install-server-32.png
:scale: 100%
:alt: Select Install
Figure 32: Select Install
#. Select :guilabel:`reboot`.
.. note::
If you do not assign an administrative user, upon rebooting,
enter `root` and set the root password immediately.
#. 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.
.. list-table:: **Table 1. Disk Partition Setup**
:widths: 33, 33, 33
:header-rows: 1
* - 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 :guilabel:`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: :command:`lsblk -a`
- Windows\* OS: :command:`diskpart`, then :command:`list disk`
- macOS\* platform: :command:`diskutil list`
.. _Autoproxy: https://clearlinux.org/features/autoproxy
.. _downloads page: https://clearlinux.org/downloads
Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 49 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 92 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 77 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 64 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 31 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 78 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 55 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 43 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 35 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 26 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 93 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 195 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 56 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 42 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 54 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 69 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 41 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 94 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 40 KiB

@@ -0,0 +1,207 @@
.. _bootable-usb:
Create a bootable USB drive
###########################
Instructions to create a |CL-ATTR| USB drive vary depending on your operating
system. Follow the instructions applicable to your system:
* :ref:`bootable-usb-linux`
* :ref:`bootable-usb-mac`
* :ref:`bootable-usb-windows`
Prerequisites
*************
* Use an **8GB** or larger USB drive.
* `Download`_ the |CL| live boot image or interactive installer image.
.. _bootable-usb-linux:
Create a bootable USB drive on Linux\*
**************************************
Make sure you have have completed all `Prerequisites`_.
Before burning the image onto your USB drive,
:ref:`verify and decompress your image <verify-linux>`.
Burn the |CL| image onto a USB drive
====================================
.. caution::
|CAUTION-BACKUP-USB|
#. Open a terminal emulator and get root privilege.
.. code-block:: bash
sudo -s
#. Go to the directory with the decompressed image.
#. Plug in the USB drive.
#. Identify the USB drive using the :command:`lsblk` command. This shows all
drives attached to the system, including the primary hard disk. In the
example output below, there are 4 drives
(`/dev/sda`, `/dev/sdb`, `/dev/sdc`, and `/dev/sdd`) attached, where
`/dev/sda` is primary drive. The remaining are three USB drives. The output
also shows the mounted partitions (under the `MOUNTPOINT` column) for each
drive.
.. code-block:: bash
lsblk
Example output:
.. code-block:: console
NAME MAJ:MIN RM SIZE RO TYPE MOUNTPOINT
sdd 8:48 1 15G 0 disk
├─sdd2 8:50 1 5G 0 part /run/media/user1/960c184f-3bb7-42b7-bcaf-0c1282
├─sdd3 8:51 1 8G 0 part /run/media/user1/704f3382-b26d-4f34-af1b-cb9aab
└─sdd1 8:49 1 2G 0 part
sdb 8:16 1 14.8G 0 disk
└─sdb1 8:17 1 14.8G 0 part /run/media/user1/PATRIOT_USB
sdc 8:32 1 7.3G 0 disk
└─sdc1 8:33 1 7.3G 0 part /run/media/user1/LINUX MINT
sda 8:0 0 335.4G 0 disk
├─sda4 8:4 0 28G 0 part
├─sda2 8:2 0 3.7G 0 part [SWAP]
├─sda7 8:7 0 6G 0 part /home
├─sda5 8:5 0 1G 0 part /boot
├─sda3 8:3 0 954M 0 part /boot/efi
├─sda1 8:1 0 28G 0 part
├─sda8 8:8 0 30G 0 part /
└─sda6 8:6 0 7.9G 0 part [SWAP]
#. You must unmount a USB drive before burning an image onto it. Note that
some Linux distros automatically mount a USB drive when it is plugged in.
Unmount a USB drive with the :command:`umount` command followed by the device
identifier/partition. For example:
.. code-block:: bash
umount /dev/sdd2
umount /dev/sdd3
#. Burn the image onto the USB drive. The example below burns an uncompressed
image onto `<your USB device>`:
.. code-block:: bash
dd if=./clear-[version number]-[image type] of=<your USB device> oflag=sync bs=4M status=progress
.. caution::
|CAUTION-UNMOUNT-USB-PARTITIONS|
.. _bootable-usb-mac:
Create a bootable USB drive on macOS\*
**************************************
Make sure you have have completed all `Prerequisites`_.
Before burning the image onto your USB drive,
:ref:`verify and decompress your image <verify-mac>`.
Burn the |CL| image onto a USB drive
====================================
.. caution::
|CAUTION-BACKUP-USB|
#. Launch the Terminal app.
#. Go to the directory with the decompressed image.
#. Plug in a USB drive and get its identifier:
.. code-block:: bash
diskutil list
This will list available disks and their partitions, as shown in Figure 1.
.. figure:: figures/bootable-usb-mac-01.png
:scale: 100 %
:alt: Get USB drive identifier
Figure 1: macOS - Get USB drive identifier
#. Unmount the USB drive identified in the previous step. For example:
.. code-block:: bash
diskutil umountDisk /dev/disk2
#. Burn the image onto the drive using the :command:`dd` command.
The example below burns an uncompressed image onto `<your USB device>`:
.. code-block:: bash
sudo dd if=./clear-[version number]-[image type] of=<your USB device> bs=4m
To speed up the imaging process, add an r in front of the disk identifier.
For example `/dev/rdisk2`.
Press :kbd:`<CTL>-T` to check imaging progress.
#. Eject the USB drive.
.. code-block:: bash
diskutil eject /dev/disk2
.. _bootable-usb-windows:
Create a bootable USB drive on Windows\*
****************************************
Make sure you have have completed all `Prerequisites`_.
Before burning the image onto your USB drive,
:ref:`verify and decompress your image <verify-windows>`.
Burn the |CL| image onto a USB drive
====================================
.. caution::
|CAUTION-BACKUP-USB|
#. Download the `Rufus`_ utility to burn the image onto a USB drive.
We use Rufus 3.5 here. **Only use the latest version of Rufus**.
#. Plug in the USB drive and open Rufus.
#. Under `Boot selection`, click the :guilabel:`SELECT` button.
#. Find and select the previously extracted |CL| image file.
#. Click the :guilabel:`START` button. See Figure 2.
.. figure:: figures/bootable-usb-windows-02.png
:scale: 80 %
:alt: Rufus utility
Figure 2: Rufus utility
#. When the dialogue appears, select
:guilabel:`Write in ISO image mode (Recommended)`. See Figure 3.
.. figure:: figures/bootable-usb-windows-03.png
:scale: 80 %
:alt: ISOHybrid image detected
Figure 3: ISOHybrid image detected
#. Select the Windows taskbar menu for USB and select eject.
.. _Rufus: https://rufus.ie/
.. _Download: https://clearlinux.org/downloads
Binary file not shown.

After

Width:  |  Height:  |  Size: 116 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 115 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 67 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

@@ -0,0 +1,61 @@
.. _compatibility-check:
Check processor and EFI firmware compatibility
##############################################
On a system that is currently running a Linux\* operating system, follow the
instructions below to determine if your system's processor and EFI firmware is
capable of running |CL-ATTR|. Otherwise,
:ref:`bare-metal-install-desktop` and then perform the steps
below.
.. note::
This does not check other system components (for example: storage and
graphics) for compatibility with |CL|.
#. Download the `clear-linux-check-config.sh`_ file.
If a browser is not available, use:
.. code-block:: console
curl -O https://cdn.download.clearlinux.org/current/clear-linux-check-config.sh
#. Make the script executable.
.. code-block:: console
chmod +x clear-linux-check-config.sh
#. Run the script.
#. Check to see if the host's processor and EFI firmware is capable of
running |CL|.
.. code-block:: console
./clear-linux-check-config.sh host
#. Check to see if the host is capable of running |CL| in a container.
.. code-block:: console
./clear-linux-check-config.sh container
The script will print a list of test results similar to the output below.
All items should return a `SUCCESS` status. This example indicates the
host's processor and EFI firmware support running |CL|.
.. code-block:: console
Checking if host is capable of running Clear Linux* OS
SUCCESS: 64-bit CPU (lm)
SUCCESS: Supplemental Streaming SIMD Extensions 3 (ssse3)
SUCCESS: Streaming SIMD Extension v4.1 (sse4_1)
SUCCESS: Streaming SIMD Extensions v4.2 (sse4_2)
SUCCESS: Advanced Encryption Standard instruction set (aes)
SUCCESS: Carry-less Multiplication extensions (pclmulqdq)
SUCCESS: EFI Firmware
.. _clear-linux-check-config.sh: https://cdn.download.clearlinux.org/current/clear-linux-check-config.sh
@@ -0,0 +1,29 @@
.. _get-started:
Get started
###########
The Get Started section will get you up and running fast with |CL-ATTR|. Use
these step-by-step instructions to guide you through the installing |CL|
from a live desktop or to a virtual machine.
Pre-install
***********
* :ref:`system-requirements`
.. toctree::
:maxdepth: 1
compatibility-check
bootable-usb/bootable-usb
Install |CL|
************
.. toctree::
:maxdepth: 1
bare-metal-install-desktop/bare-metal-install-desktop
bare-metal-install-server/bare-metal-install-server
virtual-machine-install/virtual-machine-install
Binary file not shown.

After

Width:  |  Height:  |  Size: 45 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 44 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 7.7 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 10 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 14 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 11 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 15 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 13 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 9.8 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 18 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 12 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 23 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 22 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 30 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 36 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 65 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 81 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 47 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 50 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 80 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 24 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 57 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 20 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 58 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 85 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 91 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 46 KiB

Binary file not shown.

After

Width:  |  Height:  |  Size: 37 KiB

Some files were not shown because too many files have changed in this diff Show More