mirror of
https://github.com/pikvm/pikvm.git
synced 2026-10-19 09:24:47 +02:00
update
This commit is contained in:
Maxim Devaev
@@ -0,0 +1,17 @@
|
||||
---
|
||||
search:
|
||||
exclude: true
|
||||
---
|
||||
|
||||
|
||||
<div class="grid" markdown>
|
||||
|
||||
[PiKVM V4 Mini & Plus](v4.md){ .md-button .md-button--stretch }
|
||||
|
||||
[PiKVM V3](v3.md){ .md-button .md-button--stretch }
|
||||
|
||||
[DIY PiKVM V2](v2.md){ .md-button .md-button--stretch }
|
||||
|
||||
[DIY PiKVM V1](v1.md){ .md-button .md-button--stretch }
|
||||
|
||||
</div>
|
||||
@@ -1,3 +1,9 @@
|
||||
---
|
||||
search:
|
||||
exclude: true
|
||||
---
|
||||
|
||||
|
||||
??? note "How to set up Fahrenheit on the OLED"
|
||||
|
||||
Create a directory for a configuration file:
|
||||
|
||||
+2
-12
@@ -7,21 +7,11 @@ description: "Getting started with PiKVM"
|
||||
|
||||
Here are **first steps guides** for each PiKVM device:
|
||||
|
||||
<div class="grid" markdown>
|
||||
|
||||
[PiKVM V4 Mini & Plus](v4.md){ .md-button .md-button--stretch }
|
||||
|
||||
[PiKVM V3](v3.md){ .md-button .md-button--stretch }
|
||||
|
||||
[DIY PiKVM V2](v2.md){ .md-button .md-button--stretch }
|
||||
|
||||
[DIY PiKVM V1](v1.md){ .md-button .md-button--stretch }
|
||||
|
||||
</div>
|
||||
{!_device_guides.md!}
|
||||
|
||||
|
||||
-----
|
||||
## Quick Tips
|
||||
## Basics
|
||||
|
||||
{!_passwd.md!}
|
||||
|
||||
|
||||
+4
-4
@@ -39,7 +39,7 @@ As a first step, we recommend carefully reading our documentation on [GitHub](ht
|
||||
DNS=192.168.x.x
|
||||
```
|
||||
|
||||
??? warning "Don't forget the `/24` suffix (CIDR), otherwise it will not work and your PiKVM will become unreachable"
|
||||
Don't forget the `/24` suffix (CIDR), otherwise it will not work and your PiKVM will become unreachable.
|
||||
|
||||
|
||||
??? question "How can I disable IPv6 on PiKVM?"
|
||||
@@ -135,8 +135,7 @@ As a first step, we recommend carefully reading our documentation on [GitHub](ht
|
||||
|
||||
|
||||
??? question "How do I emulate various USB devices on the target machine?"
|
||||
Please review [First Steps](first_steps.md) before continuing
|
||||
|
||||
|
||||
By default this is what is set:
|
||||
|
||||
```yaml
|
||||
@@ -242,7 +241,8 @@ As a first step, we recommend carefully reading our documentation on [GitHub](ht
|
||||
## First steps
|
||||
|
||||
??? question "I can't find the PiKVM IP address in my network"
|
||||
Follow [this guide](first_steps.md#getting-access-to-pikvm).
|
||||
|
||||
Follow the device guide of your PiKVM [here](cheatsheet.md).
|
||||
|
||||
|
||||
??? question "What is the default password? How do I change it?"
|
||||
|
||||
@@ -22,7 +22,7 @@ This operation can be done using your RPi (except Pi Zero W). Here the common st
|
||||
|
||||
2. Connect the Arduino and RPi with a suitable USB cable.
|
||||
|
||||
3. [Log in to the Raspberry Pi using SSH](https://docs.pikvm.org/first_steps/#getting-access-to-pikvm).
|
||||
3. Log in to the Raspberry Pi console using SSH or Web Terminal.
|
||||
|
||||
4. Upload the firmware (USB keyboard & mouse is used by default, on this step [you can choose PS/2 keyboard](arduino_hid.md#ps2-keyboard)):
|
||||
|
||||
@@ -47,7 +47,7 @@ This operation can be done using your Raspberry Pi without disconnecting any wir
|
||||
|
||||
1. Connect the Arduino and RPi with a suitable USB cable.
|
||||
|
||||
2. [Log in to the Raspberry Pi using SSH](https://docs.pikvm.org/first_steps/#getting-access-to-pikvm).
|
||||
2. Log in to the Raspberry Pi console using SSH or Web Terminal.
|
||||
|
||||
3. Execute `rw`, add line `dtoverlay=spi0-1cs` to `/boot/config.txt` and perform `reboot`.
|
||||
|
||||
|
||||
+7
-8
@@ -1,24 +1,23 @@
|
||||
# PiKVM Handbook
|
||||
|
||||
**Welcome to the [PiKVM](https://pikvm.org) Handbook** - a complete documentation of Open and cheap DIY IP-KVM based on Raspberry Pi.
|
||||
**Welcome to the [PiKVM](https://pikvm.org) Handbook** - a complete documentation of the Open Source KVM over IP on Raspberry Pi!
|
||||
|
||||
Here you will find comprehensive information about all aspects of the operation of PiKVM, get answers to your most difficult questions
|
||||
and be able to solve the problems that have arisen.
|
||||
|
||||
|
||||
## Where to start?
|
||||
|
||||
* **Check out the device instructions:**
|
||||
* [PiKVM V4 Mini & Plus](v4.md)
|
||||
* [PiKVM V3 HAT / Pre-Assembled](v3.md)
|
||||
* [DIY PiKVM V2 build](v2.md)
|
||||
* [DIY PiKVM V1 build](v1.md)
|
||||
* Check out the **device instructions**:
|
||||
|
||||
* **Learn about the [basics of working with PiKVM](first_steps.md).**
|
||||
{!_device_guides.md!}
|
||||
|
||||
* Learn about the **[basics of working with PiKVM](cheatsheet.md)**.
|
||||
|
||||
* **Explore the features of PiKVM** using the site's table of contents.
|
||||
|
||||
* **If you encounter a problem**, take a look at the **[FAQ](faq.md)**, but if nothing helped,
|
||||
please contact our **[Discord chat](https://discord.gg/bpmXfz5)** - experienced users and the PiKVM team will definitely help you.
|
||||
feel free to contact us in **[Discord Chat](https://discord.gg/bpmXfz5)** - many of experienced users and the PiKVM team will definitely help you.
|
||||
|
||||
|
||||
## Links
|
||||
|
||||
+2
-1
@@ -170,7 +170,8 @@ You will see the initial dashboard screen of the PiKVM where you can access the
|
||||
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time.
|
||||
|
||||
!!! danger "Please ensure that you change both passwords: for web UI access and for the Linux superuser (root)"
|
||||
!!! danger "Passwords are important!"
|
||||
Please ensure that you change **both** passwords: for Web UI access and for the Linux superuser (root).
|
||||
|
||||
To do that:
|
||||
|
||||
|
||||
+11
-1
@@ -15,6 +15,8 @@ You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mou
|
||||
|
||||
[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
|
||||
@@ -27,6 +29,8 @@ You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mou
|
||||
- 1 x USB C to USB A cable
|
||||
- 12V 2A Power Supply (international adapters)
|
||||
|
||||
|
||||
-----
|
||||
## Interface
|
||||
|
||||
=== "Front view"
|
||||
@@ -74,6 +78,7 @@ You can use your remote keyboard and mouse or PiKVM can simulate a keyboard, mou
|
||||
|
||||
1. Display
|
||||
|
||||
-----
|
||||
## Wiring
|
||||
|
||||
Let's connect all the wires before you power up the device.
|
||||
@@ -92,6 +97,8 @@ Connect **Ethernet** (**bottom right** on the **front** side) to the network usi
|
||||
|
||||
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
|
||||
|
||||
|
||||
@@ -107,6 +114,8 @@ Attach the appropriate connector on the **front** side. Do **not** block the ven
|
||||
|
||||
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
|
||||
@@ -145,7 +154,8 @@ You will see the initial dashboard screen of the PiKVM where you can access the
|
||||
|
||||
For security's sake, it's best to change the default passwords immediately after running PiKVM for the first time.
|
||||
|
||||
!!! danger "Please ensure that you change both passwords: for web UI access and for the superuser (root)"
|
||||
!!! danger "Passwords are important!"
|
||||
Please ensure that you change **both** passwords: for Web UI access and for the Linux superuser (root).
|
||||
|
||||
To do that:
|
||||
|
||||
|
||||
Reference in New Issue
Block a user