Projects STRLCPY pikvm Commits 0f678d06
🤬
  • ■ ■ ■ ■ ■ ■
    docs/first_steps.md
    skipped 2 lines
    3 3  ## First power on
    4 4   
    5 5  !!! warning
    6  - - v2 DIY owners: Please follow this [first](https://github.com/pikvm/pikvm)<br>
    7  - - v3 HAT *or* pre-assembled users: Please follow this [first](https://docs.pikvm.org/v3/)<br>
     6 + - V2 DIY owners: Please follow this [first](https://github.com/pikvm/pikvm)<br>
     7 + - V3 HAT *or* pre-assembled users: Please follow this [first](https://docs.pikvm.org/v3/)<br>
    8 8   - For both to work and display a video, your target system needs to be configured for the following:<br>
    9 9   1920x1080p50Hz (In some rare instances, try 30hz)<br>
    10 10   1600x1200p60Hz<br>
    skipped 27 lines
    38 38  !!! warning "Do not turn off the device until it's fully booted for the first time"
    39 39   After turning on the power, PiKVM OS will generate unique SSH keys and certificates and will perform all necessary operations on the memory card.
    40 40   
     41 + 
    41 42  ## Getting access to PiKVM
    42 43   
    43  -By default, PiKVM receives a dynamic IP address via DHCP.
     44 +By default, PiKVM receives a dynamic IP address via DHCP. V3+ devices show IP on the built-in display. If you don't have a display, use the tips below:
    44 45   
    45 46  ??? example "Finding PiKVM in the network"
    46 47   To determine the IP address of your PiKVM, use one of the following methods:
    skipped 52 lines
    99 100   ```
    100 101   
    101 102   Optionally you can enable the [two-factor authentication](auth.md#two-factor-authentication).
     103 + 
    102 104   
    103 105  ## Configuring PiKVM
    104 106   
    skipped 81 lines
  • ■ ■ ■ ■ ■
    docs/index.md
    skipped 5 lines
    6 6  ## Where to start?
    7 7   
    8 8  * **Learn about the [basics of working with PiKVM](first_steps.md).**
    9  -* If you are a happy **PiKVM v3 HAT** user then we have a [special guide for you](v3.md).
     9 +* If you are a happy **PiKVM V4/V3** owner then we have some special guides for you:
     10 + * [PiKVM V4 Mini & Plus](v4.md)
     11 + * [PiKVM V3 HAT / Pre-Assembled](v3.md)
    10 12  * **Explore the features of PiKVM** using the site's table of contents.
    11 13  * **If you encounter a problem**, take a look at the **[FAQ](faq.md)**, but if nothing helped, contact our **[Discord chat](https://discord.gg/bpmXfz5)** - experienced users and the PiKVM team will definitely help you.
    12 14   
    skipped 10 lines
  • ■ ■ ■ ■ ■ ■
    docs/v3.md
    skipped 27 lines
    28 28   
    29 29  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.
    30 30   
    31  -!!! warning "Please use the V3 image, V2 image is not compatible"
    32  - 
    33  -1. **[Flash the memory card.](flashing_os.md){target=_blank}**
     31 +1. **[Flash the memory card.](flashing_os.md){target=_blank}**. Please use the V3 image, V2 image is not compatible.
    34 32   
    35 33  2. **Build PiKVM** according to the video instruction or review the [illustrated instructions](v3_illustrated_install_instructions.md):
    36 34  
    skipped 13 lines
    50 48   |-----------|------------|
    51 49   | <img src="basic_back.jpg" width="300" /> | <img src="basic_front.jpg" width="300" /> |
    52 50   
    53  - * **HDMI input** and **USB emulation** port must be connected to the computer. [**ATX** too](atx_board.md), but it's optional. There should be no USB hub between PiKVM and the computer, as some UEFI/BIOS cannot detect them at the boot stage. On the HDMI the HAT, like the CSI bridge, supports 1080p50Hz or 720p60Hz or lower.
     51 + * **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.
    54 52   
    55 53   * Connect **Ethernet** to the network and **USB power** to the Raspberry Pi power supply.
    56 54   
    57  -4. **Carefully read [the "First steps" guide](first_steps.md){target=_blank}** - how to find a device on the network, how to log in there, change passwords, and so on. **Follow the steps described there and come back here**.
     55 +4. **Carefully read [the "First steps" guide](first_steps.md){target=_blank}** - how to find a device on the network, how to log in there, change passwords, and so on. **Follow the steps described there and come back to this page**.
    58 56   
    59 57  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)"
    60 58   Log in to PiKVM and run these commands:
    skipped 14 lines
    75 73   ExecStart=
    76 74   ExecStart=/usr/bin/kvmd-oled --clear-on-exit --fahrenheit
    77 75   ```
    78  - And run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the pikvm.
     76 + And run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
    79 77   
    80 78  7. !!! danger "Just reminding again: CHANGE THE PASSWORDS! :)"
    81 79   How to do this was written in [the "First steps" guide](first_steps.md){target=_blank}
    skipped 7 lines
    89 87   **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.
    90 88   
    91 89  11. **You can also try the experimental [audio forwarding](audio.md){target=_blank}**.
     90 + 
     91 +12. Explore the features of PiKVM using the site's table of contents and have fun!
    92 92   
    93 93   
    94 94  ## ATX connection
    skipped 54 lines
    149 149   
    150 150   
    151 151  ## Known issues and limitations
    152  -* The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~20-24 FPS for 1080p over LAN**.
     152 +* The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~24-28 FPS for 1080p over LAN**.
    153 153  * 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.
    154 154  * Pre-release V3.2 board (NOT Kickstarter/Store edition) doesn't have HDMI backpowering workaround jumper.
    155 155   
  • docs/v4/plus_back.jpg
  • docs/v4/plus_front.jpg
  • ■ ■ ■ ■ ■
    docs/v4.md
    skipped 7 lines
    8 8   
    9 9  ## Installation requirements
    10 10   
    11  -TODO
     11 +* PiKVM V4 Mini or Plus box kit.
     12 +* Any reliable HDMI cable.
     13 +* Ethernet cable for connecting PiKVM to the router.
    12 14   
    13 15   
    14 16  ## Basic setup
    15 17   
    16  -TODO
     18 +1. Unpack the box and connect the PiKVM according to diagram:
    17 19   
     20 + | Back side | Front side |
     21 + |-----------|------------|
     22 + | <img src="plus_back.jpg" width="300" /> | <img src="plus_front.jpg" width="300" /> |
    18 23   
    19  -## ATX connection
     24 + * **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.
    20 25   
    21  -[See here](atx_board.md).
     26 + * Connect **Ethernet** (**bottom right** on the **front** size) to the network.
    22 27   
     28 + * 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).
    23 29   
    24  -## IO ports and jumpers
     30 +2. Wait until PiKVM starts and shows a greeting on the built-in display. Do not turn off the device until it's fully booted for the first time.
    25 31   
    26  -TODO
     32 +3. **Carefully read [the "First steps" guide](first_steps.md){target=_blank}** - how to find a device on the network, how to log in there, change passwords, and so on. **Follow the steps described there and come back to this page**.
     33 + 
     34 +4. ??? note "Using Fahrenheit instead of Celsius on the OLED"
     35 + ```
     36 + # mkdir -p /etc/systemd/system/kvmd-oled.service.d
     37 + ```
     38 + Create file `touch or nano /etc/systemd/system/kvmd-oled.service.d/override.conf`:
     39 + ```ini
     40 + [Service]
     41 + ExecStart=
     42 + ExecStart=/usr/bin/kvmd-oled --clear-on-exit --fahrenheit
     43 + ```
     44 + And run `systemctl restart kvmd-oled`. In some cases, if you still do not see Fahrenheit being displayed, reboot the device.
     45 + 
     46 +5. !!! danger "Just reminding again: CHANGE THE PASSWORDS! :)"
     47 + How to do this was written in [the "First steps" guide](first_steps.md){target=_blank}
     48 + 
     49 +6. **Try to manage the computer using PiKVM with the Web Interface.** Make sure that you get an image and both keyboard and mouse are working. If something doesn't work, check out our [FAQ](faq.md) (it's really useful). If nothing helped, you can get support in our [Discord chat](https://discord.gg/bpmXfz5).
     50 + 
     51 +7. Explore the features of PiKVM using the site's table of contents and have fun!
     52 + 
     53 + 
     54 +## ATX connection
     55 + 
     56 +[See here](atx_board.md).
    27 57   
    28 58   
    29 59  ## Known issues and limitations
    30  -* The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~20-24 FPS for 1080p over LAN**.
     60 +* The actual frame rate of the image received via HDMI will depend on the network bandwidth, resolution and the load on the Raspberry Pi. This is usually **~24-28 FPS for 1080p over LAN**.
    31 61  * 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.
    32 62   
  • ■ ■ ■ ■ ■ ■
    mkdocs.yml
    skipped 59 lines
    60 60   
    61 61  nav:
    62 62   - "Getting started":
    63  -# - "PiKVM V4 guide": v4.md
    64  - - "PiKVM V3 HAT guide": v3.md
     63 + - "PiKVM V4 Mini & Plus": v4.md
     64 + - "PiKVM V3 HAT": v3.md
    65 65   - "First steps": first_steps.md
    66 66   - "Authentication": auth.md
    67 67   - "FAQ": faq.md
    skipped 32 lines
Please wait...
Page is in error, reload to recover