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 index 6b2edf3c..7279f3f9 100644 --- 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 @@ -35,7 +35,7 @@ Preliminary steps #. Follow your OS instructions to create a bootable USB drive. - * :ref:`bootable-usb-beta-all` + * :ref:`bootable-usb` Install from live image *********************** diff --git a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst index 47cd92c1..ef8bbf42 100644 --- a/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst +++ b/source/clear-linux/get-started/bare-metal-install/bare-metal-install.rst @@ -38,7 +38,7 @@ Optionally, you can use this command: #. Follow your OS instructions to create a bootable USB drive. - * :ref:`bootable-usb-beta-all` + * :ref:`bootable-usb` #. After downloading the image, verify and decompress the file per your OS. 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 deleted file mode 100644 index 5c5d3014..00000000 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-beta-all.rst +++ /dev/null @@ -1,203 +0,0 @@ -.. _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 :ref:`get-started` - -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:`get-started` - -.. _Rufus: https://rufus.ie/ diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst deleted file mode 100644 index 5df94cee..00000000 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-linux.rst +++ /dev/null @@ -1,105 +0,0 @@ -.. _bootable-usb-linux: - -Create a bootable USB drive on Linux\* -###################################### - -Follow these instructions to create a bootable |CL-ATTR| USB drive. -Use an **8GB** or larger USB drive. Download either a live image, -``clear--live.img.xz`` or an installer image, -``clear--installer.img.xz``, from our `image`_ download page. - -Instructions are also available for other operating systems: - -* :ref:`bootable-usb-mac` -* :ref:`bootable-usb-windows` - -.. include:: ../../reference/image-types.rst - :start-after: incl-image-filename: - :end-before: incl-image-filename-end: - -.. include:: ../../guides/maintenance/download-verify-decompress-linux.rst - :Start-after: verify-linux: - -.. _copy-usb-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 - -.. _usb-next: - -Next steps -********** - -With a bootable |CL| USB drive, you can: - -* :ref:`bare-metal-install` -* :ref:`boot-live-image` -* :ref:`multi-boot` - -.. _image: https://download.clearlinux.org/image -.. _releases: https://download.clearlinux.org/releases diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst deleted file mode 100644 index 3d55c209..00000000 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-mac.rst +++ /dev/null @@ -1,81 +0,0 @@ -.. _bootable-usb-mac: - -Create a bootable USB drive on macOS -#################################### - -Follow these instructions to create a bootable |CL-ATTR| USB drive. -Use an **8GB** or larger USB drive. Download either a live image, -``clear--live.img.xz`` or an installer image, -``clear--installer.img.xz``, from our `image`_ download page. - -Instructions are also available for other operating systems: - -* :ref:`bootable-usb-linux` -* :ref:`bootable-usb-windows` - -.. include:: ../../reference/image-types.rst - :start-after: incl-image-filename: - :end-before: incl-image-filename-end: - -.. 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 - -Next steps -********** - -With a bootable |CL| USB drive, you can: - -* :ref:`bare-metal-install` -* :ref:`boot-live-image` -* :ref:`multi-boot` - -.. _image: https://download.clearlinux.org/image diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst deleted file mode 100644 index 8a6d3dca..00000000 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb-windows.rst +++ /dev/null @@ -1,69 +0,0 @@ -.. _bootable-usb-windows: - -Create a bootable USB drive on Windows\* -######################################## - -Follow these instructions to create a bootable |CL-ATTR| USB drive. -Use an **8GB** or larger USB drive. Download either a live image, -``clear--live.img.xz`` or an installer image, -``clear--installer.img.xz``, from our `image`_ download page. - -Instructions are also available for other operating systems: - -* :ref:`bootable-usb-mac` -* :ref:`bootable-usb-linux` - -.. include:: ../../reference/image-types.rst - :start-after: incl-image-filename: - :end-before: incl-image-filename-end: - -.. 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 - -Next steps -********** - -With a bootable |CL| USB drive, you can: - -* :ref:`bare-metal-install` -* :ref:`boot-live-image` -* :ref:`multi-boot` - -.. _Rufus: http://rufus.akeo.ie/ -.. _image: https://download.clearlinux.org/image diff --git a/source/clear-linux/get-started/bootable-usb/bootable-usb.rst b/source/clear-linux/get-started/bootable-usb/bootable-usb.rst index f774b69c..edf05fd2 100644 --- a/source/clear-linux/get-started/bootable-usb/bootable-usb.rst +++ b/source/clear-linux/get-started/bootable-usb/bootable-usb.rst @@ -1,32 +1,192 @@ .. _bootable-usb: -Create a bootable |CL-ATTR| USB drive -##################################### +Create a bootable USB drive +########################### Instructions to create a |CL-ATTR| USB drive vary depending on your operating -system. +system. Follow the instructions applicable to your system: -.. _download-usb-image: +* :ref:`bootable-usb-linux` +* :ref:`bootable-usb-mac` +* :ref:`bootable-usb-windows` -Download the latest |CL| image -****************************** +Prerequisites +************* -There are 2 types of |CL| images suitable for burning onto and running -off a USB drive: +* Use an **8GB** or larger USB drive. +* `Download`_ the |CL| live boot image or interactive installer image. -* Live image: :file:`clear-[version number]-live.img.xz` -* Installer image: :file:`clear-[version number]-installer.img.xz` +.. _bootable-usb-linux: -Go to the |CL| `image`_ repository and download the desired type. +Create a bootable USB drive on Linux\* +************************************** -With the appropriate image downloaded, choose the step-by-step instructions -applicable to your system: +Make sure you have have completed all `Prerequisites`_. -.. toctree:: - :maxdepth: 1 +Before burning the image onto your USB drive, +:ref:`verify and decompress your image `. - bootable-usb-linux - bootable-usb-windows - bootable-usb-mac +Burn the |CL| image onto a USB drive +==================================== -.. _image: https://download.clearlinux.org/image +.. 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 you can burn 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 ``: + + .. code-block:: bash + + dd if=./clear-[version number]-[image type] of= bs=4M status=progress + +.. _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 `. + +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-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. 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 ``: + + .. code-block:: bash + + sudo dd if=./clear-[version number]-[image type] of= bs=4m + + To speed up the imaging process, add an ‘r’ in front of the disk identifier. + For example `/dev/rdisk2`. + + Press :kbd:`-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 `. + +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. + +#. 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-3.png + :scale: 80 % + :alt: Rufus utility + + Figure 2: Rufus utility + + +.. _Rufus: https://rufus.ie/ +.. _Download: https://clearlinux.org/downloads diff --git a/source/clear-linux/get-started/get-started.rst b/source/clear-linux/get-started/get-started.rst index 15ebfb9b..6b0b2148 100644 --- a/source/clear-linux/get-started/get-started.rst +++ b/source/clear-linux/get-started/get-started.rst @@ -17,7 +17,6 @@ Pre-install compatibility-check bootable-usb/bootable-usb - bootable-usb/bootable-usb-beta-all Install |CL| ************ diff --git a/source/substitutions.txt b/source/substitutions.txt index 24330b4c..6790a2c3 100644 --- a/source/substitutions.txt +++ b/source/substitutions.txt @@ -7,4 +7,5 @@ .. |CC| replace:: Clear Containers .. |CAUTION-BACKUP-USB| replace:: - Burning an image formats the USB drive, thus destroying all existing content. Backup your data before proceeding. + Burning an image formats the USB drive, and will destroy all pre-existing + content. Back up your data before proceeding.