diy first launch

  1. Double-check the correct assembly of the device, and make sure that you have connected all the necessary cables to the host: USB, HDMI and ATX.

  2. Flash the memory card with PiKVM OS and insert it to Raspberry Pi.

  3. Carefully read and follow the First Steps Guide.
    It describes how to perform the first power-on, how to find PiKVM on the network, login, change passwords, and so on.
    Follow the steps described there and come back to this page.

  4. Just reminding again:

    ✮ ✮ ✮ 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 <user> # Set a new user with password or change of an existing one
    [root@pikvm ~]# kvmd-htpasswd del <user> # Remove/delete a user
    

    Optionally you can enable the two-factor authentication for more security.

    Changing the VNCAuth passkey and IPMI password at the first start of PiKVM is not required, since these services are disabled by default. But it is here just so that you remember their existence.

  5. 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 (it's really useful). If nothing helped, you can get support in our Discord chat.

  6. Note for the HDMI-USB dongle

    Many USB video capture devices tell the server's video card that the HDMI cable is supposedly disconnected. This may lead to the fact that if you boot the server without an active stream, the server will not detect your capture card. This is easy to fix:

    • Switch filesystem to RW-mode:

      [root@pikvm ~]# rw
      
    • Edit file /etc/kvmd/override.yaml and add these lines:

      kvmd:
          streamer:
              forever: true
              cmd_append: [--slowdown]
      
    • Finish:

      [root@pikvm ~]# ro
      [root@pikvm ~]# systemctl restart kvmd
      
    • Check that everything is working.

  7. Configure access to PiKVM from the Internet using port forwarding or Tailscale VPN, if you need it.

  8. Explore the features of PiKVM using the site's table of contents and have fun!