You cannot select more than 25 topics Topics must start with a letter or number, can include dashes ('-') and can be up to 35 characters long.
pikvm/docs/flashing_os.md

85 lines
3.7 KiB
Markdown

3 years ago
# Flashing the OS image
!!! warning "Micro-SD Card Requirements"
* Minimum **16 Gb**
* **Class 10** is strongly recommended
## Download the image
Download the appropriate SD card image. Select it based on the board, platform, and the video capture device you are using:
* **V3 HAT (Patron, Kickstarter, Pre-Assembled and future editions)**
* [PiKVM v3 HAT BOX Image (Raspberry Pi 4) OLED/FAN preactivated](https://files.pikvm.org/images/v3-hdmi-rpi4-box-latest.img.xz) <sub>- [*sha1*](https://files.pikvm.org/images/v3-hdmi-rpi4-box-latest.img.xz.sha1)
* [PiKVM v3 HAT DIY Assembly (Raspberry Pi 4)](https://files.pikvm.org/images/v3-hdmi-rpi4-latest.img.xz) <sub>- [*sha1*](https://files.pikvm.org/images/v3-hdmi-rpi4-latest.img.xz.sha1)</sub>
3 years ago
* **DIY - Raspberry Pi 4, v2 platform:**
3 years ago
* [For HDMI-CSI bridge](https://files.pikvm.org/images/v2-hdmi-rpi4-latest.img.xz) <sub>- [*sha1*](https://files.pikvm.org/images/v2-hdmi-rpi4-latest.img.xz.sha1)</sub>
* [For HDMI-USB dongle](https://files.pikvm.org/images/v2-hdmiusb-rpi4-latest.img.xz) <sub>- [*sha1*](https://files.pikvm.org/images/v2-hdmiusb-rpi4-latest.img.xz.sha1)</sub>
3 years ago
* **DIY - Raspberry Pi Zero 2 W, v2 platform:**
* [For HDMI-CSI bridge](https://files.pikvm.org/images/v2-hdmi-zero2w-latest.img.xz) <sub>- [*sha1*](https://files.pikvm.org/images/v2-hdmi-zero2w-latest.img.xz.sha1)</sub>
* **DIY - Raspberry Pi Zero W (legacy), v2 platform:**
3 years ago
* [For HDMI-CSI bridge](https://files.pikvm.org/images/v2-hdmi-zerow-latest.img.xz) <sub>- [*sha1*](https://files.pikvm.org/images/v2-hdmi-zerow-latest.img.xz.sha1)</sub>
3 years ago
3 years ago
Pre-compiled images are only available for the Raspberry Pi 4 and Zero (2) W. For all other cases, you will need to build the operating system yourself. But don't worry, it's [very simple](building_os.md).
3 years ago
## Flash the image
!!! tip
Ignore request to format your sd card, this step is not nessessary. Choose the most suitable method for you
3 years ago
### Using Linux CLI
3 years ago
Decompress and flash the image. **Be careful when choosing the device path, it may be different on your OS**:
3 years ago
3 years ago
```
3 years ago
# xz --decompress v2-hdmi-rpi4-latest.img.xz
3 years ago
# dd if=v2-hdmi-rpi4-latest.img of=/dev/mmcblkX
3 years ago
```
3 years ago
You can also use `dd_rescue` or `ddrescue`.
3 years ago
!!! warning "Check the advanced settings (CTRL+SHIFT+X), make sure they are blank or the flash will fail"
3 years ago
3 years ago
### Using RPi Imager (Linux, MacOS and Windows)
3 years ago
3 years ago
1. Download and install **the latest version** of [RPi Imager](https://github.com/raspberrypi/rpi-imager/releases).
3 years ago
3 years ago
2. Run RPi Imager:
3 years ago
3 years ago
<img src="imager-1.jpg" width="400" />
3 years ago
3 years ago
3. Press **CHOOSE OS** and select **Use custom** image at bottom of the list:
3 years ago
3 years ago
<img src="imager-2.jpg" width="400" />
3 years ago
3 years ago
4. After clicking on this item, select the image file (`.img.xz`), then click **CHOOSE STORAGE**:
3 years ago
3 years ago
<img src="imager-3.jpg" width="400" />
3 years ago
3 years ago
5. Insert the memory card into the card reader. Choose the card reader from this list. **Be careful** and choose the right device:
3 years ago
3 years ago
<img src="imager-4.jpg" width="400" />
3 years ago
3 years ago
6. After choosing the memory card, press the **WRITE** button. Confirm the operation when you are asked about it:
3 years ago
3 years ago
<img src="imager-5.jpg" width="400" />
3 years ago
3 years ago
7. Wait for the process to finish. Get yourself a coffee or do some stretching :)
!!! tip
The process may hang at 99% for a long time, this is okay, just wait for it to complete
3 years ago
<img src="imager-6.jpg" width="400" />
3 years ago
8. Remove the memory card after successful completion:
3 years ago
<img src="imager-7.jpg" width="400" />
3 years ago
!!! tip
If an error occurs during flashing or booting PiKVM, repeat the process.
!!! warning "If you encounter errors after flashing, reflash or use a different SD card."
When you have completed these steps, please move to the [First Steps doc.](https://docs.pikvm.org/first_steps/)