- v2 DIY owners: Please follow this [first](https://github.com/pikvm/pikvm)<br>
- v3 HAT *or* pre-assembled users: Please follow this [first](https://docs.pikvm.org/v3/)<br>
- V2 DIY owners: Please follow this [first](https://github.com/pikvm/pikvm)<br>
- V3 HAT *or* pre-assembled users: Please follow this [first](https://docs.pikvm.org/v3/)<br>
- For both to work and display a video, your target system needs to be configured for the following:<br>
1920x1080p50Hz (In some rare instances, try 30hz)<br>
1600x1200p60Hz<br>
@ -38,9 +38,10 @@
!!! warning "Do not turn off the device until it's fully booted for the first time"
After turning on the power, PiKVM OS will generate unique SSH keys and certificates and will perform all necessary operations on the memory card.
## Getting access to PiKVM
By default, PiKVM receives a dynamic IP address via DHCP.
By default, PiKVM receives a dynamic IP address via DHCP. V3+ devices show IP on the built-in display. If you don't have a display, use the tips below:
??? example "Finding PiKVM in the network"
To determine the IP address of your PiKVM, use one of the following methods:
@ -100,6 +101,7 @@ For future examples, let's assume that your PiKVM has received the address **192
Optionally you can enable the [two-factor authentication](auth.md#two-factor-authentication).
## Configuring PiKVM
Most of the PiKVM settings are done through configuration files. All configuration changes must be made from under the `root` user (= the administrator).
* **Learn about the [basics of working with PiKVM](first_steps.md).**
* If you are a happy **PiKVM v3 HAT** user then we have a [special guide for you](v3.md).
* If you are a happy **PiKVM V4/V3** owner then we have some special guides for you:
* [PiKVM V4 Mini & Plus](v4.md)
* [PiKVM V3 HAT / Pre-Assembled](v3.md)
* **Explore the features of PiKVM** using the site's table of contents.
* **If you encounter a problem**, take a look at the **[FAQ](faq.md)**, but if nothing helped, contact our **[Discord chat](https://discord.gg/bpmXfz5)** - experienced users and the PiKVM team will definitely help you.
If you have a kit without a metal case, you can use our free 3D printing case drawing: [V3.3](stl/v3.3/index.md){target=_blank} for the Kickstarter/Store model, [V3.2](stl/v3.2/index.md){target=_blank} for the pre-release.
!!! warning "Please use the V3 image, V2 image is not compatible"
1. **[Flash the memory card.](flashing_os.md){target=_blank}**
1. **[Flash the memory card.](flashing_os.md){target=_blank}**. Please use the V3 image, V2 image is not compatible.
2. **Build PiKVM** according to the video instruction or review the [illustrated instructions](v3_illustrated_install_instructions.md):
@ -50,11 +48,11 @@ If you have a kit without a metal case, you can use our free 3D printing case dr
* **HDMI input** and **USB emulation** port must be connected to the computer. [**ATX** too](atx_board.md), but it's optional. There should be no USB hub between PiKVM and the computer, as some UEFI/BIOS cannot detect them at the boot stage. On the HDMI the HAT, like the CSI bridge, supports 1080p50Hz or 720p60Hz or lower.
* **HDMI input** and **USB emulation** port must be connected to the computer. Optionally, the **[ATX port](atx_board.md)** can be connected to control the power. There should be no USB hub between PiKVM and the computer, as some UEFI/BIOS cannot detect them at the boot stage. On the HDMI the HAT, like the CSI bridge, supports 1080p50Hz or 720p60Hz or lower.
* Connect **Ethernet** to the network and **USB power** to the Raspberry Pi power supply.
4. **Carefully read [the "First steps" guide](first_steps.md){target=_blank}** - how to find a device on the network, how to log in there, change passwords, and so on. **Follow the steps described there and come back here**.
4. **Carefully read [the "First steps" guide](first_steps.md){target=_blank}** - how to find a device on the network, how to log in there, change passwords, and so on. **Follow the steps described there and come back to this page**.
5. ??? note "If your kit includes the OLED display and/or the fan, you'll need to turn them on (this is only needed for the older V3 image for the HAT, in the box image everything is enabled by default)"
Log in to PiKVM and run these commands:
@ -75,7 +73,7 @@ If you have a kit without a metal case, you can use our free 3D printing case dr
And run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the pikvm.
And run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
7. !!! danger "Just reminding again: CHANGE THE PASSWORDS! :)"
How to do this was written in [the "First steps" guide](first_steps.md){target=_blank}
@ -90,6 +88,8 @@ If you have a kit without a metal case, you can use our free 3D printing case dr
11. **You can also try the experimental [audio forwarding](audio.md){target=_blank}**.
12. Explore the features of PiKVM using the site's table of contents and have fun!
## ATX connection
@ -149,6 +149,6 @@ If you have a kit without a metal case, you can use our free 3D printing case dr
## Known issues and limitations
* The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~20-24 FPS for 1080p over LAN**.
* The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~24-28 FPS for 1080p over LAN**.
* There may be **compatibility** issues with some motherboards (such as **HP** or **DELL**) which are the same as those that exist with PiKVM V2. Not everything is perfect, but if you have already used PiKVM V2 - our new V3 will work great and please you. If there is no image from the BIOS, you can fine-tune the HDMI settings, but it is possible that the Mass Storage devices will not be available in the BIOS.
* **HDMI input** (the **bottom right** on the **back** side) and **OTG** port (USB emulation) should be connected to the computer. Optionally, the **[ATX port](atx_board.md)** can be connected to control the power. There should be no USB hub between PiKVM and the computer, as some UEFI/BIOS cannot detect them at the boot stage.
[See here](atx_board.md).
* Connect **Ethernet** (**bottom right** on the **front** size) to the network.
* Use the power supply and turn on PiKVM. The Mini comes with USB-C 5V power supply, and Plus with Barrel 12V. Use the appropriate connector on the **front** side. Please note that Plus can also work from 5V, in this case, do not connect a 12V power supply and don't create a significant power load on USB (external flash sticks, cameras, and so on).
2. Wait until PiKVM starts and shows a greeting on the built-in display. Do not turn off the device until it's fully booted for the first time.
3. **Carefully read [the "First steps" guide](first_steps.md){target=_blank}** - how to find a device on the network, how to log in there, change passwords, and so on. **Follow the steps described there and come back to this page**.
4. ??? note "Using Fahrenheit instead of Celsius on the OLED"
And run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
5. !!! danger "Just reminding again: CHANGE THE PASSWORDS! :)"
How to do this was written in [the "First steps" guide](first_steps.md){target=_blank}
## IO ports and jumpers
6. **Try to manage the computer using PiKVM with the Web Interface.** Make sure that you get an image and both keyboard and mouse are working. If something doesn't work, check out our [FAQ](faq.md) (it's really useful). If nothing helped, you can get support in our [Discord chat](https://discord.gg/bpmXfz5).
TODO
7. Explore the features of PiKVM using the site's table of contents and have fun!
## ATX connection
[See here](atx_board.md).
## Known issues and limitations
* The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~20-24 FPS for 1080p over LAN**.
* The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~24-28 FPS for 1080p over LAN**.
* There may be **compatibility** issues with some motherboards (such as **HP** or **DELL**) which are the same as those that exist with PiKVM V2. Not everything is perfect, but if you have already used PiKVM V2 - our new V4 will work great and please you. If there is no image from the BIOS, you can fine-tune the HDMI settings, but it is possible that the Mass Storage devices will not be available in the BIOS.
Maxim Devaev
1 year ago
