Archives/pikvm
2
0
Fork 0
mirror of https://github.com/pikvm/pikvm synced 2024-11-01 09:20:17 +00:00
Code Issues Projects Releases Wiki Activity
47ae4f8e97
pikvm/docs/flashing_os.md

81 lines
3.3 KiB
Markdown
Raw Normal View History

docs.pikvm.org
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:
xz images
2021-10-22 00:59:27 +00:00
* [**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>
docs.pikvm.org
2021-10-12 18:45:00 +00:00
* **DIY - Raspberry Pi 4, v2 platform:**
xz images
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>
zero2w
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:**
xz images
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>
docs.pikvm.org
2021-10-12 18:45:00 +00:00
zero2w
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).
docs.pikvm.org
2021-10-12 18:45:00 +00:00
## Flash the image
!!! tip
Update flashing_os.md (#545) Added verbiage for clarity
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
docs.pikvm.org
2021-10-12 18:45:00 +00:00
### Using Linux CLI
Decompress and flash the image. Be careful when choosing your device path:
using rpi imager
2021-10-22 02:19:15 +00:00
docs.pikvm.org
2021-10-12 18:45:00 +00:00
```
xz images
2021-10-22 00:59:27 +00:00
# xz --decompress v2-hdmi-rpi4-latest.img.xz
fixed image name
2021-10-17 05:20:15 +00:00
# dd if=v2-hdmi-rpi4-latest.img of=/dev/mmcblkX
docs.pikvm.org
2021-10-12 18:45:00 +00:00
```
using rpi imager
2021-10-22 02:19:15 +00:00
You can also use `dd_rescue` or `ddrescue`.
docs.pikvm.org
2021-10-12 18:45:00 +00:00
Update flashing_os.md (#560) * Update flashing_os.md Added verbiage for clarity * Update flashing_os.md
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"
docs.pikvm.org
2021-10-12 18:45:00 +00:00
using rpi imager
2021-10-22 02:19:15 +00:00
### Using RPi Imager (Linux, MacOS and Windows)
docs.pikvm.org
2021-10-12 18:45:00 +00:00
using rpi imager
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).
docs.pikvm.org
2021-10-12 18:45:00 +00:00
using rpi imager
2021-10-22 02:19:15 +00:00
2. Run RPi Imager:
docs.pikvm.org
2021-10-12 18:45:00 +00:00
big pictures
2021-10-25 14:53:00 +00:00
<img src="imager-1.jpg" width="400" />
docs.pikvm.org
2021-10-12 18:45:00 +00:00
using rpi imager
2021-10-22 02:19:15 +00:00
3. Press **CHOOSE OS** and select **Use custom** image at bottom of the list:
docs.pikvm.org
2021-10-12 18:45:00 +00:00
big pictures
2021-10-25 14:53:00 +00:00
<img src="imager-2.jpg" width="400" />
docs.pikvm.org
2021-10-12 18:45:00 +00:00
using rpi imager
2021-10-22 02:19:15 +00:00
4. After clicking on this item, select the image file (`.img.xz`), then click **CHOOSE STORAGE**:
docs.pikvm.org
2021-10-12 18:45:00 +00:00
big pictures
2021-10-25 14:53:00 +00:00
<img src="imager-3.jpg" width="400" />
docs.pikvm.org
2021-10-12 18:45:00 +00:00
using rpi imager
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:
docs.pikvm.org
2021-10-12 18:45:00 +00:00
big pictures
2021-10-25 14:53:00 +00:00
<img src="imager-4.jpg" width="400" />
docs.pikvm.org
2021-10-12 18:45:00 +00:00
using rpi imager
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:
docs.pikvm.org
2021-10-12 18:45:00 +00:00
big pictures
2021-10-25 14:53:00 +00:00
<img src="imager-5.jpg" width="400" />
docs.pikvm.org
2021-10-12 18:45:00 +00:00
using rpi imager
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
big pictures
2021-10-25 14:53:00 +00:00
<img src="imager-6.jpg" width="400" />
using rpi imager
2021-10-22 02:19:15 +00:00
8. Remove the memory card after successful completion:
big pictures
2021-10-25 14:53:00 +00:00
<img src="imager-7.jpg" width="400" />
using rpi imager
2021-10-22 02:19:15 +00:00
!!! tip
If an error occurs during flashing or booting PiKVM, repeat the process.
Update flashing_os.md (#555) Added verbiage for clarification.
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/)
Reference in New Issue Copy Permalink