From 96d947ea3dcece2fe8317e5e207fa74a80e62ab5 Mon Sep 17 00:00:00 2001 From: Alasdair Allan Date: Sun, 24 Apr 2022 15:23:01 +0100 Subject: [PATCH 1/5] Deleted all non-Imager installation paths --- .../asciidoc/computers/getting-started.adoc | 11 +-- .../installing-from-an-image.adoc | 2 +- .../installing-from-chromeos.adoc | 14 --- .../installing-from-linux.adoc | 89 ------------------- .../getting-started/installing-from-mac.adoc | 84 ----------------- .../installing-from-windows.adoc | 32 ------- 6 files changed, 2 insertions(+), 230 deletions(-) delete mode 100644 documentation/asciidoc/computers/getting-started/installing-from-chromeos.adoc delete mode 100644 documentation/asciidoc/computers/getting-started/installing-from-linux.adoc delete mode 100644 documentation/asciidoc/computers/getting-started/installing-from-mac.adoc delete mode 100644 documentation/asciidoc/computers/getting-started/installing-from-windows.adoc diff --git a/documentation/asciidoc/computers/getting-started.adoc b/documentation/asciidoc/computers/getting-started.adoc index 25c64d2c3..66e2c8b6d 100644 --- a/documentation/asciidoc/computers/getting-started.adoc +++ b/documentation/asciidoc/computers/getting-started.adoc @@ -2,15 +2,6 @@ include::getting-started/setting-up.adoc[] include::getting-started/installing-from-an-image.adoc[] -include::getting-started/configuring.adoc[] - include::getting-started/network-installation.adoc[] -include::getting-started/installing-from-chromeos.adoc[] - -include::getting-started/installing-from-linux.adoc[] - -include::getting-started/installing-from-mac.adoc[] - -include::getting-started/installing-from-windows.adoc[] - +include::getting-started/configuring.adoc[] diff --git a/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc b/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc index 00a7018ef..3f5daac59 100644 --- a/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc +++ b/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc @@ -1,6 +1,6 @@ == Installing the Operating System -Raspberry Pi recommend the use of https://www.raspberrypi.com/software/[Raspberry Pi Imager] to install an operating system on your SD card. You will need another computer with an SD card reader to install the image. +Raspberry Pi recommend the use of https://www.raspberrypi.com/software/[Raspberry Pi Imager] to install an operating system on your SD card. You will need another computer with an SD card reader to install the image. Rapsberry Pi Imager can be run on another Raspberry Pi, but also works on Microsoft Windows, Apple macOS, and Linux. NOTE: Before you start, don't forget to check the xref:getting-started.adoc#sd-cards[SD card requirements]. diff --git a/documentation/asciidoc/computers/getting-started/installing-from-chromeos.adoc b/documentation/asciidoc/computers/getting-started/installing-from-chromeos.adoc deleted file mode 100644 index 94639e75e..000000000 --- a/documentation/asciidoc/computers/getting-started/installing-from-chromeos.adoc +++ /dev/null @@ -1,14 +0,0 @@ -== Installing Images on Chrome OS - -The easiest way to write images to an SD card and USB drives with Chrome OS is to use the official https://chrome.google.com/webstore/detail/chromebook-recovery-utili/jndclpdbaamdhonoechobihbbiimdgai[Chromebook Recovery Utility]. It can be used to create Chromebook Recovery media, and it will also accept `.zip` files containing images. - -* Download the https://chrome.google.com/webstore/detail/chromebook-recovery-utili/pocpnlppkickgojjlmhdmidojbmbodfm[Chromebook Recovery Utility]. -* Download the https://www.raspberrypi.com/software/operating-systems/#raspberry-pi-os-32-bit[Raspberry Pi OS] zip archive. -* Launch the *Recovery Utility* -* Click on the *Settings Gears* icon in the upper right-hand corner, next to the window close icon. -* Select the *Use Local Image* option. -* Choose the `.zip` file you downloaded. -* Insert the SD card and click *Continue*. -* Read the warning and click the *Create now* button. -* Wait for the progress bar to complete twice (for unpacking and writing). This might take a few minutes. Once the process is complete, a big green checkmark will be shown. -* Close the program and eject the card. diff --git a/documentation/asciidoc/computers/getting-started/installing-from-linux.adoc b/documentation/asciidoc/computers/getting-started/installing-from-linux.adoc deleted file mode 100644 index 787d72130..000000000 --- a/documentation/asciidoc/computers/getting-started/installing-from-linux.adoc +++ /dev/null @@ -1,89 +0,0 @@ -== Installing Images on Linux - -xref:getting-started.adoc#using-raspberry-pi-imager[Raspberry Pi Imager] is typically the easiest option for most users to write images to SD cards, so it is a good place to start. If you're looking for more advanced options on Linux, you can use the standard command line tools below. - -NOTE: Using the `dd` tool can overwrite any partition of your machine. If you specify the wrong device when using `dd`, you could delete your primary Linux partition. Please be careful. - -[discrete] -==== Discovering the SD card mountpoint and unmounting it - -* Run `lsblk -p` to see which devices are currently connected to your machine. -* If your computer has a slot for SD cards, insert the card. If not, insert the card into an SD card reader, then connect the reader to your computer. -* Run `lsblk -p` again. The new device that has appeared is your SD card (you can also usually tell from the listed device size). The naming of the device will follow the format described in the next paragraph. -* The left column of the results from the `lsblk -p` command gives the device name of your SD card and the names of any partitions on it (usually only one, but there may be several if the card was previously used). It will be listed as something like `/dev/mmcblk0` or `/dev/sdX` (with partition names `/dev/mmcblk0p1` or `/dev/sdX1` respectively), where `X` is a lower-case letter indicating the device (eg. `/dev/sdb1`). The right column shows where the partitions have been mounted (if they haven't been, it will be blank). -* If any partitions on the SD card have been mounted, unmount them all with `umount`, for example `umount /dev/sdX1` (replace `sdX1` with your SD card's device name, and change the number for any other partitions). - -[discrete] -==== Copying the image to the SD card - -* In a terminal window, write the image to the card with the command below, making sure you replace the input file `if=` argument with the path to your `.img` file, and the `/dev/sdX` in the output file `of=` argument with the correct device name. *This is very important, as you will lose all the data on the hard drive if you provide the wrong device name.* Make sure the device name is the name of the whole SD card as described above, not just a partition. For example: `sdd`, not `sdds1` or `sddp1`; `mmcblk0`, not `mmcblk0p1`. -+ -[,bash] ----- -sudo dd if=2021-10-30-raspios-bullseye-armhf.img of=/dev/sdX bs=4M conv=fsync ----- - -* Please note that block size set to `4M` will work most of the time. If not, try `1M`, although this will take considerably longer. - -[discrete] -==== Copying a zipped image to the SD card - -In Linux it is possible to combine the unzip and SD copying process into one command, which avoids any issues that might occur when the unzipped image is larger than 4GB. This can happen on certain filesystems that do not support files larger than 4GB (e.g. FAT), although it should be noted that most Linux installations do not use FAT and therefore do not have this limitation. - -The following command unzips the zip file (replace 2021-10-30-raspios-bullseye-armhf.zip with the appropriate zip filename), and pipes the output directly to the dd command. This in turn copies it to the SD card, as described in the previous section. - ----- -unzip -p 2021-10-30-raspios-bullseye-armhf.zip | sudo dd of=/dev/sdX bs=4M conv=fsync ----- - -[discrete] -==== Checking the image copy progress - -* By default, the `dd` command does not give any information about its progress, so it may appear to have frozen. It can take more some time to finish writing to the card. If your card reader has an LED, it may blink during the write process. -* To see the progress of the copy operation, you can run the dd command with the status option. -+ ----- - sudo dd if=2021-10-30-raspios-bullseye-armhf.img of=/dev/sdX bs=4M conv=fsync status=progress ----- - -* If you are using an older version of `dd`, the status option may not be available. You may be able to use the `dcfldd` command instead, which will give a progress report showing how much has been written. Another method is to send a USR1 signal to `dd`, which will let it print status information. Find out the PID of `dd` by using `pgrep -l dd` or `ps a | grep dd`. Then use `kill -USR1 PID` to send the USR1 signal to `dd`. - -[discrete] -==== Optional: checking whether the image was correctly written to the SD card - -* After `dd` has finished copying, you can check what has been written to the SD card by `dd`-ing from the card back to another image on your hard disk, truncating the new image to the same size as the original, and then running `diff` (or `md5sum`) on those two images. -* If the SD card is much larger than the image, you don't want to read back the whole SD card, since it will be mostly empty. So you need to check the number of blocks that were written to the card by the `dd` command. At the end of its run, `dd` will have displayed the number of blocks written as follow: -+ ----- -xxx+0 records in -yyy+0 records out -yyyyyyyyyy bytes (yyy kB, yyy KiB) copied, 0.00144744 s, 283 MB/s ----- -+ -We need the number `xxx`, which is the block count. We can ignore the `yyy` numbers. - -* Copy the SD card content to an image on your hard drive using `dd` again: -+ -[,bash] ----- -sudo dd if=/dev/sdX of=from-sd-card.img bs=4M count=xxx ----- -+ -`if` is the input file (i.e. the SD card device), `of` is the output file to which the SD card content is to be copied (called `from-sd-card.img` in this example), and `xxx` is the number of blocks written by the original `dd` operation. - -* In case the SD card image is still larger than the original image, truncate the new image to the size of the original image using the following command (replace the input file `reference` argument with the original image name): -+ -[,bash] ----- -truncate --reference 2021-10-30-raspios-bullseye-armhf.img from-sd-card.img ----- - -* Compare the two images: `diff` should report that the files are identical. -+ -[,bash] ----- -diff -s from-sd-card.img 2021-10-30-raspios-bullseye-armhf.img ----- - -* Run `sync`. This will ensure that the write cache is flushed and that it is safe to unmount your SD card. -* Remove the SD card from the card reader. diff --git a/documentation/asciidoc/computers/getting-started/installing-from-mac.adoc b/documentation/asciidoc/computers/getting-started/installing-from-mac.adoc deleted file mode 100644 index 7384b9b14..000000000 --- a/documentation/asciidoc/computers/getting-started/installing-from-mac.adoc +++ /dev/null @@ -1,84 +0,0 @@ -== Installing Images on Mac OS - -xref:getting-started.adoc#using-raspberry-pi-imager[Raspberry Pi Imager] is the recommended option for most users to write images to SD cards. However, if you do not want to use the Imager you can still copy an operating system to the card from the command line. - -[discrete] -==== Finding the SD Card - -Insert the SD card in the slot, or connect the SD card reader with the SD card inside, and type `diskutil list` at the command line. You should see something like this, - -[source,bash] ----- - /dev/disk0 (internal): - #: TYPE NAME SIZE IDENTIFIER - 0: GUID_partition_scheme 500.3 GB disk0 - 1: EFI EFI 314.6 MB disk0s1 - 2: Apple_APFS Container disk1 500.0 GB disk0s2 - - /dev/disk1 (synthesized): - #: TYPE NAME SIZE IDENTIFIER - 0: APFS Container Scheme - +500.0 GB disk1 - Physical Store disk0s2 - 1: APFS Volume Macintosh HD 89.6 GB disk1s1 - 2: APFS Volume Preboot 47.3 MB disk1s2 - 3: APFS Volume Recovery 510.4 MB disk1s3 - 4: APFS Volume VM 3.6 GB disk1s4 - - /dev/disk2 (external, physical): - #: TYPE NAME SIZE IDENTIFIER - 0: FDisk_partition_scheme *15.9 GB disk2 - 1: Windows_FAT_32 boot 268.4 MB disk2s1 - 2: Linux 15.7 GB disk2s2 ----- - -Here the SD Card is `/dev/disk2` however your disk and partition list may vary. - -[discrete] -==== Copying the Image - -WARNING: Using the `dd` command line tool can overwrite your Mac's operating system if you specify the wrong disk device. If you're not sure about what to do, we recommend you use the https://www.raspberrypi.com/software/[Raspberry Pi Imager] tool. - -Before copying the image you should unmount the SD Card. - -[source,bash] ----- -diskutil unmountDisk /dev/diskN ----- - -You can then copy the image, - -[source,bash] ----- -sudo dd bs=1m if=path_of_your_image.img of=/dev/rdiskN; sync ----- - -replacing `N` with the disk number. - -NOTE: You should use `rdisk` (which stands for 'raw disk') instead of `disk`, this speeds up the copying. - -This can take a few minutes, depending on the image file size. You can check the progress by pressing `Ctrl+T`. After the `dd` command finishes, you can eject the card: - -[source,bash] ----- -sudo diskutil eject /dev/rdiskN ----- - -[discrete] -==== Troubleshooting - -* If the command reports `dd: /dev/rdiskN: Resource busy`, you need to unmount the volume first `sudo diskutil unmountDisk /dev/diskN`. - -* If the command reports `dd: bs: illegal numeric value`, change the block size `bs=1m` to `bs=1M`. - -* If the command reports `dd: /dev/rdiskN: Operation not permitted`, go to `System Preferences` \-> `Security & Privacy` \-> `Privacy` \-> `Files and Folders` \-> `Give Removable Volumes access to Terminal`. - -* If the command reports `dd: /dev/rdiskN: Permission denied`, the partition table of the SD card is being protected against being overwritten by mac OS. -+ -Erase the SD card's partition table using this command: -+ -[source,bash] ----- -sudo diskutil partitionDisk /dev/diskN 1 MBR "Free Space" "%noformat%" 100% ----- -+ -That command will also set the permissions on the device to allow writing. diff --git a/documentation/asciidoc/computers/getting-started/installing-from-windows.adoc b/documentation/asciidoc/computers/getting-started/installing-from-windows.adoc deleted file mode 100644 index e2a955473..000000000 --- a/documentation/asciidoc/computers/getting-started/installing-from-windows.adoc +++ /dev/null @@ -1,32 +0,0 @@ -== Installing Images on Windows - -xref:getting-started.adoc#using-raspberry-pi-imager[Raspberry Pi Imager] is our recommended option for most users to write images to SD cards, so it is a good place to start. If you're looking for an alternative on Windows, you can use balenaEtcher, Win32DiskImager or imgFlasher. - -[discrete] -==== balenaEtcher - -* Download the Windows installer from https://www.balena.io/etcher/[balena.io] -* Run balenaEtcher and select the unzipped Raspberry Pi OS image file -* Select the SD card drive -* Finally, click *Burn* to write the Raspberry Pi OS image to the SD card -* You'll see a progress bar. Once complete, the utility will automatically unmount the SD card so it's safe to remove it from your computer. - -[discrete] -==== Win32DiskImager - -* Insert the SD card into your SD card reader. You can use the SD card slot if you have one, or an SD adapter in a USB port. Note the drive letter assigned to the SD card. You can see the drive letter in the left hand column of Windows Explorer, for example *G:* -* Download the Win32DiskImager utility from the http://sourceforge.net/projects/win32diskimager/[Sourceforge Project page] as an installer file, and run it to install the software. -* Run the `Win32DiskImager` utility from your desktop or menu. -* Select the image file you extracted earlier. -* In the device box, select the drive letter of the SD card. Be careful to select the correct drive: if you choose the wrong drive you could destroy the data on your computer's hard disk! If you are using an SD card slot in your computer, and can't see the drive in the Win32DiskImager window, try using an external SD adapter. -* Click 'Write' and wait for the write to complete. -* Exit the imager and eject the SD card. - -[discrete] -==== Upswift imgFlasher - -* Download portable Windows version from https://www.upswift.io/imgflasher/[upswift.io] -* Run imgFlasher and choose an image or zip file -* Choose SD card or USB drive -* Click on 'Flash' -* Wait until the flash is completed. From 7a172e080b70fecf2277f3aec794cdc575a99dec Mon Sep 17 00:00:00 2001 From: Alasdair Allan Date: Sun, 24 Apr 2022 15:26:20 +0100 Subject: [PATCH 2/5] Cleaned up reference to deleted section --- .../asciidoc/computers/compute-module/cm-emmc-flashing.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc index 4b141367a..7608df8d7 100644 --- a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc +++ b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc @@ -101,7 +101,7 @@ For more information run ==== Writing to the eMMC (Windows) -After `rpiboot` completes, a new USB mass storage drive will appear in Windows. We recommend following this xref:getting-started.adoc#installing-images-on-windows[guide] and using Win32DiskImager to write images to the drive, rather than trying to use `/dev/sda` etc. from Cygwin. +After `rpiboot` completes, a new USB mass storage drive will appear in Windows. We recommend using https://www.raspberrypi.com/software/[Raspberry Pi Imager] to write images to the drive, rather than trying to use `/dev/sda` etc. from Cygwin. Make sure J4 (USB SLAVE BOOT ENABLE) / J2 (nRPI_BOOT) is set to the disabled position and/or nothing is plugged into the USB slave port. Power cycling the IO board should now result in the Compute Module booting from eMMC. From b864ae2e9867a374dc363a348747969e4b3c1fc1 Mon Sep 17 00:00:00 2001 From: Andrew Scheller Date: Mon, 25 Apr 2022 13:48:58 +0100 Subject: [PATCH 3/5] typo --- .../computers/getting-started/installing-from-an-image.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc b/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc index 3f5daac59..548ee204f 100644 --- a/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc +++ b/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc @@ -1,6 +1,6 @@ == Installing the Operating System -Raspberry Pi recommend the use of https://www.raspberrypi.com/software/[Raspberry Pi Imager] to install an operating system on your SD card. You will need another computer with an SD card reader to install the image. Rapsberry Pi Imager can be run on another Raspberry Pi, but also works on Microsoft Windows, Apple macOS, and Linux. +Raspberry Pi recommend the use of https://www.raspberrypi.com/software/[Raspberry Pi Imager] to install an operating system on your SD card. You will need another computer with an SD card reader to install the image. Raspberry Pi Imager can be run on another Raspberry Pi, but also works on Microsoft Windows, Apple macOS, and Linux. NOTE: Before you start, don't forget to check the xref:getting-started.adoc#sd-cards[SD card requirements]. From d23d08bf352e4158907a22a135a204fdeeb518a3 Mon Sep 17 00:00:00 2001 From: Alasdair Allan Date: Fri, 29 Apr 2022 10:29:22 +0100 Subject: [PATCH 4/5] Update cm-emmc-flashing.adoc --- .../asciidoc/computers/compute-module/cm-emmc-flashing.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc index 7608df8d7..874b3c0ad 100644 --- a/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc +++ b/documentation/asciidoc/computers/compute-module/cm-emmc-flashing.adoc @@ -101,7 +101,7 @@ For more information run ==== Writing to the eMMC (Windows) -After `rpiboot` completes, a new USB mass storage drive will appear in Windows. We recommend using https://www.raspberrypi.com/software/[Raspberry Pi Imager] to write images to the drive, rather than trying to use `/dev/sda` etc. from Cygwin. +After `rpiboot` completes, a new USB mass storage drive will appear in Windows. We recommend using https://www.raspberrypi.com/software/[Raspberry Pi Imager] to write images to the drive. Make sure J4 (USB SLAVE BOOT ENABLE) / J2 (nRPI_BOOT) is set to the disabled position and/or nothing is plugged into the USB slave port. Power cycling the IO board should now result in the Compute Module booting from eMMC. From 7b30c724bdc9f36db1fb061e422ba2e2f44ef86b Mon Sep 17 00:00:00 2001 From: Alasdair Allan Date: Fri, 29 Apr 2022 10:30:48 +0100 Subject: [PATCH 5/5] Update installing-from-an-image.adoc --- .../computers/getting-started/installing-from-an-image.adoc | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc b/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc index 548ee204f..c9390a41d 100644 --- a/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc +++ b/documentation/asciidoc/computers/getting-started/installing-from-an-image.adoc @@ -1,6 +1,6 @@ == Installing the Operating System -Raspberry Pi recommend the use of https://www.raspberrypi.com/software/[Raspberry Pi Imager] to install an operating system on your SD card. You will need another computer with an SD card reader to install the image. Raspberry Pi Imager can be run on another Raspberry Pi, but also works on Microsoft Windows, Apple macOS, and Linux. +Raspberry Pi recommend the use of https://www.raspberrypi.com/software/[Raspberry Pi Imager] to install an operating system on to your SD card. You will need another computer with an SD card reader to install the image. Raspberry Pi Imager can be run on another Raspberry Pi, but also works on Microsoft Windows, Apple macOS, and Linux. NOTE: Before you start, don't forget to check the xref:getting-started.adoc#sd-cards[SD card requirements].