diff --git a/source/clear-linux/get-started/bare-metal-install-beta-intro/bare-metal-install-beta-intro.rst b/source/clear-linux/get-started/bare-metal-install-beta-intro/bare-metal-install-beta-intro.rst new file mode 100644 index 00000000..8069704b --- /dev/null +++ b/source/clear-linux/get-started/bare-metal-install-beta-intro/bare-metal-install-beta-intro.rst @@ -0,0 +1,88 @@ +.. _bare-metal-install-beta-intro: + +Install from the live desktop beta image +######################################## + +The live desktop beta image allows you to boot |CL-ATTR| into a GNOME +desktop without modifying the host system. Using the live image, you can +explore the possibilities of developing with |CL|. You can also launch the +new installer and install |CL| on your target system. + +.. contents:: :local: + :depth: 1 + +Prerequisites +************* + +Assure that your target system supports the installation: + +* :ref:`system-requirements` +* :ref:`compatibility-check` + +Preliminary steps +***************** + +#. `Navigate to the image directory`_. + +#. Download :file:`clear--live-desktop-beta.img.xz` + + .. note:: + + ```` is the latest |CL| auto-numbered release. + +#. Follow your OS instructions to create a bootable USB drive. + + * :ref:`bootable-usb-linux-all` + * :ref:`bootable-usb-mac-all` + * :ref:`bootable-usb-windows-all` + +.. _install-from-live-image: + +Install from live image +*********************** + +After you've downloaded and burned 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 F2 key. + + .. note:: + + 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. + +Launch the installer +******************** + +#. After the |CL| live desktop image boots, select the :guilabel:`Activities` menu in the upper left. + +#. Select the |CL| icon, **Install |CL|**, shown in Figure 1. + + .. figure:: figures/bare-metal-install-beta-intro-1.png + :scale: 50 % + :alt: Install |CL| icon + + Figure 1: Install |CL| icon + +#. After selecting the |CL| icon, the installer is launched, as shown in + Figure 2. + + .. figure:: figures/bare-metal-install-beta-intro-2.png + :scale: 50 % + :alt: Install Clear Linux icon + + Figure 2: Install Clear Linux icon + +#. Continue to :ref:`bare-metal-install-beta` + +.. _Navigate to the image directory: https://download.clearlinux.org/image/ diff --git a/source/clear-linux/get-started/bare-metal-install-beta-intro/figures/bare-metal-install-beta-intro-0.png b/source/clear-linux/get-started/bare-metal-install-beta-intro/figures/bare-metal-install-beta-intro-0.png new file mode 100644 index 00000000..2a29dd55 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta-intro/figures/bare-metal-install-beta-intro-0.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta-intro/figures/bare-metal-install-beta-intro-1.png b/source/clear-linux/get-started/bare-metal-install-beta-intro/figures/bare-metal-install-beta-intro-1.png new file mode 100644 index 00000000..e3c8ff31 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta-intro/figures/bare-metal-install-beta-intro-1.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta-intro/figures/bare-metal-install-beta-intro-2.png b/source/clear-linux/get-started/bare-metal-install-beta-intro/figures/bare-metal-install-beta-intro-2.png new file mode 100644 index 00000000..442988f6 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta-intro/figures/bare-metal-install-beta-intro-2.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/bare-metal-install-beta.rst b/source/clear-linux/get-started/bare-metal-install-beta/bare-metal-install-beta.rst new file mode 100644 index 00000000..c48b76fd --- /dev/null +++ b/source/clear-linux/get-started/bare-metal-install-beta/bare-metal-install-beta.rst @@ -0,0 +1,729 @@ +.. _bare-metal-install-beta: + +Install |CL-ATTR| on bare metal +############################### + +These instructions guide you through installation of |CL-ATTR| on bare metal +using the new installer. + +.. contents:: :local: + :depth: 1 + +.. _minimum-installation-requirements: + +Minimum installation requirements +********************************* + +To fulfill minimum installation requirements, complete +``Required options``. All other menu items are optional. + +.. note:: + + * In the Main menu, the :kbd:`Install` button is highlighted + **only after** you complete :ref:`required-options-installation`. + + * You must choose whether or not to participate in :ref:`telemetrics` + before you can :ref:`complete-cl-installation`. + + * You may wish to :ref:`test-network-settings` before you + :ref:`configure-network-interfaces`. Assure that a ``Success`` message is received. + +Main menu +********* + +In the |CL| Installer main menu, two tabs appear: +:guilabel:`[R] Required options` and :guilabel:`[A] Advanced options`. +Navigate between tabs using the arrow keys or 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 +below menu options in the Main Menu, beside the :guilabel:`>>` chevron. + +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. + + The |CL| Installer main menu appears as shown in Figure 1. + + .. figure:: figures/bare-metal-install-beta-1.png + :scale: 100 % + :alt: |CL| Installer main menu + + Figure 1: :guilabel:`|CL| Installer main menu` + +.. _required-options-installation: + +Required options +**************** + +Choose Timezone +=============== + +#. From the main menu, select :guilabel:`Choose Timezone`. + +#. Select :kbd:`Enter` to continue. + +#. In :guilabel:`Select System Timezone`, navigate to + the desired timezone. + +#. Use :kbd:`Tab` to navigate to :guilabel:`Confirm`. + +#. Select :kbd:`Enter` to :kbd:`Confirm`. + + .. note:: + + Select :guilabel:`Cancel` to restore the previously defined value and + return to the main menu. + + .. figure:: figures/bare-metal-install-beta-2.png + :scale: 100 % + :alt: Select System Timezone + + Figure 2: :guilabel:`Select System Timezone` + +Choose Language +=============== + +#. From the main menu, select :guilabel:`Choose Language`. + +#. Select :kbd:`Enter`. + +#. In :guilabel:`Select System Language`, navigate to your desired language. + +#. Select :kbd:`Tab` to highlight :kbd:`Confirm`. + +#. Select :kbd:`Enter` to :kbd:`Confirm`. + + .. note:: + + Select :guilabel:`Cancel` to restore the previously defined value and return to the main menu. + + .. figure:: figures/bare-metal-install-beta-3.png + :scale: 100 % + :alt: Select System Language + + Figure 3: :guilabel:`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. + +#. In :guilabel:`Test keyboard`, type text to assure that the keys map to + your keyboard. + +#. Select :kbd:`Tab` to highlight :guilabel:`Confirm`. + +#. Select :kbd:`Enter` to :kbd:`Confirm`. + + .. note:: + + Select :guilabel:`Cancel` to restore the previously defined value and return to the main menu. + + .. figure:: figures/bare-metal-install-beta-4.png + :scale: 100 % + :alt: Select Keyboard menu + + Figure 4: :guilabel:`Select Keyboard menu` + +Configure Media +=============== + +#. From the main menu, select :guilabel:`Configure Media`. + + .. note:: + + Available media appear by default. + +#. Navigate to the desired media until highlighted. + + .. TODO: Add another screenshot showing contextual menu. + +#. Select :kbd:`Enter` or :kbd:`Spacebar` to select it. + + Two options for partitioning appear. + +#. Select :guilabel:`Auto Partition` to accept the default configuration, or + :guilabel:`Add Partition` to add partitions manually. See + instructions below. + + .. figure:: figures/bare-metal-install-beta-5.png + :scale: 100 % + :alt: Configure Media menu + + Figure 5: :guilabel:`Configure Media menu` + + .. note:: + + Use additional options as necessary during partitioning: + + * Select :guilabel:`Revert` to cancel changes and revert to the + original configuration. + * Select :guilabel:`Rescan` to show media connected to the host + machine. + +#. Select :kbd:`Enter` to :kbd:`Confirm`. + +Choose one partitioning option below +------------------------------------ + +* :ref:`auto-partition` +* :ref:`add-partition` + +.. _auto-partition: + +Auto Partition +============== + +Auto partition will configure the media to meet the minimum requirements. + +#. Select :guilabel:`Auto Partition` as shown in Figure 6. + +#. Select :kbd:`Enter` or :kbd:`Spacebar` to highlight + :guilabel:`Auto partition`. + +#. Select :kbd:`Enter` to :kbd:`Confirm`. + + This action returns you to the Main Menu. + + .. figure:: figures/bare-metal-install-beta-6.png + :scale: 100 % + :alt: Auto Partition + + Figure 6: :guilabel:`Auto Partition` + + +#. You may skip to the :ref:`telemetry-tui` section below. + +.. _add-partition: + +Add Partition +============= + +Minimum requirements +==================== + +To add partitions manually, assign partitions per the minimum +requirements shown 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.* + +#. In the Configure Media menu, select :guilabel:`Add Partition`. + + .. note:: To change an existing partition, navigate to the partition, + and select :guilabel:`Enter` + +boot partition +-------------- + +#. In the :guilabel:`File System` menu, select :kbd:`Up/Down` arrows to + select the file system type. See Figure 7. + +#. In :guilabel:`Mount Point`, enter the ``/boot`` partition. + +#. In :guilabel:`Size`, enter an appropriate size (e.g., 150M) per Table 1. + +#. Navigate to :guilabel:`Confirm` until highlighted. + +#. Select :guilabel:`Enter` to confirm. + + .. figure:: figures/bare-metal-install-beta-7.png + :scale: 100 % + :alt: boot partition + + Figure 7: :guilabel:`boot partition` + +swap partition +-------------- + +#. In the :guilabel:`File System` menu, select :kbd:`Up/Down` arrows to + select the file system type. See Figure 8. + +#. In :guilabel:`Mount Point`, the field remains blank. + + .. note:: + + The Mount Point field is disabled. + +#. In :guilabel:`Size`, enter an appropriate size (e.g., 256MB) per Table 1. + +#. Navigate to :guilabel:`Add`. + +#. Select :guilabel:`Enter` to continue. + + .. figure:: figures/bare-metal-install-beta-8.png + :scale: 100 % + :alt: swap partition + + Figure 8: :guilabel:`swap partition` + +root partition +-------------- + +#. In the :guilabel:`File System` menu, select :kbd:`Up/Down` arrows to + select the file system type. See Figure 9. + +#. In :guilabel:`Mount Point`, enter ``/root``. + +#. In :guilabel:`Size`, enter an appropriate size per Table 1. + + .. note:: + + The remaining available space shows by default. + +#. Navigate to :guilabel:`Add` until highlighted. + +#. Select :guilabel:`Enter` to continue. + + You are returned to the :guilabel:`Configure media` menu. + +#. Select :guilabel:`Confirm` to complete the media selection. + + .. figure:: figures/bare-metal-install-beta-9.png + :scale: 100 % + :alt: root partition + + Figure 9: :guilabel:`root partition` + + You are returned to the :guilabel:`Configure media` menu. Your partitions should appear similar to those shown in Figure 10. + + .. figure:: figures/bare-metal-install-beta-10.png + :scale: 100 % + :alt: root partition + + Figure 10: :guilabel:`root partition` + +#. Navigate to :guilabel:`Confirm` until highlighted. + +#. Select :guilabel:`Enter` to complete adding partitions. + +.. _telemetry-tui: + +Telemetry +========= + +To fulfill the :guilabel:`Required options`, choose whether or not to +participate in `telemetry`_. :ref:`telemetrics` is a |CL| feature that +reports failures and crashes to the |CL| development team for improvements. +For more detailed information, see our :ref:`telemetry-about` page. + +#. 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-beta-11.png + :scale: 100 % + :alt: Enable Telemetry + + Figure 11: :guilabel:`Enable Telemetry` + +Skip to complete installation +============================= + +After selecting values for all :guilabel:`Required options`, you may skip directly to :ref:`complete-cl-installation` + +If you wish to configure network interfaces or proxy settings, +or add bundles, or add/manage users, continue to the next section. + +Advanced Options +**************** + +.. _configure-network-interfaces: + +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 interface` 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-beta-12.png + :scale: 100 % + :alt: CAPTION BELOW + + Figure 12: :guilabel:`CAPTION BELOW` + +#. 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-beta-13.png + :scale: 100 % + :alt: Network interface configuration + + Figure 13: :guilabel:`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: :ref:`Skip to complete 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-beta-14.png + :scale: 100 % + :alt: Configure the network proxy + + Figure 14: :guilabel:`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: :ref:`Skip to complete installation `. + +.. _test-network-settings: + +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 15. + +.. figure:: figures/bare-metal-install-beta-15.png + :scale: 100 % + :alt: Testing Networking dialogue + + Figure 15: :guilabel:`Testing Networking dialogue` + +.. note:: + + Any changes made to network settings are automatically tested + during configuration. + +Optional: :ref:`Skip to complete 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-beta-16.png + :scale: 100 % + :alt: Bundle selection + + Figure 16: :guilabel:`Bundle selection` + +#. Select :kbd:`Confirm` or :kbd:`Cancel`. + + You are returned to the :guilabel:`Advanced options` menu. + +Optional: :ref:`Skip to complete installation `. + +User Manager +============ + +Add New User +------------ + +#. In Advanced Options, select :guilabel:`User Manager`. + +#. Select :guilabel:`Add New User` as shown in Figure 17. + + .. figure:: figures/bare-metal-install-beta-17.png + :scale: 100 % + :alt: Add New User, User Name + + Figure 17: :guilabel:`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-beta-18.png + :scale: 100 % + :alt: User Name + + Figure 18: :guilabel:`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:`Retype`, 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. + + .. figure:: figures/bare-metal-install-beta-19.png + :scale: 100 % + :alt: Administrative rights + + Figure 19: :guilabel:`Administrative rights` + +#. Select :kbd:`Confirm`. + + .. note:: + + If desired, select :guilabel:`Reset` to reset the form. + +Modify / Delete User +-------------------- + +#. In User Manager, Select :guilabel:`Tab` to highlight the user. + +#. Select :kbd:`Enter` to modify the user. + + .. figure:: figures/bare-metal-install-beta-20.png + :scale: 100 % + :alt: Modify User + + Figure 20: :guilabel:`Modify User` + +#. Modify user details as desired. + + Optional: To delete the user, navigate to the :guilabel:`Delete` + button and select :kbd:`Enter` + +#. Navigate to :kbd:`Confirm` until highlighted. + + .. note:: + + Optional: Select :guilabel:`Reset` to rest the form. + +#. Select :guilabel:`Confirm` to save the changes you made. + +You are returned to the User Manager menu. + +Optional: :ref:`Skip to complete installation `. + +Kernel Command Line +=================== + +For more 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 a new kernel or update a +new kernel. + +#. In Advanced Options, select :guilabel:`Tab` to highlight + :guilabel:`Kernel Command Line`. + +#. Select :kbd:`Enter`. + +#. To add or remove arguments, choose one of the following options. + + .. figure:: figures/bare-metal-install-beta-21.png + :scale: 100 % + :alt: kernel command line + + Figure 21: :guilabel:`kernel command line` + +#. To add arguments, enter the argument in :guilabel:`Add Extra Arguments`. + +#. To remove an existing argument, enter the argument in + :guilabel:`Remove Arguments`. + +#. Select :kbd:`Confirm`. + +Optional: :ref:`Skip to complete installation `. + +Kernel Selection +================ + +Select a kernel option. By default, the latest kernel release is selected. + +.. note:: + + You may choose a different option, such as kernel with Long Term Support + (LTS). To do so, select :guilabel:`Tab` until the kernel option is highlighted. + + .. figure:: figures/bare-metal-install-beta-22.png + :scale: 100 % + :alt: Kernel selection + + Figure 22: :guilabel:`Kernel selection` + +#. Select :kbd:`Spacebar` to select the desired option. + +#. Select :kbd:`Confirm`. + +Optional: :ref:`Skip to complete installation `. + +Swupd Mirror +============ + +If you have your own custom mirror of |CL|, you may want to add that 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-beta-23.png + :scale: 100 % + :alt: Swupd Mirror + + Figure 23: :guilabel:`Swupd Mirror` + +Optional: :ref:`Skip to complete 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-beta-24.png + :scale: 100 % + :alt: Assign Hostname + + Figure 24: :guilabel:`Assign Hostname` + + +#. Navigate to :kbd:`Confirm` until highlighted. + +#. Select :kbd:`Confirm`. + +Optional: :ref:`Skip to complete installation `. + +Automatic OS Updates +==================== + +In the rare case that you need to disable automatic software updates, +follow the onscreen instructions. + +#. In Advanced Options, select :guilabel:`Automatic OS Updates`. + +#. Select the desired option. + + .. figure:: figures/bare-metal-install-beta-25.png + :scale: 100 % + :alt: Automatic OS Updates + + Figure 25: :guilabel:`Automatic OS Updates` + +You are returned to the :guilabel:`Main Menu`. + +.. _complete-cl-installation: + +Complete installation +********************* + +#. When you are satisfied with your installation configuration, navigate to + :guilabel:`Install` and select :kbd:`Enter`. + + .. note:: + + Whenever installation is complete, a ``reboot`` button appears. + +#. Select ``reboot``. + +#. When the system reboots, remove any installation media present. + +| + +**Congratulations!** + +You have successfully installed |CL| on bare metal using the new installer. + +.. _Autoproxy: https://clearlinux.org/features/autoproxy +.. _telemetry: https://clearlinux.org/features/telemetry \ No newline at end of file diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-1.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-1.png new file mode 100644 index 00000000..4cdc59d7 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-1.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-10.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-10.png new file mode 100644 index 00000000..96471d91 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-10.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-11.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-11.png new file mode 100644 index 00000000..3850e6b6 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-11.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-12.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-12.png new file mode 100644 index 00000000..52444039 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-12.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-13.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-13.png new file mode 100644 index 00000000..d67b1cef Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-13.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-14.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-14.png new file mode 100644 index 00000000..682427ad Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-14.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-15.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-15.png new file mode 100644 index 00000000..853d1c9f Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-15.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-16.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-16.png new file mode 100644 index 00000000..f5b3c725 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-16.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-17.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-17.png new file mode 100644 index 00000000..d12f6e17 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-17.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-18.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-18.png new file mode 100644 index 00000000..0ed795ed Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-18.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-19.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-19.png new file mode 100644 index 00000000..63540471 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-19.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-2.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-2.png new file mode 100644 index 00000000..62950c98 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-2.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-20.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-20.png new file mode 100644 index 00000000..1a1e69ab Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-20.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-21.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-21.png new file mode 100644 index 00000000..75efb1a4 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-21.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-22.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-22.png new file mode 100644 index 00000000..ab197a44 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-22.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-23.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-23.png new file mode 100644 index 00000000..0694faf3 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-23.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-24.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-24.png new file mode 100644 index 00000000..21ec0031 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-24.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-25.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-25.png new file mode 100644 index 00000000..c76ee8f1 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-25.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-3.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-3.png new file mode 100644 index 00000000..f06d6aed Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-3.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-4.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-4.png new file mode 100644 index 00000000..e01f71a0 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-4.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-5.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-5.png new file mode 100644 index 00000000..dfc59890 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-5.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-6.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-6.png new file mode 100644 index 00000000..cc5b10b9 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-6.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-7.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-7.png new file mode 100644 index 00000000..5134a989 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-7.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-8.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-8.png new file mode 100644 index 00000000..66fbdfd9 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-8.png differ diff --git a/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-9.png b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-9.png new file mode 100644 index 00000000..75fb4a89 Binary files /dev/null and b/source/clear-linux/get-started/bare-metal-install-beta/figures/bare-metal-install-beta-9.png differ diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-beta-all.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-beta-all.rst new file mode 100644 index 00000000..e617c003 --- /dev/null +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb-beta-all.rst @@ -0,0 +1,205 @@ +.. _bootable-usb-beta-all: + +Create a bootable USB on your OS +################################ + +Follow these instructions to create a bootable |CL-ATTR| USB drive based on +your OS. + +* :ref:`bootable-usb-linux-all` +* :ref:`bootable-usb-mac-all` +* :ref:`bootable-usb-windows-all` + +Return to install from live desktop image: + +* :ref:`install-from-live-image` + +Requirements: +************* + +* Use a **16GB** or larger USB drive. + +.. _bootable-usb-linux-all: + +Create a bootable USB drive on Linux +************************************ + +.. include:: ../../guides/maintenance/download-verify-decompress-linux.rst + :Start-after: 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 in this case. The remaining are 3 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] + +#. Before an image can be burned onto a USB drive, it should be un-mounted. + Some Linux* distros may automatically mount a USB drive when it is plugged + in. To unmount, use the :command:`umount` command followed by the device + identifier/partition. For example: From the above :command:`lsblk` output, + `/dev/sdd` has 2 mounted partitions. To unmount them, enter: + + .. code-block:: bash + + umount /dev/sdd2 + umount /dev/sdd3 + +#. Burn the image onto the USB drive. The command-line example below burns an + uncompressed image onto `/dev/sdd`: + + .. code-block:: bash + + dd if=./clear-[version number]-[image type] of=/dev/sdd bs=4M status=progress + +.. _bootable-usb-mac-all: + +Create a bootable USB drive on macOS* +************************************* + +.. include:: ../../guides/maintenance/download-verify-decompress-mac.rst + :start-after: 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 by entering the command + :command:`diskutil list`. See Figure 1. + + .. code-block:: console + + diskutil list + + .. figure:: figures/bootable-usb-mac-1.png + :scale: 100 % + :alt: Get USB drive identifier + + Figure 1: macOS* - Get USB drive identifier + +#. Unmount the USB drive identified in the previous step. The command-line + example below umounts `/dev/disk2`: + + .. code-block:: console + + diskutil umountDisk /dev/disk2 + +#. Burn the image onto the drive using the :command:`dd` command. The + command-line example below burns an uncompressed image onto `/dev/disk2`: + + .. code-block:: console + + sudo dd if=./clear-[version number]-[image type] of=/dev/rdisk2 bs=4m + + + Adding an ‘r’ in front of the disk identifier should help speed up the + imaging process. + + You can press :kbd:`-T` to check imaging progress. + +#. Eject the USB drive. + + .. code-block:: console + + diskutil eject /dev/disk2 + +.. _bootable-usb-windows-all: + +Create a bootable USB drive on Windows\* +**************************************** + +.. include:: ../../guides/maintenance/download-verify-decompress-windows.rst + :Start-after: 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. + +#. Plug in the USB drive and open Rufus. + +#. Click the :guilabel:`SELECT` button. See Figure 1. + + .. figure:: figures/bootable-usb-windows-1.png + :scale: 80 % + :alt: Rufus utility - Click the SELECT button + + Figure 1: Rufus utility - Click the SELECT button + +#. Find and select the previously extracted |CL| image file. + Then, click the :guilabel:`Open` button. See Figure 2. + + .. figure:: figures/bootable-usb-windows-2.png + :scale: 80 % + :alt: Rufus utility - Show and select |CL| image file + + Figure 2: Rufus utility - Show and select |CL| image file + +#. Click the :guilabel:`START` button. See Figure 3. + + .. figure:: figures/bootable-usb-windows-3.png + :scale: 80 % + :alt: Rufus utility - Click the START button + + Figure 3: Rufus utility - Click START button + +Return to install from live image +********************************* + +Return to :ref:`install-from-live-image` + +.. _Rufus: https://rufus.ie/ diff --git a/source/clear-linux/get-started/get-started.rst b/source/clear-linux/get-started/get-started.rst index 1bbe2c15..566d30d4 100644 --- a/source/clear-linux/get-started/get-started.rst +++ b/source/clear-linux/get-started/get-started.rst @@ -14,14 +14,21 @@ Pre-install * :ref:`compatibility-check` * :ref:`bootable-usb` + + Install |CL| ************ * :ref:`bare-metal-install` * :ref:`bare-metal-manual-install` * :ref:`virtual-machine-install` -* :ref:`live-image` +* :ref:`live-image` +| + +* :ref:`bare-metal-install-beta-intro` + +| .. toctree:: :maxdepth: 2 @@ -33,4 +40,8 @@ Install |CL| virtual-machine-install/virtual-machine-install live-image compatibility-check - bootable-usb/bootable-usb \ No newline at end of file + bootable-usb/bootable-usb + bare-metal-install-beta-intro/bare-metal-install-beta-intro + + bare-metal-install-beta/bare-metal-install-beta + bootable-usb/bootable-usb-beta-all