mirror of https://github.com/pikvm/pikvm.git
Quickstart guide updates (#1502)
* Skeleton of the rewritten v4 quick start page * Front matter, what's in the box, config update for material, placeholders * Separate DIP switches doc into a separate file * Separate USB 3.0 support doc into a separate file * Reorganize V4 quick start page a little * Mention the mirror mode * Supported on-box controls, placeholder image, doc update * Cosmetic fixes * Add F° and Basic Troubleshooting * Initial V3 docs update - Applied the same general structure as with V4 - Added front matter - Explained the HAT vs pre-assembled thing - Moved assembly bits to the assembly instructions page - Enhanced the assembly instructions page TODO: - The Interface part needs to be V3-specific (copy-pasted from V4) * Fix the interface part * Cleanup further steps * First shot at updating the V2 quickstart guide * Rename V3 guide's name in the sidebar * Add HW interface graphics * Finalize updating the V2 quickstart guide * Cosmetic fixes to V3 and V4 guides * Update the V1 quick start guide * Add wiring illustrations for V4 * Add basic front matter to the V1 quick start guide * Update First Steps * Add V3 illustrations * Vectorize the legends in V3 illustrations
This commit is contained in:
Aleksandr Prokudin
GitHub
parent
3218d63b32
commit
657db6c3f1
|
|
@ -0,0 +1,45 @@
|
|||
---
|
||||
title: Structure of configuration files
|
||||
description: "How PiKVM configuration files are structured"
|
||||
---
|
||||
|
||||
# Structure of configuration files
|
||||
|
||||
Most of the PiKVM configuration files are located in the `/etc/kvmd` directory.
|
||||
|
||||
The `/etc/kvmd/main.yaml` file defines the platform config and **you should never edit it**. To redefine system parameters use the file `/etc/kvmd/override.yaml`. All other files that are also not recommended for editing have read-only permissions.
|
||||
|
||||
In the `/etc/kvmd/meta.yaml` file you can specify some information regarding the host that this PiKVM manages.
|
||||
|
||||
!!! tip
|
||||
A complete list of all parameters can be viewed using the `kvmd -m` command.
|
||||
|
||||
Files with the suffix `*.yaml` uses the [YAML syntax](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html)
|
||||
and describes a parameter tree with key-value pairs of different types.
|
||||
To define the parameters within one section, an indent of 4 spaces is used.
|
||||
Comments starts with the `#` symbol.
|
||||
|
||||
!!! warning "Only 4 spaces should be used for indentation"
|
||||
Be careful when editing YAML and follow this rule.
|
||||
Invalid indentation or tabs instead of spaces will cause an error when starting the services.
|
||||
|
||||
??? example "Sections under the same keys should be merged"
|
||||
* **Wrong:**
|
||||
|
||||
```yaml
|
||||
kvmd:
|
||||
gpio:
|
||||
drivers: ...
|
||||
kvmd:
|
||||
gpio:
|
||||
scheme: ...
|
||||
```
|
||||
|
||||
* **Correct:**
|
||||
|
||||
```yaml
|
||||
kvmd:
|
||||
gpio:
|
||||
drivers: ...
|
||||
scheme: ...
|
||||
```
|
||||
|
|
@ -0,0 +1,25 @@
|
|||
---
|
||||
title: Configure DIP switches
|
||||
description: How to configure DIP switches on PiKVM V4 Mini and Plus
|
||||
---
|
||||
|
||||
# Configure DIP switches
|
||||
|
||||
PiKVM V4 Mini and Plus have a pair of dual in-line package (DIP) switches on the right side to control low-level settings of the Pi board.
|
||||
|
||||
|
||||
|
||||
The left switch **[1]**:
|
||||
: When pulled down (**ON** state), the advanced backpower protection is used. On the default state is **OFF** (up), "diode protection" is used. This is required for debugging at the request of technical support. Under normal conditions, it is not necessary to change the mode.
|
||||
|
||||
The right switch **[2]**:
|
||||
: When pulled down (**ON** state), the Power Delivery chip is activated on the USB OTG port. The default state is **OFF** (up).
|
||||
|
||||
To change the position of switches:
|
||||
|
||||
1. Turn the PiKVM off.
|
||||
2. Change the position of the switched.
|
||||
3. Turn the PiKVM on.
|
||||
|
||||
!!! warning
|
||||
Do not do that change the state of the DIP switched while the device is turned on. **This may cause irreparable damage.**
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 62 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 246 KiB |
|
|
@ -1,8 +1,25 @@
|
|||
---
|
||||
title: First steps with PiKVM
|
||||
description: "Getting started with PiKVM: power on and access the remote host"
|
||||
---
|
||||
|
||||
# First steps
|
||||
|
||||
This guide is written primarily with V3 and V4 Mini/Plus in mind and covers the basic steps: what ports to connect and how to access a remote host that your PiKVM is connected to.
|
||||
|
||||
-----
|
||||
## First power on
|
||||
|
||||
## Wiring
|
||||
|
||||
Let's connect all the wires before you power up the device.
|
||||
|
||||
1. Connect **Ethernet** to the network (**not applicable** to DIY PiKVM built with Pi Zero 2).
|
||||
|
||||
2. Connect the **HDMI input** and the **OTG** port (USB emulation) to the remote computer.
|
||||
|
||||
3. Optionally, connect the **[ATX port](atx_board.md)** to control the power of the remote host.
|
||||
|
||||
## Power up
|
||||
|
||||
1. Optional: [setting up Wi-Fi or static IP](on_boot_config.md) before booting.<br>
|
||||
*Remember that there is nothing more reliable than wired Ethernet.*
|
||||
|
|
@ -13,11 +30,23 @@
|
|||
*After turning on the power, PiKVM OS will generate unique SSH keys and certificates
|
||||
and perform all necessary operations on the memory card. It takes a few minutes.*
|
||||
|
||||
## Connect and set up
|
||||
|
||||
-----
|
||||
## Getting access to PiKVM
|
||||
### Configure the display
|
||||
|
||||
By default, PiKVM receives a dynamic IP address via DHCP. PiKVM V3+ devices show it on the built-in OLED display.
|
||||
The operating system on your remote computer will treat PiKVM as an additional display and use it in the Extend mode by default. That's why you will see an empty desktop when you first connect.
|
||||
|
||||
To avoid that, go to the display settings in your remote computer's operating system and enable the mirror mode for the external screen that you operating system identifies as PiKVM. Refer to your operating system's documentation on that.
|
||||
|
||||
### Access PiKVM
|
||||
|
||||
By default, PiKVM receives a dynamic IP address via DHCP. PiKVM V3 and V4 will show it in the top row of the OLED display:
|
||||
|
||||
```console
|
||||
192.168.0.100
|
||||
(|) iface: eth0
|
||||
cpu: 1% mem: 13%
|
||||
```
|
||||
|
||||
??? example "PiKVM without OLED: finding device in the network"
|
||||
|
||||
|
|
@ -30,43 +59,85 @@ By default, PiKVM receives a dynamic IP address via DHCP. PiKVM V3+ devices show
|
|||
|
||||
In order to find PiKVM using the ARP commands, you need to look for the following MACs: `B8:27:EB`, `DC:A6:32` or `E4:5F:01`.
|
||||
|
||||
For future examples, let's assume that PiKVM has received the address `192.168.0.100`,
|
||||
which you have successfully detected using the instructions above. The device has also been assigned a hostname `pikvm`.
|
||||
Let's assume that PiKVM has received the address `192.168.0.100` and has also been assigned a hostname `pikvm`.
|
||||
|
||||
!!! warning "PiKVM comes with the following default passwords"
|
||||
Type the URL in the browser's address bar and press **Enter**: https://192.168.0.26/ or https://pikvm/.
|
||||
|
||||
* **Linux OS-level admin** (SSH, console...):
|
||||
* Username: `root`
|
||||
* Password: `root`
|
||||
|
||||
|
||||
* **KVM user** (Web Interface, [API](api.md), [VNC](vnc.md)...):
|
||||
* Username: `admin`
|
||||
* Password: `admin`
|
||||
* No 2FA code
|
||||
Submit the default credentials and click **Login**:
|
||||
|
||||
They are two separate accounts with independent passwords.
|
||||
- Username: `admin`
|
||||
- Password: `admin`
|
||||
- 2FA Code: disabled by default, skip this field
|
||||
|
||||
**One of the last steps tells you how to change them. Don't forget to do it!**
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote desktop, connect to the PiKVM over SSH, or log out:
|
||||
|
||||
??? example "Access to PiKVM Web Interface"
|
||||
|
||||
|
||||
**We recommend using the latest Google Chrome or Chromium**, as they support the largest number of PiKVM features.
|
||||
Safari and Firefox are in second place. Internet Explorer and the pre-Chromium versions of Microsoft Edge are not supported.
|
||||
### Change the default passwords
|
||||
|
||||
For the first time, it is better to use a browser without extensions or incognito mode,
|
||||
as some extensions may disrupt the work of PiKVM.
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time. To do that:
|
||||
|
||||
**Type the URL in the browser's address bar and press Enter: `https://192.168.0.100/` or `https://pikvm/`.**
|
||||
1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
|
||||
|
||||
**The default user is `admin`, the password is also `admin`, and no 2FA code.**
|
||||
|
||||
|
||||
After logging in, you will get access to the menu with the main functions.
|
||||
Using the Web Terminal, you can change system settings and passwords as described below.
|
||||
2. Gain superuser privileges:
|
||||
|
||||
*The latest versions of Google Chrome on Mac OS do not allow access to the page with a self-signed certificate,
|
||||
which is used in PiKVM by default. You can proceed by typing `thisisunsafe` and Chrome will then load the page.*
|
||||
```console
|
||||
$ su -
|
||||
```
|
||||
|
||||
??? example "Access to PiKVM via SSH"
|
||||
When prompted for password, use `root`.
|
||||
|
||||
3. Run `rw` to change the access to the SD card to the write mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# rw
|
||||
```
|
||||
|
||||
4. Change the password for the superuser:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# passwd root
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, press **Enter**, and you should see this:
|
||||
|
||||
```console
|
||||
passwd: password updated successfully
|
||||
```
|
||||
|
||||
5. Change the password for web access:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# kvmd-htpasswd set admin
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, and press **Enter**.
|
||||
|
||||
6. Run `ro` to change the access to the SD card back to the read-only mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# ro
|
||||
```
|
||||
|
||||
7. Press **Ctrl+D** or type "exit" and press **Enter** to drop the root privileges.
|
||||
|
||||
8. Go back one page in the browser. You should be back to the initial dashboard screen.
|
||||
|
||||
### Access the remote system
|
||||
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote desktop.
|
||||
|
||||
2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
|
||||
|
||||
There are two alternative ways to connect to the PiKVM:
|
||||
|
||||
??? example "Connect to PiKVM via SSH"
|
||||
|
||||
SSH is the most common remote access method in the Linux world. PiKVM is accessible via SSH. This method is used to manage the device:
|
||||
|
||||
|
|
@ -75,7 +146,7 @@ which you have successfully detected using the instructions above. The device ha
|
|||
|
||||
**The default `root` password is `root`.**
|
||||
|
||||
??? example "Access to PiKVM via serial console"
|
||||
??? example "Connect to PiKVM via serial console"
|
||||
|
||||
A serial console is a convenient and fast way to connect to PiKVM when there is no network, or get boot logs and a console if something goes wrong.
|
||||
|
||||
|
|
@ -91,108 +162,50 @@ which you have successfully detected using the instructions above. The device ha
|
|||
|
||||
4. You should now be able to see and interact with the Serial Port.
|
||||
|
||||
!!! tip "Obtaining root access"
|
||||
## Further steps
|
||||
|
||||
* If you have logged in via SSH, then most likely you are already `root`.
|
||||
* To get `root` in the Web Terminal, use command `su -` and enter the root password. The default `root` password is `root`.*
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
PiKVM OS (and the underlying Arch Linux ARM upstream) often receives software updates.
|
||||
After installation, it makes sense to update the OS.
|
||||
It's best to do this now, when you have physical access to the device, because if something goes wrong
|
||||
(for example, the power goes out during the update or some upstream change),
|
||||
you will need to [reflash the memory card](flashing_os.md).
|
||||
2. **Update and customize the system**:
|
||||
|
||||
{!_update_os.md!}
|
||||
- [Update](_update_os.md) the PiKVM operating system.
|
||||
- [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
- Enable a microphone for [two-way audio](audio.md) (**only for PiKVM V3 and V4 Mini/Plus**).
|
||||
- Enable [HDMI pass-through](pass.md) (**only for PiKVM V4 Plus**)..
|
||||
|
||||
**And now, after all...**
|
||||
3. **Configure hardware**:
|
||||
|
||||
{!_passwd.md!}
|
||||
- Set up [ATX connection](atx_board.md).
|
||||
- Configure [DIP switches](dip_switches.md)
|
||||
- Install and set up [Wi-Fi antenna](wifi.md).
|
||||
- Install and set up [LTE/5G modem](modem.md) (**only for PiKVM V4 Plus**).
|
||||
- Set up [USB 3.0](usb3v4.md) (**only for PiKVM V4 Plus**).
|
||||
- Choose Fahrenheit over Celsius to display on the OLED:
|
||||
|
||||
??? note "How to set up Fahrenheit"
|
||||
|
||||
-----
|
||||
## Configuring PiKVM
|
||||
Create a directory for a configuration file:
|
||||
|
||||
Most of the PiKVM settings are done through configuration files. All configuration changes must be made from under the `root` user (i.e. the administrator).
|
||||
|
||||
The PiKVM memory card is mounted in read-only mode. It protects the filesystem from damage in case of sudden power outage. To edit any files and make changes, it is necessary to remount the file system to the read-write mode.
|
||||
|
||||
!!! tip "Enabling write mode"
|
||||
|
||||
* To enable write-mode, run command `rw` (under `root`).
|
||||
* To disable it, run command `ro`.
|
||||
* If you receive the message "Device is busy", perform `reboot`.
|
||||
|
||||
In this handbook, you will often find instructions for editing configuration files. The simplest and most beginner-friendly text editor is `nano`, but you can also use `vim`.
|
||||
|
||||
??? example "Editing files in the Web Terminal"
|
||||
|
||||
```console
|
||||
[kvmd-webterm@pikvm ~]$ su -
|
||||
[root@pikvm ~]# rw
|
||||
[root@pikvm ~]# nano /etc/kvmd/override.yaml
|
||||
[root@pikvm ~]# ro
|
||||
[root@pikvm ~]# exit
|
||||
[kvmd-webterm@pikvm ~]$
|
||||
```
|
||||
|
||||
-----
|
||||
## Structure of configuration files
|
||||
|
||||
Most of the PiKVM configuration files are located in the `/etc/kvmd` directory.
|
||||
|
||||
The `/etc/kvmd/main.yaml` file defines the platform config and **you should never edit it**. To redefine system parameters use the file `/etc/kvmd/override.yaml`. All other files that are also not recommended for editing have read-only permissions.
|
||||
|
||||
In the `/etc/kvmd/meta.yaml` file you can specify some information regarding the host that this PiKVM manages.
|
||||
|
||||
!!! tip
|
||||
A complete list of all parameters can be viewed using the `kvmd -m` command.
|
||||
|
||||
Files with the suffix `*.yaml` uses the [YAML syntax](https://docs.ansible.com/ansible/latest/reference_appendices/YAMLSyntax.html)
|
||||
and describes a parameter tree with key-value pairs of different types.
|
||||
To define the parameters within one section, an indent of 4 spaces is used.
|
||||
Comments starts with the `#` symbol.
|
||||
|
||||
!!! warning "Only 4 spaces should be used for indentation"
|
||||
Be careful when editing YAML and follow this rule.
|
||||
Invalid indentation or tabs instead of spaces will cause an error when starting the services.
|
||||
|
||||
??? example "Sections under the same keys should be merged"
|
||||
* **Wrong:**
|
||||
|
||||
```yaml
|
||||
kvmd:
|
||||
gpio:
|
||||
drivers: ...
|
||||
kvmd:
|
||||
gpio:
|
||||
scheme: ...
|
||||
```console
|
||||
[root@pikvm ~]# mkdir -p /etc/systemd/system/kvmd-oled.service.d
|
||||
```
|
||||
|
||||
* **Correct:**
|
||||
Create file `/etc/systemd/system/kvmd-oled.service.d/override.conf`:
|
||||
|
||||
```yaml
|
||||
kvmd:
|
||||
gpio:
|
||||
drivers: ...
|
||||
scheme: ...
|
||||
```ini
|
||||
[Service]
|
||||
ExecStart=
|
||||
ExecStart=/usr/bin/kvmd-oled --clear-on-exit --fahrenheit
|
||||
```
|
||||
|
||||
Then run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
|
||||
|
||||
-----
|
||||
## What's next?
|
||||
## Basic troubleshooting
|
||||
|
||||
* Set up Internet access using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
* Explore PiKVM features using the table of contents on the left.
|
||||
* Get to know the [interface](webui.md)
|
||||
* Join our [Discord](https://discord.gg/bpmXfz5) to contact the community and developers.
|
||||
* Check out the [GitHub](https://github.com/pikvm) - PiKVM is a fully Open Source project!
|
||||
* For Mac OS client: [pin your PiKVM device as an app](https://github.com/pikvm/pikvm/issues/965) for quick access.
|
||||
{!_basic_troubleshooting.md!}
|
||||
|
||||
|
||||
-----
|
||||
## FAQ and Troubleshooting
|
||||
## Getting user support
|
||||
|
||||
If you have any questions or run into problems, take a look at the [FAQ](faq.md).
|
||||
Seriously, it's really useful!
|
||||
|
||||
For any other help and support, you can contact us via the [Discord chat](https://discord.gg/bpmXfz5).
|
||||
If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5).
|
||||
|
|
@ -0,0 +1,34 @@
|
|||
---
|
||||
title: Configure USB 3.0 support
|
||||
description: How to configure USB 3.0 support on PiKVM V4 Plus
|
||||
---
|
||||
|
||||
# USB 3.0 support
|
||||
|
||||
PiKVM V4 Plus has an internal USB port. It supports USB 3.0, but only works with USB 2.0 devices by default to minimize the power consumption. You need to flash the USB controller to enable USB 3.0. To do so, follow these steps:
|
||||
|
||||
1. Open a terminal window and log into the PiKVM via SSH:
|
||||
|
||||
```console
|
||||
$ ssh user@host
|
||||
```
|
||||
|
||||
2. Flash the USB controller using the built-in `flashrom` utility. Choose `usb3` for USB 3.0 support:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# flashrom-vl805 usb3
|
||||
```
|
||||
|
||||
If you need to disable USB 3.0 support at any time later, run the same command, but use `default` instead:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# flashrom-vl805 default
|
||||
```
|
||||
|
||||
3. Perform the soft reboot:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# reboot
|
||||
```
|
||||
|
||||
4. After the soft reboot, perform the **reboot by power**: unplug and plug again the power cable.
|
||||
142
docs/v1.md
142
docs/v1.md
|
|
@ -1,4 +1,9 @@
|
|||
# DIY PiKVM V1 Instructions
|
||||
---
|
||||
title: DIY PiKVM V1 quick start guide
|
||||
description: Getting started with PiKVM V1
|
||||
---
|
||||
|
||||
# DIY PiKVM V2 quick start guide
|
||||
|
||||
!!! tip "So many choices!"
|
||||
There are many different options with sub-items, so you can choose what will suit you.<br>
|
||||
|
|
@ -63,8 +68,6 @@
|
|||
buy the [VGA-to-HDMI converter](https://aliexpress.com/item/3256801728005613.html).
|
||||
Some converters have issues with not supporting all resolutions and refresh rates.
|
||||
|
||||
|
||||
-----
|
||||
## Setting up the hardware
|
||||
|
||||
1. **Video capture device:**
|
||||
|
|
@ -110,35 +113,144 @@
|
|||
|
||||
4. **[Flash firmware to the Pico HID.](pico_hid.md)**
|
||||
|
||||
## Wiring
|
||||
|
||||
-----
|
||||
## Wiring with the target host
|
||||
PiKVM V1 requires several items available separately:
|
||||
|
||||
- Ethernet cable **(Raspberry Pi 2 and 3 only)**
|
||||
- RJ-45 cable for ATX (optional)
|
||||
- USB cable
|
||||
- HDMI cable
|
||||
- USB-Micro Power Supply
|
||||
|
||||
Let's connect all the wires before you power up the device.
|
||||
|
||||
1. Connect the HDMI video capture device to the video output port on the target host.
|
||||
|
||||
2. Connect the Pico HID to the USB port on the target host.
|
||||
|
||||
3. ??? example "Connect the ATX controller if you built it"
|
||||
3. **Raspberry Pi 2/3**: connect **Ethernet** to the network, e.g., to the WiFI router.
|
||||
|
||||
4. ??? example "Connect the ATX controller if you built it"
|
||||
|
||||
{!_diy_wiring_atx.md!}
|
||||
|
||||
## Power up
|
||||
|
||||
-----
|
||||
## Video modes
|
||||
[Flash the memory card with PiKVM OS](https://docs.pikvm.org/flashing_os){target=_blank} and insert it to Raspberry Pi.
|
||||
|
||||
PiKVM V2 with CSI bridge can only handle the maximum resolution 1920x1080@50Hz, 60Hz is not supported due hardware limitation.
|
||||
You can use any other resolution less than the specified one, for example 1280x720@60Hz.
|
||||
Next, attach the power supply to the Raspberry Pi.
|
||||
|
||||
If you have any problems with video on CSI bridge, follow [this guide](edid.md).
|
||||
After turning on the power, PiKVM OS generates unique SSH keys and certificates and performs all necessary operations on the memory card. It takes a few minutes. Do **not** turn off the device until it's fully booted for the first time.
|
||||
|
||||
## Access PiKVM
|
||||
|
||||
-----
|
||||
## First launch and usage
|
||||
You need to know PiKVM's IP address in the network to be able to access it. Unlike V3 and V4, PiKVM V2 doesn't have an OLED to display the IP address it receives automatically. You need to discover it manually. There are several ways to do that.
|
||||
|
||||
{!_diy_first_launch.md!}
|
||||
* **Common way:** Open the web interface of your router and find the list of issued IP addresses there.
|
||||
* **Linux-only:** Use the `arp-scan --localnet` command.
|
||||
* **Linux, MacOS, Windows:** Download and run [Angry IP Scanner](https://angryip.org).
|
||||
* **Windows PowerShell:** Use the `arp -a` command.
|
||||
|
||||
Let's assume that PiKVM has received the address `192.168.0.26` and has also been assigned a hostname `pikvm`.
|
||||
|
||||
Type the URL in the browser's address bar and press **Enter**: https://192.168.0.26/ or https://pikvm/.
|
||||
|
||||
|
||||
|
||||
Submit the default credentials and click **Login**:
|
||||
|
||||
- Username: `admin`
|
||||
- Password: `admin`
|
||||
- 2FA Code: disabled by default, skip this field
|
||||
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote desktop, connect to the PiKVM over SSH, or log out:
|
||||
|
||||
|
||||
|
||||
### Change the default passwords
|
||||
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time. To do that:
|
||||
|
||||
1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
|
||||
|
||||
|
||||
|
||||
2. Gain superuser privileges:
|
||||
|
||||
```console
|
||||
$ su -
|
||||
```
|
||||
|
||||
When prompted for password, use `root`.
|
||||
|
||||
3. Run `rw` to change the access to the SD card to the write mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# rw
|
||||
```
|
||||
|
||||
4. Change the password for the superuser:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# passwd root
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, press **Enter**, and you should see this:
|
||||
|
||||
```console
|
||||
passwd: password updated successfully
|
||||
```
|
||||
|
||||
5. Change the password for web access:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# kvmd-htpasswd set admin
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, and press **Enter**.
|
||||
|
||||
6. Run `ro` to change the access to the SD card back to the read-only mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# ro
|
||||
```
|
||||
|
||||
7. Press **Ctrl+D** or type "exit" and press **Enter** to drop the root privileges.
|
||||
|
||||
8. Go back one page in the browser. You should be back to the initial dashboard screen.
|
||||
|
||||
### Access the remote system
|
||||
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote desktop.
|
||||
|
||||
2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
|
||||
|
||||
## Further steps
|
||||
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
2. **Update and customize the system**:
|
||||
|
||||
- [Update](_update_os.md) the PiKVM operating system.
|
||||
- [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
|
||||
3. **Configure hardware**:
|
||||
|
||||
- Set up [ATX connection](atx_board.md).
|
||||
- Set up [USB 3.0](usb3v4.md)
|
||||
|
||||
## Known issues and limitations
|
||||
|
||||
**Max resolution**. PiKVM V1 with CSI bridge can only handle the maximum resolution 1920x1080@50Hz, 60Hz is not supported due hardware limitation. You can use any other resolution less than the specified one, for example 1280x720@60Hz. If you have any problems with video on CSI bridge, follow [this guide](edid.md).
|
||||
|
||||
-----
|
||||
## Basic troubleshooting
|
||||
|
||||
{!_basic_troubleshooting.md!}
|
||||
|
||||
## Getting user support
|
||||
|
||||
If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5).
|
||||
146
docs/v2.md
146
docs/v2.md
|
|
@ -1,11 +1,14 @@
|
|||
# DIY PiKVM V2 Instructions
|
||||
---
|
||||
title: DIY PiKVM V2 quick start guide
|
||||
description: Getting started with PiKVM V2
|
||||
---
|
||||
|
||||
# DIY PiKVM V2 quick start guide
|
||||
|
||||
!!! tip "So many choices!"
|
||||
There are many different options with sub-items, so you can choose what will suit you.<br>
|
||||
However, we marked the recommended way by sign **`✮ ✮ ✮`**
|
||||
|
||||
|
||||
-----
|
||||
## Required parts
|
||||
|
||||
1. **MicroSD card minimum 16Gb class 10.**
|
||||
|
|
@ -76,8 +79,6 @@
|
|||
|
||||
*Kit parts suitable for assembly are also on [sale in Poland](https://3mdeb.com/shop/open-source-hardware/pikvm/).*
|
||||
|
||||
|
||||
-----
|
||||
## Setting up the hardware
|
||||
|
||||
1. **Video capture device:**
|
||||
|
|
@ -143,35 +144,144 @@
|
|||
|
||||
4. !!! warning "Double check that the circuit is assembled correctly to avoid any damage of the hardware."
|
||||
|
||||
## Wiring
|
||||
|
||||
-----
|
||||
## Wiring with the target host
|
||||
PiKVM V2 requires several items available separately:
|
||||
|
||||
- Ethernet cable **(Raspberry Pi 4 only)**
|
||||
- RJ-45 cable for ATX (optional)
|
||||
- USB-C cable
|
||||
- HDMI cable
|
||||
- 5V USB power adapter
|
||||
|
||||
Let's connect all the wires before you power up the device.
|
||||
|
||||
1. Connect the HDMI video capture device to the video output port on the target host.
|
||||
|
||||
2. Using the Y-cable, connect the PiKVM to the USB on the target host.
|
||||
2. Using the Y-cable, connect the Pi's OTG port to the USB on the target host.
|
||||
|
||||
3. ??? example "Connect the ATX controller if you built it"
|
||||
3. **Raspberry Pi 4**: connect **Ethernet** to the network, e.g., to the WiFI router.
|
||||
|
||||
4. ??? example "Connect the ATX controller if you built it"
|
||||
|
||||
{!_diy_wiring_atx.md!}
|
||||
|
||||
## Power up
|
||||
|
||||
-----
|
||||
## Video modes
|
||||
[Flash the memory card with PiKVM OS](https://docs.pikvm.org/flashing_os){target=_blank} and insert it to Raspberry Pi.
|
||||
|
||||
PiKVM V2 with CSI bridge can only handle the maximum resolution 1920x1080@50Hz, 60Hz is not supported due hardware limitation.
|
||||
You can use any other resolution less than the specified one, for example 1280x720@60Hz.
|
||||
Next, attach the USB-C 5V power supply to the Raspberry Pi.
|
||||
|
||||
If you have any problems with video on CSI bridge, follow [this guide](edid.md).
|
||||
After turning on the power, PiKVM OS generates unique SSH keys and certificates and performs all necessary operations on the memory card. It takes a few minutes. Do **not** turn off the device until it's fully booted for the first time.
|
||||
|
||||
## Access PiKVM
|
||||
|
||||
-----
|
||||
## First launch and usage
|
||||
You need to know PiKVM's IP address in the network to be able to access it. Unlike V3 and V4, PiKVM V2 doesn't have an OLED to display the IP address it receives automatically. You need to discover it manually. There are several ways to do that.
|
||||
|
||||
{!_diy_first_launch.md!}
|
||||
* **Common way:** Open the web interface of your router and find the list of issued IP addresses there.
|
||||
* **Linux-only:** Use the `arp-scan --localnet` command.
|
||||
* **Linux, MacOS, Windows:** Download and run [Angry IP Scanner](https://angryip.org).
|
||||
* **Windows PowerShell:** Use the `arp -a` command.
|
||||
|
||||
Let's assume that PiKVM has received the address `192.168.0.26` and has also been assigned a hostname `pikvm`.
|
||||
|
||||
Type the URL in the browser's address bar and press **Enter**: https://192.168.0.26/ or https://pikvm/.
|
||||
|
||||
|
||||
|
||||
Submit the default credentials and click **Login**:
|
||||
|
||||
- Username: `admin`
|
||||
- Password: `admin`
|
||||
- 2FA Code: disabled by default, skip this field
|
||||
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote desktop, connect to the PiKVM over SSH, or log out:
|
||||
|
||||
|
||||
|
||||
### Change the default passwords
|
||||
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time. To do that:
|
||||
|
||||
1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
|
||||
|
||||
|
||||
|
||||
2. Gain superuser privileges:
|
||||
|
||||
```console
|
||||
$ su -
|
||||
```
|
||||
|
||||
When prompted for password, use `root`.
|
||||
|
||||
3. Run `rw` to change the access to the SD card to the write mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# rw
|
||||
```
|
||||
|
||||
4. Change the password for the superuser:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# passwd root
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, press **Enter**, and you should see this:
|
||||
|
||||
```console
|
||||
passwd: password updated successfully
|
||||
```
|
||||
|
||||
5. Change the password for web access:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# kvmd-htpasswd set admin
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, and press **Enter**.
|
||||
|
||||
6. Run `ro` to change the access to the SD card back to the read-only mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# ro
|
||||
```
|
||||
|
||||
7. Press **Ctrl+D** or type "exit" and press **Enter** to drop the root privileges.
|
||||
|
||||
8. Go back one page in the browser. You should be back to the initial dashboard screen.
|
||||
|
||||
### Access the remote system
|
||||
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote desktop.
|
||||
|
||||
2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
|
||||
|
||||
## Further steps
|
||||
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
2. **Update and customize the system**:
|
||||
|
||||
- [Update](_update_os.md) the PiKVM operating system.
|
||||
- [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
|
||||
3. **Configure hardware**:
|
||||
|
||||
- Set up [ATX connection](atx_board.md).
|
||||
- Set up [USB 3.0](usb3v4.md)
|
||||
|
||||
## Known issues and limitations
|
||||
|
||||
**Max resolution**. PiKVM V2 with CSI bridge can only handle the maximum resolution 1920x1080@50Hz, 60Hz is not supported due hardware limitation. You can use any other resolution less than the specified one, for example 1280x720@60Hz. If you have any problems with video on CSI bridge, follow [this guide](edid.md).
|
||||
|
||||
-----
|
||||
## Basic troubleshooting
|
||||
|
||||
{!_basic_troubleshooting.md!}
|
||||
|
||||
## Getting user support
|
||||
|
||||
If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5).
|
||||
292
docs/v3.md
292
docs/v3.md
|
|
@ -1,60 +1,222 @@
|
|||
# PiKVM V3 HAT
|
||||
---
|
||||
title: PiKVM V3 HAT & pre-assembled quick start
|
||||
description: Getting started with PiKVM V3 & pre-assembled
|
||||
---
|
||||
|
||||
<img src="assembled.jpg" width="400" />
|
||||
# PiKVM V3 HAT & pre-assembled quick start
|
||||
|
||||
|
||||
|
||||
## Installation requirements
|
||||
PiKVM is a feature-rich, production grade, open-source, Raspberry Pi based KVM over IP device. It allows you to turn on/off or restart your computer, configure the UEFI/BIOS, and even reinstall the OS using the Virtual CD-ROM or Flash Drive.
|
||||
|
||||
??? note "If you have an assembly kit, you will need the following things"
|
||||
* Raspberry Pi 4 with 1Gb RAM or more.
|
||||
* Heat sinks (Optional)
|
||||
* MicroSD card (at least 16Gb, class 10 recommended).
|
||||
* USB-C to USB-A cable.
|
||||
* HDMI cable.
|
||||
* <a target="_blank" href="../atx_board/straight.png">Straight Ethernet cable.</a>
|
||||
* Power supply unit (5.1V 3A USB-C, recommended by the Raspberry Pi).
|
||||
You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mouse, and a monitor, which are then presented in a web browser as if you were working on a remote system directly.
|
||||
|
||||
!!! tip
|
||||
* Please review the back of the box. All parts are required before the HAT is fully functional.
|
||||
* The USB-C bridge is located in with the ATX end which includes a pink foam spacer.
|
||||
* Please assemble the HAT onto the RPi and test all of the parts before installing in the case, it's easier to install in the case than to dissasemble it.
|
||||
* If going from a V2 to a V3, the splitter is **no longer needed**.
|
||||
PiKVM V3 is available in two version:
|
||||
|
||||
- An assembly kit (HAT).
|
||||
- A pre-assembled unit in a metallic box.
|
||||
|
||||
## Basic setup
|
||||
The two versions have the same ports and functionality.
|
||||
|
||||
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.
|
||||
## What's in the box
|
||||
|
||||
1. **[Flash the memory card.](flashing_os.md){target=_blank}**. Please use the V3 image, V2 image is not compatible.
|
||||
=== "HAT"
|
||||
|
||||
2. **Build PiKVM** according to the video instruction or review the [illustrated instructions](v3_illustrated_install_instructions.md):
|
||||
|
||||
??? tip "Video Guide: Metal case step by step"
|
||||
NOTE: OLED will not light up till step 5 is performed, video was performed after it was already configured, heat sinks NOT included.
|
||||
|
||||
- The PiKVM V3 HAT for Raspberry Pi 4
|
||||
- USB-C bridge board
|
||||
- ATX adapter board with mounting brackets and motherboard interface wiring
|
||||
- 2x Flat CSI-2 cables
|
||||
- 7x jumpers, assorted colors
|
||||
- 8x brass standoffs
|
||||
- 8x screws
|
||||
|
||||
??? tip "Video Guide: Step by step with HAT device with or without the 3D-printed case"
|
||||
|
||||
=== "Pre-Assembled"
|
||||
|
||||
!!! warning
|
||||
OLED glass can crack if force is used to install it, please handle with care and rock back and forth on the pins side to install.
|
||||
- PiKVM V3.3 pre-assembled
|
||||
- ATX adapter board with mounting brackets and motherboard interface wiring
|
||||
- A 32 GB MicroSD card pre-imaged with the PiKVM OS
|
||||
|
||||
## HAT setup
|
||||
|
||||
3. **Connect PiKVM** to the computer according to the diagram below:
|
||||
If you have an assembly kit without a metal case, you can use our free 3D printing case drawing:
|
||||
|
||||
| Back side | Front side |
|
||||
|-----------|------------|
|
||||
| <img src="basic_back.jpg" width="300" /> | <img src="basic_front.jpg" width="300" /> |
|
||||
- [V3.2](stl/v3.2/index.md){target=_blank} is the pre-release model.
|
||||
- [V3.3](stl/v3.3/index.md){target=_blank} is the Kickstarter/Store model.
|
||||
|
||||
* **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.
|
||||
Once you have that, do the following:
|
||||
|
||||
* Connect **Ethernet** to the network and **USB power** to the Raspberry Pi power supply.
|
||||
1. **[Flash the memory card](flashing_os.md){target=_blank}**. Please use the V3 image, V2 image is not compatible.
|
||||
|
||||
4. **Carefully read and follow [the "First steps" guide](first_steps.md){target=_blank}.**<br>
|
||||
It describes how to find PiKVM on the network, how to log in there, change passwords, and so on.<br>
|
||||
**Follow the steps described there and come back to this page.**
|
||||
2. **Build PiKVM** according to the [illustrated instructions](v3_illustrated_install_instructions.md).
|
||||
|
||||
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)"
|
||||
## Interface
|
||||
|
||||
=== "Front view"
|
||||
|
||||
{ height="250" }
|
||||
|
||||
1. 2x USB 2.0
|
||||
2. 2x USB 3.0
|
||||
3. RJ45 1Gb Ethernet port
|
||||
4. RJ45 Serial console port
|
||||
5. Serial console active LED / Beacon LED (Green)
|
||||
6. USB 2.0 Serial console port
|
||||
7. Activity LED (Red)
|
||||
8. Power LED (Green)
|
||||
9. Power Input 5.1V 3A
|
||||
|
||||
=== "Rear view"
|
||||
|
||||
{ height="250" }
|
||||
|
||||
1. Micro SD card slot
|
||||
2. HDMI video input port
|
||||
3. USB 2.0 OTG connector
|
||||
4. RJ45 ATX control port
|
||||
|
||||
=== "Left view"
|
||||
|
||||
{ height="250" }
|
||||
|
||||
1. Mini-HDMI output port
|
||||
|
||||
=== "Top view"
|
||||
|
||||
{ height="250" }
|
||||
|
||||
1. Display
|
||||
|
||||
## Wiring
|
||||
|
||||
Both the HAT and the pre-assembled V3 require several items available separately:
|
||||
|
||||
- Ethernet cable
|
||||
- RJ-45 cable for ATX (optional)
|
||||
- USB-C cable
|
||||
- HDMI cable
|
||||
- 5V USB power adapter
|
||||
|
||||
Let's connect all the wires before you power up the device.
|
||||
|
||||
### Network
|
||||
|
||||
|
||||
|
||||
Connect **Ethernet** (**bottom right** on the **front** side) to the network, e.g., to the WiFI router.
|
||||
|
||||
### HDMI and USB-C
|
||||
|
||||
|
||||
|
||||
**HDMI input** (the **top right** on the **rear** 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.
|
||||
|
||||
## Power up
|
||||
|
||||
|
||||
|
||||
V3 comes has a USB-C 5V power supply. Attach the appropriate connector on the **front** side (**top left**). Do **not** block the ventilation holes on the sides of the device.
|
||||
|
||||
After turning on the power, PiKVM OS generates unique SSH keys and certificates and performs all necessary operations on the memory card. It takes a few minutes. Do **not** turn off the device until it's fully booted for the first time. Once it's done, the PiKVM will show a greeting on the built-in display.
|
||||
|
||||
## Connect and set up
|
||||
|
||||
### Configure the display
|
||||
|
||||
The operating system on your remote computer will treat PiKVM as an additional display and use it in the Extend mode by default. That's why you will see an empty desktop when you first connect.
|
||||
|
||||
To avoid that, go to the display settings in your remote computer's operating system and enable the mirror mode for the external screen that you operating system identifies as PiKVM. Refer to your operating system's documentation on that.
|
||||
|
||||
### Access PiKVM
|
||||
|
||||
By default, PiKVM receives a dynamic IP address via DHCP and shows it in the top row of the OLED display:
|
||||
|
||||
```console
|
||||
192.168.0.26
|
||||
(|) iface: eth0
|
||||
cpu: 1% mem: 13%
|
||||
```
|
||||
|
||||
Let's assume that PiKVM has received the address `192.168.0.26` and has also been assigned a hostname `pikvm`.
|
||||
|
||||
Type the URL in the browser's address bar and press **Enter**: https://192.168.0.26/ or https://pikvm/.
|
||||
|
||||
|
||||
|
||||
Submit the default credentials and click **Login**:
|
||||
|
||||
- Username: `admin`
|
||||
- Password: `admin`
|
||||
- 2FA Code: disabled by default, skip this field
|
||||
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote desktop, connect to the PiKVM over SSH, or log out:
|
||||
|
||||
|
||||
|
||||
### Change the default passwords
|
||||
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time. To do that:
|
||||
|
||||
1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
|
||||
|
||||
|
||||
|
||||
2. Gain superuser privileges:
|
||||
|
||||
```console
|
||||
$ su -
|
||||
```
|
||||
|
||||
When prompted for password, use `root`.
|
||||
|
||||
3. Run `rw` to change the access to the SD card to the write mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# rw
|
||||
```
|
||||
|
||||
4. Change the password for the superuser:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# passwd root
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, press **Enter**, and you should see this:
|
||||
|
||||
```console
|
||||
passwd: password updated successfully
|
||||
```
|
||||
|
||||
5. Change the password for web access:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# kvmd-htpasswd set admin
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, and press **Enter**.
|
||||
|
||||
6. Run `ro` to change the access to the SD card back to the read-only mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# ro
|
||||
```
|
||||
|
||||
7. Press **Ctrl+D** or type "exit" and press **Enter** to drop the root privileges.
|
||||
|
||||
8. Go back one page in the browser. You should be back to the initial dashboard screen.
|
||||
|
||||
### Access the remote system
|
||||
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote desktop.
|
||||
|
||||
2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
|
||||
|
||||
## Additional setting up
|
||||
|
||||
??? 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:
|
||||
|
||||
|
|
@ -65,7 +227,7 @@ If you have a kit without a metal case, you can use our free 3D printing case dr
|
|||
[root@pikvm ~]# ro
|
||||
```
|
||||
|
||||
6. ??? note "Using Fahrenheit instead of Celsius on the OLED"
|
||||
??? note "Using Fahrenheit instead of Celsius on the OLED"
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# mkdir -p /etc/systemd/system/kvmd-oled.service.d
|
||||
|
|
@ -81,42 +243,30 @@ If you have a kit without a metal case, you can use our free 3D printing case dr
|
|||
|
||||
Then run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
|
||||
|
||||
7. **Just reminding again:**
|
||||
## Further steps
|
||||
|
||||
{!_passwd.md!}
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
8. **Try to manage the computer using PiKVM with the Web Interface.**<br>
|
||||
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).
|
||||
2. **Update and customize the system**:
|
||||
|
||||
9. ??? note "Check the HDMI backpowering problem. ONLY applicable under specific circumstances. NOT getting NO SIGNAL."
|
||||
Try restarting PiKVM using the `reboot` command executed in the terminal. If PiKVM hangs during boot (you can't get the Web Interface for a long time), then you are faced with this rare problem. **Don't worry, it's easy to fix.** Turn off the PiKVM, disconnect all cables from it, take a close look at the [diagram of its ports and jumpers](#io-ports-and-jumpers), and **remove jumper #14** (it is to the right of the CSI connector). Then you can connect and power up PiKVM again. Now everything will be fine. If you are interested in the technical background, it is described [here](https://www.kickstarter.com/projects/mdevaev/pikvm-v3-hat/posts/3296343). Also, just for information: not a single case of negative consequences from the removal of the jumper has been recorded.
|
||||
- [Update](_update_os.md) the PiKVM operating system.
|
||||
- [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
- Enable a microphone for [two-way audio](audio.md).
|
||||
|
||||
10. !!! warning "IO ports and other things"
|
||||
**Before using GPIO** pins to control a relay, KVM switch, or anything else, be sure to [check the HAT pinout](#io-ports-and-jumpers). Many ports are busy with internal functions. Before using them for your own use, you must disable them, otherwise you may damage the device.
|
||||
3. **Configure hardware**:
|
||||
|
||||
11. Enable [audio speakers and microphone](audio.md){target=_blank} if you want.
|
||||
- Set up [ATX connection](atx_board.md).
|
||||
- Set up [USB 3.0](usb3v4.md)
|
||||
|
||||
12. Configure access to PiKVM from the Internet using [port forwarding](https://docs.pikvm.org/port_forwarding)
|
||||
or [Tailscale VPN](https://docs.pikvm.org/tailscale), if you need it.
|
||||
## Known issues and limitations
|
||||
|
||||
13. Explore the features of PiKVM using the site's table of contents and have fun!
|
||||
* **Max resolution**. PiKVM V3 supports maximum resolution 1920x1080@50Hz, 60Hz will not work. You can use any other resolution less than the specified one, for example: 1600x1200@60Hz, 1280x720@60Hz, etc. If you have problems with the video, follow [this guide](edid.md).
|
||||
* **Motherboards compatibility**. There may be compatibility issues with some motherboards, such as HP or DELL. 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. In the latter case, [USB dynamic configuration](usb.md) will solve the problem.
|
||||
* **HDMI backpowering**. Under specific circumstances, PiKVM may hang during the boot. Turn off the PiKVM, disconnect all cables from it, take a close look at the diagram of its ports and jumpers below, and **remove jumper #14** (it is to the right of the CSI connector, **not available on the V3.2 board**). Then you can connect and power up PiKVM again. (Technical background s described [here](https://www.kickstarter.com/projects/mdevaev/pikvm-v3-hat/posts/3296343).)
|
||||
* **IO ports**. **Before using GPIO** pins to control a relay, KVM switch, or anything else, be sure to check the HAT pinout below. Many ports are busy with internal functions. Before using them for your own use, you must disable them, otherwise you may damage the device.
|
||||
|
||||
|
||||
## Video modes
|
||||
|
||||
PiKVM V3 supports maximum resolution 1920x1080@50Hz, 60Hz will not work. You can use any other resolution less than the specified one, for example: 1600x1200@60Hz, 1280x720@60Hz, etc. If you have problems with the video, follow [this guide](edid.md).
|
||||
|
||||
|
||||
## ATX connection
|
||||
|
||||
[See here](atx_board.md).
|
||||
|
||||
|
||||
## IO ports and jumpers
|
||||
|
||||
??? note "See the diagram"
|
||||
??? note "The ports and jumpers diagram"
|
||||
<img src="v3_features.jpg" />
|
||||
|
||||
1. [**ATX controller** interface](atx_board.md) (power on/off, reboot control, PWR and HDD ACT LEDs).
|
||||
|
|
@ -139,7 +289,7 @@ PiKVM V3 supports maximum resolution 1920x1080@50Hz, 60Hz will not work. You can
|
|||
18. **USB-C emulation port** - this port is doing the emulation of a USB keyboard, mouse, Virtual CD-ROM or USB Flash Drive, USB-Ethernet, USB-Serial port and a lot of other Linux-supported features.
|
||||
19. **1-Wire** & **Neo-pixel** interface (under, advanced user feature).
|
||||
|
||||
??? note "GPIO pinout"
|
||||
??? note "The GPIO pinout"
|
||||
|
||||
!!! warning
|
||||
Before proceeding, make sure that the mb you are using has normal ATX headers
|
||||
|
|
@ -168,12 +318,10 @@ PiKVM V3 supports maximum resolution 1920x1080@50Hz, 60Hz will not work. You can
|
|||
|
||||
The standard Raspberry Pi HDMI output (marked as `VIDEO OUT` on the PiKVM case) displays its own PiKVM OS console.
|
||||
|
||||
|
||||
## Basic troubleshooting
|
||||
|
||||
{!_basic_troubleshooting.md!}
|
||||
|
||||
## Getting user support
|
||||
|
||||
## Known issues and limitations
|
||||
* 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. In the last case, [USB dynamic configuration](usb.md) will solve the problem.
|
||||
* Pre-release V3.2 board (NOT Kickstarter/Store edition) doesn't have HDMI backpowering workaround jumper.
|
||||
If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5).
|
||||
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 82 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 98 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 56 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 57 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 80 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 62 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 37 KiB |
|
|
@ -1,8 +1,41 @@
|
|||
# Step 1
|
||||
---
|
||||
title: Assembling PiKVM V3 HAT
|
||||
description: How to build PiKVM V3 HAT from the assembly kit
|
||||
---
|
||||
|
||||
Remove contents from box.
|
||||
# Assembling PiKVM V3 HAT
|
||||
|
||||
PiKVM V3 HAT is an assembly kit. You can build it without any case whatsoever, order a metallic case separately, or 3D-print a case yourself. These videos cover all those use cases.
|
||||
|
||||
??? tip "Video guide: Assembly with a metal case"
|
||||
NOTE: OLED will not light up till step 5 is performed, video was performed after it was already configured, heat sinks NOT included.
|
||||
|
||||
|
||||
??? tip "Video guide: Assembly with or without a 3D-printed case"
|
||||
|
||||
|
||||
## Step 1
|
||||
|
||||
Get the parts that are not in the assembly kit:
|
||||
|
||||
* Raspberry Pi 4 with 1Gb RAM or more
|
||||
* Heat sinks (Optional)
|
||||
* MicroSD card (at least 16Gb, class 10 recommended)
|
||||
* USB-C to USB-A cable
|
||||
* HDMI cable
|
||||
* [Straight Ethernet cable](./atx_board/straight.png)
|
||||
* Power supply unit (5.1V 3A USB-C, recommended by the Raspberry Pi)
|
||||
|
||||
!!! tip
|
||||
* Please review the back of the box. All parts are required before the HAT is fully functional.
|
||||
* The USB-C bridge is located in with the ATX end which includes a pink foam spacer.
|
||||
* Please assemble the HAT onto the RPi and test all of the parts before installing in the case, it's easier to install in the case than to dissasemble it.
|
||||
* If going from a V2 to a V3, the splitter is **no longer needed**.
|
||||
|
||||
## Step 2
|
||||
|
||||
Remove contents from assembly kit box:
|
||||
|
||||
# Contents:
|
||||
* 8x M.2 5x12mm screws for the case
|
||||
* 4x M.2 5x12mm screws for the fan
|
||||
* 4x bolts for the fan
|
||||
|
|
@ -16,9 +49,9 @@ Remove contents from box.
|
|||
* 2x small FCC ribbon cables
|
||||
* 1x small rubber square that break out to 4x small rubber feet
|
||||
|
||||
!!! warning "OLED is sensitive to pressure, do NOT push down on the very thin glass as it will crack thereby making the OLED non-functional"
|
||||
!!! warning "OLED is sensitive to pressure, do NOT push down on the very thin glass as it will crack and become non-functional"
|
||||
|
||||
# Step 2
|
||||
## Step 3
|
||||
|
||||
Take bottom part of the case, insert the RPI4 into the bottom case at an angle, you will need to flex the other side ever so slightly to get it to slot in.
|
||||
|
||||
|
|
@ -26,7 +59,7 @@ Take bottom part of the case, insert the RPI4 into the bottom case at an angle,
|
|||
|
||||
??? note "IF you bought heatsink's (sold seperatly), it's advised to install them now before installing the HAT"
|
||||
|
||||
# Step 3
|
||||
## Step 4
|
||||
|
||||
Insert HAT at the same angle, take care to line up the pins on the Rpi with the HAT pin sleeve, the trick to this is to push the Rpi all of the way to the left then all of the way to the right for proper alignment, do NOT force till the pins are aligned. If properly aligned the pins will match up without issue.
|
||||
|
||||
|
|
@ -36,7 +69,7 @@ Insert HAT at the same angle, take care to line up the pins on the Rpi with the
|
|||
|
||||
??? note "ALTERNATIVE: As an alternative to the above, you can pre assemble the hat+fcc cable onto the RPI4, then insert them into the bottom portion of the case however you will need to flex the sides more whereby creating a bigger gap when fully assembled."
|
||||
|
||||
# Step 4
|
||||
## Step 5
|
||||
|
||||
There are 2 ways to insert the FCC cable, you can add it when you insert the RPI in Step 2 OR wait till you also have the HAT installed and slide it into the slot.
|
||||
|
||||
|
|
@ -44,9 +77,9 @@ There are 2 ways to insert the FCC cable, you can add it when you insert the RPI
|
|||
|
||||
??? note "The blue stripes on the ends of the cable will ALWAYS face the side that will be used to tighten the FCC to the camera port or have it positioned towards the power - Ignore the smaller FCC cable that plugs into the USB, was phased out during the KS campaign. This image was used as a means of illustrating FCC placement and orientation"
|
||||
|
||||
# Step 5
|
||||
## Step 6
|
||||
|
||||
Install USB-C bridge.
|
||||
Install the USB-C bridge.
|
||||
|
||||
??? note "This is packaged with the ATX board"
|
||||
<img src="PiKVM_ATX_Packaging.png" width="400" />
|
||||
|
|
@ -56,13 +89,13 @@ Install USB-C bridge.
|
|||
??? note "If you do not install this bridge, mouse/kb will not work"
|
||||
??? note "HAT will still power on without this bridge installed"
|
||||
|
||||
# Step 6
|
||||
## Step 7
|
||||
|
||||
Turn the bottom of the case upside down, install the 2 bottom plastic risers, it's best to install in a wing formation. Top first by inserting the top screws then slide the bottom part aligning the plastic to the holes then inserting the screws. At this point its OK to tighten the bottom screws. There is no need to use force, just tighten enough to prohibit movement.
|
||||
|
||||
<img src="HAT_install_plastic_risers_bottom.jpg" width="400" />
|
||||
|
||||
# Step 7
|
||||
## Step 8
|
||||
|
||||
Take the plastic OLED holder, turn the OLED over where the back side is facing you and insert at an angle so as to create a space between the OLED and holder arm, take a flat head screwdriver (medium normal) and twist it enough so you can clear the electronics on the bottom of the OLED and continue to gently slide in the remaining OLED till its fully inserted.
|
||||
|
||||
|
|
@ -70,25 +103,25 @@ Take the plastic OLED holder, turn the OLED over where the back side is facing y
|
|||
|
||||
!!! warning "Be careful on handling this display, slight pressure will damage the OLED, however in the event that this does happen, replacements are cheap and can be found in most electronic stores or Amazon, look for any IIC (I2C) .91 inch display for Arduino"
|
||||
|
||||
# Step 8
|
||||
## Step 9
|
||||
|
||||
Insert the OLED holder with the OLED display into the plug by gently rocking it back and forth till it's fully inserted.
|
||||
|
||||
<img src="HAT_install_OLED_holder.jpg" width="400" />
|
||||
|
||||
# Step 8a
|
||||
## Step 10
|
||||
|
||||
Install plastic spacer.
|
||||
|
||||
<img src="HAT_install_plastic spacer.jpg" width="400" />
|
||||
|
||||
# Step 9
|
||||
## Step 11
|
||||
|
||||
Install the screws and bolts to secure the fan, it does not matter the orientation of the fan, push or pulling air will result in the same behavior, its personal preference.
|
||||
|
||||
<img src="HAT_install_fan_to_top.jpg" width="400" />
|
||||
|
||||
# Step 10
|
||||
## Step 12
|
||||
|
||||
Insert the fan leads and align Red with positive and Black with negative.
|
||||
|
||||
|
|
@ -96,12 +129,12 @@ Insert the fan leads and align Red with positive and Black with negative.
|
|||
|
||||
!!! warning "You can damage the fan if installed incorrectly"
|
||||
|
||||
# Step 11
|
||||
## Step 13
|
||||
|
||||
Install the top of the case to the bottom, use the 4 remaining screws to secure the top.
|
||||
|
||||
<img src="HAT2_insert_top_part_of_case.jpg" width="400" />
|
||||
|
||||
# Step 12
|
||||
## Step 14
|
||||
|
||||
Please follow the V3 guide and First Steps guide to activate your PiKVM.
|
||||
Please follow the [V3 quick start](../v3/) guide to activate your PiKVM.
|
||||
|
|
|
|||
339
docs/v4.md
339
docs/v4.md
|
|
@ -1,44 +1,231 @@
|
|||
# PiKVM V4 Mini & Plus
|
||||
---
|
||||
title: PiKVM V4 Mini & Plus quick start
|
||||
description: Getting started with PiKVM V4 Mini & Plus
|
||||
---
|
||||
|
||||
<img src="overview.jpg" width="400" />
|
||||
# PiKVM V4 Mini & Plus quick start
|
||||
|
||||
* [PiKVM V4 Mini Datasheet PDF](v4mini_datasheet.pdf)
|
||||
* [PiKVM V4 Plus Datasheet PDF](v4plus_datasheet.pdf)
|
||||
|
||||
|
||||
PiKVM is a feature-rich, production grade, open-source, Raspberry Pi based KVM over IP device. It allows you to turn on/off or restart your computer, configure the UEFI/BIOS, and even reinstall the OS using the Virtual CD-ROM or Flash Drive.
|
||||
|
||||
You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mouse, and a monitor, which are then presented in a web browser as if you were working on a remote system directly.
|
||||
|
||||
**Datasheets**:
|
||||
|
||||
[PiKVM V4 Mini](v4mini_datasheet.pdf){ .md-button } [PiKVM V4 Plus](v4plus_datasheet.pdf){ .md-button }
|
||||
|
||||
## What's in the box
|
||||
|
||||
- PiKVM V4 Mini or Plus device
|
||||
- Micro SD card with pre-imaged PiKVM software
|
||||
- ATX control board
|
||||
- ATX connection cables
|
||||
- ATX installation brackets
|
||||
- 1 x Ethernet cable
|
||||
- 1 x ATX cable
|
||||
- 1 x USB C to USB A cable
|
||||
- 12V 2A Power Supply (international adapters)
|
||||
|
||||
## Interface
|
||||
|
||||
=== "Front view"
|
||||
|
||||
{ height="250" }
|
||||
|
||||
1. Activity LED (Red)
|
||||
2. Power Input 5.1V 3A
|
||||
3. Power LED (Green)
|
||||
4. Micro SD card slot
|
||||
5. USB 2.0 Serial console port
|
||||
6. Serial console active LED / Beacon LED (Green)
|
||||
7. RJ45 1Gb Ethernet port
|
||||
8. RJ45 Serial console port **(V4 Plus only)**
|
||||
9. USB 3.0 port 1 **(V4 Plus only)**
|
||||
10. Power Input 12V 2A **(V4 Plus only)**
|
||||
|
||||
|
||||
-----
|
||||
## Installation requirements
|
||||
=== "Rear view"
|
||||
|
||||
* PiKVM V4 Mini or Plus box kit.
|
||||
* Any reliable HDMI cable.
|
||||
{ height="250" }
|
||||
|
||||
1. Beacon LED
|
||||
2. USB 2.0 OTG connector
|
||||
3. Mount holes for WiFi SMA antenna connector **(only one in V4 Mini)**
|
||||
3. RJ45 ATX control port
|
||||
4. USB 3.0 port 2 **(V4 Plus only)**
|
||||
5. HDMI video output port 1 **(V4 Plus only)**
|
||||
6. HDMI video output port 2 **(V4 Plus only)**
|
||||
7. Optional antenna’s mounting holes
|
||||
8. Video source ready status LED
|
||||
9. HDMI video input port
|
||||
10. Video capture ready status LED
|
||||
11. Ventilation holes
|
||||
|
||||
-----
|
||||
## Basic setup
|
||||
=== "Right view"
|
||||
|
||||
1. Unpack the box and connect the PiKVM according to the below:
|
||||
{ height="250" }
|
||||
|
||||
| Back side | Front side |
|
||||
|-----------|------------|
|
||||
| <img src="plus_back.jpg" width="300" /> | <img src="plus_front.jpg" width="300" /> |
|
||||
1. Service switches
|
||||
2. Kensington Security Slot
|
||||
|
||||
* **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.
|
||||
=== "Top view"
|
||||
|
||||
* Connect **Ethernet** (**bottom right** on the **front** side) to the network using the cable from the kit. The kit includes two Ethernet cables of different colors: one for the network, the second for ATX. Use whichever one you like best.
|
||||
{ height="250" }
|
||||
|
||||
* 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).
|
||||
1. Display
|
||||
|
||||
!!! warning
|
||||
Do not block the ventilation holes on the sides of the device. This is especially important for the V4 Plus, which has an active cooling.
|
||||
## Wiring
|
||||
|
||||
2. Wait until PiKVM starts and shows a greeting on the built-in display.<br>
|
||||
Do not turn off the device until it's fully booted for the first time.
|
||||
Let's connect all the wires before you power up the device.
|
||||
|
||||
3. **Carefully read and follow [the "First steps" guide](first_steps.md){target=_blank}.**<br>
|
||||
It describes how to find PiKVM on the network, how to log in there, change passwords, and so on.<br>
|
||||
**Follow the steps described there and come back to this page.**
|
||||
### Network
|
||||
|
||||
4. ??? note "Using Fahrenheit instead of Celsius on the OLED"
|
||||
|
||||
|
||||
Connect **Ethernet** (**bottom right** on the **front** side) to the network using the cable from the kit. The kit includes two Ethernet cables of different colors: one for the network, the second for ATX. Use whichever one you like best.
|
||||
|
||||
### HDMI and USB-C
|
||||
|
||||
|
||||
|
||||
**HDMI input** (the **bottom right** on the **rear** 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.
|
||||
|
||||
## Power up
|
||||
|
||||
|
||||
|
||||
V4 Mini and V4 Plus have different power supplies:
|
||||
|
||||
- The Mini comes with USB-C 5V power supply
|
||||
- The Plus comes with with Barrel 12V
|
||||
|
||||
The Plus can also work from 5V. In that case, avoid creating a significant power load on USB (external flash sticks, cameras, and so on).
|
||||
|
||||
Attach the appropriate connector on the **front** side. Do **not** block the ventilation holes on the sides of the device.
|
||||
|
||||
After turning on the power, PiKVM OS generates unique SSH keys and certificates and performs all necessary operations on the memory card. It takes a few minutes. Do **not** turn off the device until it's fully booted for the first time. Once it's done, the PiKVM will show a greeting on the built-in display.
|
||||
|
||||
## Connect and set up
|
||||
|
||||
### Configure the display
|
||||
|
||||
The operating system on your remote computer will treat PiKVM as an additional display and use it in the Extend mode by default. That's why you will see an empty desktop when you first connect.
|
||||
|
||||
To avoid that, go to the display settings in your remote computer's operating system and enable the mirror mode for the external screen that you operating system identifies as PiKVM. Refer to your operating system's documentation on that.
|
||||
|
||||
### Access PiKVM
|
||||
|
||||
By default, PiKVM receives a dynamic IP address via DHCP and shows it in the top row of the OLED display:
|
||||
|
||||
```console
|
||||
192.168.0.26
|
||||
(|) iface: eth0
|
||||
cpu: 1% mem: 13%
|
||||
```
|
||||
|
||||
Let's assume that PiKVM has received the address `192.168.0.26` and has also been assigned a hostname `pikvm`.
|
||||
|
||||
Type the URL in the browser's address bar and press **Enter**: https://192.168.0.26/ or https://pikvm/.
|
||||
|
||||
|
||||
|
||||
Submit the default credentials and click **Login**:
|
||||
|
||||
- Username: `admin`
|
||||
- Password: `admin`
|
||||
- 2FA Code: disabled by default, skip this field
|
||||
|
||||
You will see the initial dashboard screen of the PiKVM where you can access the remote desktop, connect to the PiKVM over SSH, or log out:
|
||||
|
||||
|
||||
|
||||
### Change the default passwords
|
||||
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time. To do that:
|
||||
|
||||
1. On the initial dashboard screen, click the **Terminal** button to open the web terminal. You will see this command line interface:
|
||||
|
||||
|
||||
|
||||
2. Gain superuser privileges:
|
||||
|
||||
```console
|
||||
$ su -
|
||||
```
|
||||
|
||||
When prompted for password, use `root`.
|
||||
|
||||
3. Run `rw` to change the access to the SD card to the write mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# rw
|
||||
```
|
||||
|
||||
4. Change the password for the superuser:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# passwd root
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, press **Enter**, and you should see this:
|
||||
|
||||
```console
|
||||
passwd: password updated successfully
|
||||
```
|
||||
|
||||
5. Change the password for web access:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# kvmd-htpasswd set admin
|
||||
```
|
||||
|
||||
Submit the new password, retype it the second time to confirm, and press **Enter**.
|
||||
|
||||
6. Run `ro` to change the access to the SD card back to the read-only mode:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# ro
|
||||
```
|
||||
|
||||
7. Press **Ctrl+D** or type "exit" and press **Enter** to drop the root privileges.
|
||||
|
||||
8. Go back one page in the browser. You should be back to the initial dashboard screen.
|
||||
|
||||
### Access the remote system
|
||||
|
||||
1. On the initial dashboard screen, click the **KVM** button to access the remote desktop.
|
||||
|
||||
2. You should now see the host system's display and interact with it remotely using a keyboard and a mouse.
|
||||
|
||||
|
||||
|
||||
## Further steps
|
||||
|
||||
1. **Get to know PiKVM OS**: read [this help section](webui.md) to better understand all the possibilities of the web user interface.
|
||||
|
||||
2. **Update and customize the system**:
|
||||
|
||||
- [Update](_update_os.md) the PiKVM operating system.
|
||||
- [Harden the remote access](auth.md) by enabling 2FA and setting session expiration time.
|
||||
- Configure access to PiKVM from the Internet using [port forwarding](port_forwarding.md) or [Tailscale VPN](tailscale.md).
|
||||
- Enable a microphone for [two-way audio](audio.md).
|
||||
- Enable [HDMI pass-through](pass.md).
|
||||
|
||||
3. **Configure hardware**:
|
||||
|
||||
- Set up [ATX connection](atx_board.md).
|
||||
- Configure [DIP switches](dip_switches.md)
|
||||
- Install and set up [Wi-Fi antenna](wifi.md).
|
||||
- Install and set up [LTE/5G modem](modem.md) (**only for PiKVM V4 Plus**).
|
||||
- Set up [USB 3.0](usb3v4.md) (**only for PiKVM V4 Plus**).
|
||||
- Choose Fahrenheit over Celsius to display on the OLED:
|
||||
|
||||
??? note "How to set up Fahrenheit"
|
||||
|
||||
Create a directory for a configuration file:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# mkdir -p /etc/systemd/system/kvmd-oled.service.d
|
||||
|
|
@ -54,94 +241,16 @@
|
|||
|
||||
Then run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
|
||||
|
||||
5. **Just reminding again:**
|
||||
|
||||
{!_passwd.md!}
|
||||
|
||||
6. Try to manage the computer using PiKVM with the Web Interface.<br>
|
||||
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).
|
||||
|
||||
7. Enable [microphone for two-way audio](audio.md){target=_blank} if you want.
|
||||
|
||||
8. Configure access to PiKVM from the Internet using [port forwarding](https://docs.pikvm.org/port_forwarding)
|
||||
or [Tailscale VPN](https://docs.pikvm.org/tailscale), if you need it.
|
||||
|
||||
9. **If you are using PiKVM V4 Plus, check out its new exclusive feature: [HDMI Passthrough](pass.md)!**
|
||||
|
||||
10. Explore the features of PiKVM using the site's table of contents and have fun!
|
||||
|
||||
|
||||
-----
|
||||
## ATX connection
|
||||
|
||||
[See here](atx_board.md).
|
||||
|
||||
|
||||
-----
|
||||
## DIP switches
|
||||
|
||||
There is a pair of DIP switches on the V4 right side. It is not recommended to change their state while the device is turned on.
|
||||
|
||||
| Right side |
|
||||
|------------|
|
||||
| <img src="plus_right.jpg" width="450" /> |
|
||||
|
||||
* The left switch **[1]**. When pulled down (**ON** state), the advanced backpower protection is used.
|
||||
On the default state is **OFF** (up), "diode protection" is used.
|
||||
This is required for debugging at the request of technical support. Under normal conditions, it is not necessary to change the mode.
|
||||
|
||||
* The right switch **[2]**. When pulled down (**ON** state), the Power Delivery chip is activated on the USB OTG port.
|
||||
The default state is **OFF** (up).
|
||||
|
||||
|
||||
-----
|
||||
## Wi-Fi antenna
|
||||
|
||||
The PiKVM V4 has a robust metal case that protects your device from physical damage and electromagnetic interference.
|
||||
This also means that an external antenna must be used for Wi-Fi.
|
||||
We recommend the [official Antenna Kit](https://www.raspberrypi.com/products/compute-module-4-antenna-kit)
|
||||
for Raspberry Pi.
|
||||
|
||||
To install the antenna, fix it in the round hole in the back side of the PiKVM,
|
||||
and connect the wire to the connector on the Compute Module 4,
|
||||
as described in the [instructions](https://datasheets.raspberrypi.com/cm4/cm4-antenna-kit-product-brief.pdf).
|
||||
|
||||
Next, to activate the antenna, add line `dtparam=ant2` to the `/boot/config.txt` file on PiKVM.
|
||||
|
||||
[Follow this guide](wifi.md) to configure Wi-Fi in PiKVM OS.
|
||||
|
||||
|
||||
-----
|
||||
## LTE/5G modem installation to V4 Plus
|
||||
|
||||
[See here](modem.md).
|
||||
|
||||
|
||||
-----
|
||||
## Internal USB on V4 Plus
|
||||
|
||||
The V4 Plus has an internal USB port that can be used at your discretion.
|
||||
It supports USB 3.0, but by default it only works with USB 2.0 devices due to energy savings.
|
||||
To enable USB 3.0, it is required to flash the USB controller firmware. It's very easy:
|
||||
|
||||
1. Choose `usb3` for USB 3.0 support, or `default` for the default USB 2.0-only firmware:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# flashrom-vl805 usb3
|
||||
```
|
||||
|
||||
2. Perform the soft reboot:
|
||||
|
||||
```console
|
||||
[root@pikvm ~]# reboot
|
||||
```
|
||||
|
||||
3. After the soft reboot, perform **reboot by power** (unplug and plug again the power cable).
|
||||
|
||||
|
||||
-----
|
||||
## Known issues and limitations
|
||||
* 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. In the last case, [USB dynamic configuration](usb.md) will solve the problem.
|
||||
* While there is a Mini-PCIe slot in the V4 Plus, this was only designed with the LTE modem with USB lines in mind, therefore if you decide to get a NVME card, it will not work.
|
||||
|
||||
* There may be compatibility issues with some motherboards, such as **HP** or **DELL**. 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. In the latter case, [USB dynamic configuration](usb.md) will solve the problem.
|
||||
* While there is a Mini-PCIe slot in the V4 Plus, it was only designed for LTE modems. An NVME card will not work.
|
||||
|
||||
## Basic troubleshooting
|
||||
|
||||
{!_basic_troubleshooting.md!}
|
||||
|
||||
|
||||
## Getting user support
|
||||
|
||||
If something doesn't work, check out our [FAQ](faq.md). Otherwise, head straight to our [Discord chat](https://discord.gg/bpmXfz5).
|
||||
Binary file not shown.
|
After Width: | Height: | Size: 36 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 247 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 102 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 153 KiB |
Binary file not shown.
|
After Width: | Height: | Size: 2.6 MiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 100 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 118 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 126 KiB |
|
|
@ -0,0 +1,205 @@
|
|||
<?xml version="1.0" encoding="UTF-8" standalone="no"?>
|
||||
<!-- Created with Inkscape (http://www.inkscape.org/) -->
|
||||
|
||||
<svg
|
||||
width="674.25214"
|
||||
height="355.42401"
|
||||
viewBox="0 0 178.39587 94.039272"
|
||||
version="1.1"
|
||||
id="svg1"
|
||||
inkscape:export-filename="v4-plus-front-view.png"
|
||||
inkscape:export-xdpi="96"
|
||||
inkscape:export-ydpi="96"
|
||||
inkscape:version="1.4 (e7c3feb100, 2024-10-09)"
|
||||
sodipodi:docname="v4-plus-front-view.svg"
|
||||
xmlns:inkscape="http://www.inkscape.org/namespaces/inkscape"
|
||||
xmlns:sodipodi="http://sodipodi.sourceforge.net/DTD/sodipodi-0.dtd"
|
||||
xmlns="http://www.w3.org/2000/svg"
|
||||
xmlns:svg="http://www.w3.org/2000/svg">
|
||||
<sodipodi:namedview
|
||||
id="namedview1"
|
||||
pagecolor="#ffffff"
|
||||
bordercolor="#000000"
|
||||
borderopacity="0.25"
|
||||
inkscape:showpageshadow="2"
|
||||
inkscape:pageopacity="0.0"
|
||||
inkscape:pagecheckerboard="0"
|
||||
inkscape:deskcolor="#d1d1d1"
|
||||
inkscape:document-units="px"
|
||||
inkscape:zoom="0.70710678"
|
||||
inkscape:cx="510.5311"
|
||||
inkscape:cy="122.32947"
|
||||
inkscape:window-width="1280"
|
||||
inkscape:window-height="683"
|
||||
inkscape:window-x="0"
|
||||
inkscape:window-y="0"
|
||||
inkscape:window-maximized="1"
|
||||
inkscape:current-layer="layer1" />
|
||||
<defs
|
||||
id="defs1" />
|
||||
<g
|
||||
inkscape:label="Layer 1"
|
||||
inkscape:groupmode="layer"
|
||||
id="layer1"
|
||||
transform="translate(-18.067023,-19.953594)">
|
||||
<rect
|
||||
style="fill:#ffffff;fill-opacity:1;stroke:none;stroke-width:1.05833;stroke-opacity:1"
|
||||
id="rect13"
|
||||
width="178.39587"
|
||||
height="94.039268"
|
||||
x="18.067022"
|
||||
y="19.953594"
|
||||
rx="0"
|
||||
ry="0"
|
||||
sodipodi:insensitive="true" />
|
||||
<rect
|
||||
style="fill:none;stroke:#000000;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
id="rect1"
|
||||
width="151.4646"
|
||||
height="64.682396"
|
||||
x="33.95826"
|
||||
y="42.582573"
|
||||
rx="3.2341197"
|
||||
ry="3.2341197" />
|
||||
<rect
|
||||
style="fill:none;stroke:#000000;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
id="rect2"
|
||||
width="33.95826"
|
||||
height="9.5487366"
|
||||
x="45.277679"
|
||||
y="56.597095"
|
||||
rx="3.2341194"
|
||||
ry="3.2341194" />
|
||||
<rect
|
||||
style="fill:none;stroke:#000000;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
id="rect3"
|
||||
width="35.016586"
|
||||
height="20.482759"
|
||||
x="44.748516"
|
||||
y="77.618874"
|
||||
rx="3.2341192"
|
||||
ry="3.2341192" />
|
||||
<rect
|
||||
style="fill:none;stroke:#000000;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
id="rect4"
|
||||
width="33.95826"
|
||||
height="9.5487366"
|
||||
x="88.854202"
|
||||
y="56.597095"
|
||||
rx="3.2341194"
|
||||
ry="3.2341194" />
|
||||
<rect
|
||||
style="fill:none;stroke:#000000;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
id="rect5"
|
||||
width="35.016586"
|
||||
height="20.482759"
|
||||
x="88.325043"
|
||||
y="77.618874"
|
||||
rx="3.2341192"
|
||||
ry="3.2341192" />
|
||||
<rect
|
||||
style="fill:none;stroke:#000000;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
id="rect6"
|
||||
width="33.95826"
|
||||
height="9.5487366"
|
||||
x="135.2395"
|
||||
y="56.597095"
|
||||
rx="3.2341194"
|
||||
ry="3.2341194" />
|
||||
<rect
|
||||
style="fill:none;stroke:#000000;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
id="rect7"
|
||||
width="35.016586"
|
||||
height="20.482759"
|
||||
x="134.71034"
|
||||
y="77.618874"
|
||||
rx="3.2341192"
|
||||
ry="3.2341192" />
|
||||
<path
|
||||
style="fill:none;stroke:#21aeff;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
d="M 62.256809,61.371463 V 30.724139 H 33.958257"
|
||||
id="path7" />
|
||||
<circle
|
||||
id="path8"
|
||||
style="fill:#21aeff;stroke:none;stroke-width:0.264583"
|
||||
cx="62.256809"
|
||||
cy="61.371464"
|
||||
r="1.5875" />
|
||||
<circle
|
||||
style="fill:none;stroke:#21aeff;stroke-width:0.529167;stroke-dasharray:none;stroke-opacity:1"
|
||||
id="path9"
|
||||
cx="28.907927"
|
||||
cy="30.724138"
|
||||
r="4.8511786" />
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-weight:bold;font-size:6.35px;font-family:'Droid Sans';-inkscape-font-specification:'Droid Sans Bold';text-align:start;writing-mode:lr-tb;direction:ltr;text-anchor:start;fill:#21aeff;fill-opacity:1;stroke:none;stroke-width:1.05833;stroke-opacity:1"
|
||||
x="27.108868"
|
||||
y="32.990665"
|
||||
id="text9"><tspan
|
||||
sodipodi:role="line"
|
||||
id="tspan9"
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Droid Sans';-inkscape-font-specification:'Droid Sans';fill:#21aeff;fill-opacity:1;stroke:none;stroke-width:1.05833"
|
||||
x="27.108868"
|
||||
y="32.990665">1</tspan></text>
|
||||
<path
|
||||
style="fill:none;stroke:#21aeff;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
d="M 152.21862,61.371462 V 30.724138 h 28.29856"
|
||||
id="path10" />
|
||||
<circle
|
||||
id="circle10"
|
||||
style="fill:#21aeff;stroke:none;stroke-width:0.264583"
|
||||
cx="-152.21863"
|
||||
cy="61.371464"
|
||||
r="1.5875"
|
||||
transform="scale(-1,1)" />
|
||||
<circle
|
||||
style="fill:none;stroke:#21aeff;stroke-width:0.529167;stroke-dasharray:none;stroke-opacity:1"
|
||||
id="circle11"
|
||||
cx="-185.56755"
|
||||
cy="30.724136"
|
||||
r="4.8511786"
|
||||
transform="scale(-1,1)" />
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-weight:bold;font-size:6.35px;font-family:'Droid Sans';-inkscape-font-specification:'Droid Sans Bold';text-align:start;writing-mode:lr-tb;direction:ltr;text-anchor:start;fill:#21aeff;fill-opacity:1;stroke:none;stroke-width:1.05833;stroke-opacity:1"
|
||||
x="183.98769"
|
||||
y="32.992214"
|
||||
id="text11"><tspan
|
||||
sodipodi:role="line"
|
||||
id="tspan11"
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Droid Sans';-inkscape-font-specification:'Droid Sans';fill:#21aeff;fill-opacity:1;stroke:none;stroke-width:1.05833"
|
||||
x="183.98769"
|
||||
y="32.992214">3</tspan></text>
|
||||
<path
|
||||
style="fill:none;stroke:#21aeff;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
d="M 105.83332,61.371462 V 35.575317"
|
||||
id="path11"
|
||||
sodipodi:nodetypes="cc" />
|
||||
<circle
|
||||
id="circle12"
|
||||
style="fill:#21aeff;stroke:none;stroke-width:0.264583"
|
||||
cx="-105.83333"
|
||||
cy="61.371464"
|
||||
r="1.5875"
|
||||
transform="scale(-1,1)" />
|
||||
<circle
|
||||
style="fill:none;stroke:#21aeff;stroke-width:0.52916666;stroke-opacity:1;stroke-dasharray:none"
|
||||
id="circle13"
|
||||
cx="-105.83332"
|
||||
cy="30.724138"
|
||||
r="4.8511786"
|
||||
transform="scale(-1,1)" />
|
||||
<text
|
||||
xml:space="preserve"
|
||||
style="font-weight:bold;font-size:6.35px;font-family:'Droid Sans';-inkscape-font-specification:'Droid Sans Bold';text-align:start;writing-mode:lr-tb;direction:ltr;text-anchor:start;fill:#21aeff;fill-opacity:1;stroke:none;stroke-width:1.05833;stroke-opacity:1"
|
||||
x="104.18609"
|
||||
y="32.992214"
|
||||
id="text13"><tspan
|
||||
sodipodi:role="line"
|
||||
id="tspan13"
|
||||
style="font-style:normal;font-variant:normal;font-weight:normal;font-stretch:normal;font-family:'Droid Sans';-inkscape-font-specification:'Droid Sans';fill:#21aeff;fill-opacity:1;stroke:none;stroke-width:1.05833"
|
||||
x="104.18609"
|
||||
y="32.992214">2</tspan></text>
|
||||
</g>
|
||||
</svg>
|
||||
|
After Width: | Height: | Size: 7.3 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 100 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 148 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 31 KiB |
File diff suppressed because one or more lines are too long
|
After Width: | Height: | Size: 27 KiB |
|
|
@ -0,0 +1 @@
|
|||
Subproject commit 3a7cc2a70124c0d30b461bb07136cd9e2028fa3c
|
||||
|
|
@ -49,6 +49,8 @@ markdown_extensions:
|
|||
- pymdownx.details
|
||||
- pymdownx.superfences
|
||||
- pymdownx.magiclink
|
||||
- pymdownx.tabbed:
|
||||
alternate_style: true
|
||||
- pymdownx.blocks.caption
|
||||
- toc:
|
||||
permalink: true
|
||||
|
|
@ -85,7 +87,7 @@ plugins:
|
|||
nav:
|
||||
- "Device guides":
|
||||
- "PiKVM V4 Mini & Plus": v4.md
|
||||
- "PiKVM V3 HAT": v3.md
|
||||
- "PiKVM V3": v3.md
|
||||
- "PiKVM Switch": switch.md
|
||||
- "DIY PiKVM V2": v2.md
|
||||
- "DIY PiKVM V1": v1.md
|
||||
|
|
@ -122,6 +124,7 @@ nav:
|
|||
- "Serial-over-USB": usb_serial.md
|
||||
- "GPIO (pins, relays, lamps, etc)": gpio.md
|
||||
- "Advanced usage":
|
||||
- "Structure of configuration files": conf_files_structure.md
|
||||
- "On-boot configuration": on_boot_config.md
|
||||
- "Using VNC": vnc.md
|
||||
- "Multiport KVM-over-IP": multiport.md
|
||||
|
|
@ -129,6 +132,8 @@ nav:
|
|||
- "IPMI & Redfish integration": ipmi.md
|
||||
- "Persistent storage": pst.md
|
||||
- "Prometheus monitoring": prometheus.md
|
||||
- "DIP switches": dip_switches.md
|
||||
- "USB 3.0 support": usb3v4.md
|
||||
- "Development":
|
||||
- "HTTP API reference": api.md
|
||||
- "Building PiKVM OS": building_os.md
|
||||
|
|
|
|||
Loading…
Reference in New Issue