2021-10-12 18:45:00 +00:00
# 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:
2021-12-10 17:06:45 +00:00
* **V3 HAT (Patron, Kickstarter, and future editions)**
* [PiKVM v3 HAT (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 >
2021-10-12 18:45:00 +00:00
* **DIY - Raspberry Pi 4, v2 platform:**
2021-10-22 00:59:27 +00:00
* [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 >
2021-11-20 13:04:32 +00:00
* **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:**
2021-10-22 00:59:27 +00:00
* [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 >
2021-10-12 18:45:00 +00:00
2021-11-20 13:04:32 +00:00
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 ).
2021-10-12 18:45:00 +00:00
## Flash the image
!!! tip
2021-11-25 18:56:57 +00:00
Ignore request to format your sd card, this step is not nessessary. Choose the most suitable method for you
2021-10-12 18:45:00 +00:00
### Using Linux CLI
2021-12-27 00:57:58 +00:00
Decompress and flash the image. **Be careful when choosing the device path, it may be different on your OS** :
2021-10-22 02:19:15 +00:00
2021-10-12 18:45:00 +00:00
```
2021-10-22 00:59:27 +00:00
# xz --decompress v2-hdmi-rpi4-latest.img.xz
2021-10-17 05:20:15 +00:00
# dd if=v2-hdmi-rpi4-latest.img of=/dev/mmcblkX
2021-10-12 18:45:00 +00:00
```
2021-10-22 02:19:15 +00:00
You can also use `dd_rescue` or `ddrescue` .
2021-10-12 18:45:00 +00:00
2021-12-09 09:25:49 +00:00
!!! warning "Check the advanced settings (CTRL+SHIFT+X), make sure they are blank or the flash will fail"
2021-10-12 18:45:00 +00:00
2021-10-22 02:19:15 +00:00
### Using RPi Imager (Linux, MacOS and Windows)
2021-10-12 18:45:00 +00:00
2021-10-22 02:19:15 +00:00
1. Download and install **the latest version** of [RPi Imager ](https://github.com/raspberrypi/rpi-imager/releases ).
2021-10-12 18:45:00 +00:00
2021-10-22 02:19:15 +00:00
2. Run RPi Imager:
2021-10-12 18:45:00 +00:00
2021-10-25 14:53:00 +00:00
< img src = "imager-1.jpg" width = "400" / >
2021-10-12 18:45:00 +00:00
2021-10-22 02:19:15 +00:00
3. Press **CHOOSE OS** and select **Use custom** image at bottom of the list:
2021-10-12 18:45:00 +00:00
2021-10-25 14:53:00 +00:00
< img src = "imager-2.jpg" width = "400" / >
2021-10-12 18:45:00 +00:00
2021-10-22 02:19:15 +00:00
4. After clicking on this item, select the image file (`.img.xz`), then click **CHOOSE STORAGE** :
2021-10-12 18:45:00 +00:00
2021-10-25 14:53:00 +00:00
< img src = "imager-3.jpg" width = "400" / >
2021-10-12 18:45:00 +00:00
2021-10-22 02:19:15 +00:00
5. Insert the memory card into the card reader. Choose the card reader from this list. **Be careful** and choose the right device:
2021-10-12 18:45:00 +00:00
2021-10-25 14:53:00 +00:00
< img src = "imager-4.jpg" width = "400" / >
2021-10-12 18:45:00 +00:00
2021-10-22 02:19:15 +00:00
6. After choosing the memory card, press the **WRITE** button. Confirm the operation when you are asked about it:
2021-10-12 18:45:00 +00:00
2021-10-25 14:53:00 +00:00
< img src = "imager-5.jpg" width = "400" / >
2021-10-12 18:45:00 +00:00
2021-10-22 02:19:15 +00:00
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
2021-10-25 14:53:00 +00:00
< img src = "imager-6.jpg" width = "400" / >
2021-10-22 02:19:15 +00:00
8. Remove the memory card after successful completion:
2021-10-25 14:53:00 +00:00
< img src = "imager-7.jpg" width = "400" / >
2021-10-22 02:19:15 +00:00
!!! tip
If an error occurs during flashing or booting PiKVM, repeat the process.
2021-12-09 16:56:44 +00:00
When you have completed these steps, please move to the [First Steps doc. ](https://docs.pikvm.org/first_steps/ )
