PiKVM

Basic setup


PiKVM v4 Mini

  • 2.) The Mini comes with USB-C 5 Volt power adapter.
  • 7.) Connect Ethernet to the network using the cable from the kit
  • 8.) The ATX port can be connected to control the power (Ethernet cable using the cable from the kit)
  • 9.) OTG port (USB emulation) should be connected to the computer
  • 13.) HDMI input should be connected to the computer


On-boot configuration

At the first boot, PiKVM generates encryption keys and performs other actions necessary to configure the device.

Some parameters, such as connecting to Wi-Fi, or configuring a static interface for wired Ethernet, can be easily changed by the user if there is physical access to the memory card. This is convenient for quick customization of your device before the first use.

All settings are made using a file pikvm.txt on the first section of the memory card. After applying the settings, the file is automatically deleted.

  1. The device must be turned off!
  2. Remove the PiKVM memory card.
  3. Insert the memory card into the computer and mount the first FAT32 partition.
  4. Among the system files you will see the file pikvm.txt. If you haven't enabled PiKVM yet, this file will contain a single line FIRST_BOOT=1, do not remove it. This is the trigger needed to initialize the OS at the first boot. On the contrary, if the file pikvm.txt does not exist, you should not add this line.
  5. Configures a static IP on the Ethernet port. Only IPv4 is available here. All three options must be set simultaneously to avoid incorrect configuration. Like following: ETH_ADDR=192.168.0.100/24 ETH_DNS=1.1.1.1 ETH_GW=192.168.0.1
  6. Unmount partition and return the memory card to PiKVM.
  7. Note, that after applying the settings, the pikvm.txt file will be deleted.


Access to PiKVM Web Interface

Type the URL in the browser's address bar and press Enter: https://192.168.0.100/ or https://pikvm/ 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.


Access 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:
  • Linux, MacOS: Open any terminal application and run: ssh root@192.168.0.100 or ssh root@pikvm
  • Windows: Use PuTTY for this
The default root password is root.


Obtaining root access

  • 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.


Updating PiKVM OS

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.

To update, run following commands under the root user: [root@pikvm ~]# pikvm-update If you encounter an error like: [root@pikvm ~]# pikvm-update bash: pikvm-update: command not found It's most likely you have an old OS release. You can update the OS as follows: [root@pikvm ~]# curl https://files.pikvm.org/update-os.sh | bash Next time you will be able to use the usual method with pikvm-update.


Change the passwords!

PiKVM comes with the following default passwords:
  • Linux admin (SSH, console, etc.): user: root, password: root
  • PiKVM Web Interface (API, VNC...): user: admin, password: admin, no 2FA code

These are two separate entities with independent accounts.

To change passwords, you will need to use the console access via SSH or the Web Terminal. If you are using the Web Terminal, enter the su - command to get the root access (enter the root user password): [root@pikvm ~]# rw [root@pikvm ~]# passwd root [root@pikvm ~]# kvmd-htpasswd set admin [root@pikvm ~]# ro If you require additional user for the Web UI access, use the following: [root@pikvm ~]# kvmd-htpasswd set # Set a new user with password or change of an existing one [root@pikvm ~]# kvmd-htpasswd del # Remove/delete a user