Archives/pikvm
2
0
Fork 0
mirror of https://github.com/pikvm/pikvm synced 2024-11-01 09:20:17 +00:00
Code Issues Projects Releases Wiki Activity

Merge pull request #135 from eshu0/master

Browse Source 
Updated documentation
This commit is contained in:
Maxim Devaev 2020-12-22 15:52:46 +03:00 committed by GitHub
commit 155c8b9c8c
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
3 changed files with 18 additions and 2 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

BIN
img/chrome.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 315 KiB

13
pages/building_os.md
View File

@ -1,7 +1,13 @@
# Building the OS
The Pi-KVM OS is based on Arch Linux ARM and contains all the required packages and configs for it to work. To build the OS you will need any Linux machine with a recent version of Docker (>= 1:19) with privileged mode enabled. (used for fdisk and some other commands, have a look through our Makefiles if you don't trust us :)). The build must be performed on the x86_64 host.
The Pi-KVM OS is based on Arch Linux ARM and contains all the required packages and configs for it to work.
0. When starting with a clean OS (like **Ubuntu 20.04**, please not that Ubuntu 18.04 does not working) you need to install and configure docker (after adding your user to the docker group you must log out and log back in), as well as git and make.
To build the OS you will need any Linux machine with a recent version of Docker (>= 1:19) with privileged mode enabled (used for fdisk and some other commands, have a look through our Makefiles if you don't trust us :)).
The build must be performed on the target x86_64 Linux image.
**Ubuntu 20.04** is recommended and has been tested. *please note that Ubuntu 18.04 does not work.*
0. When starting with a clean OS you need to install and configure docker (after adding your user to the docker group you must log out and log back in), as well as git and make.
```shell
[user@localhost ~]$ sudo apt-get install git make curl binutils -y
[user@localhost ~]$ curl -fsSL https://get.docker.com -o get-docker.sh
@ -89,6 +95,8 @@ The Pi-KVM OS is based on Arch Linux ARM and contains all the required packages
9. Congratulations! Your Pi-KVM will be available via SSH (`ssh root@<addr>` with password `root` by default) and HTTPS (try to open in a browser the URL `https://<addr>`, the login `admin` and password `admin` by default). For HTTPS a self-signed certificate is used by default.
*The latest versions of Chrome do not allow access to the page with a self signed certificate. You can proceed by typing ```thisisunsafe``` and Chrome will then load the page*
10. To change the root password use command `passwd` via SSH or webterm. To change Pi-KVM web password use `kvmd-htpasswd set admin`. As indicated on the login screen use `rw` to make the root filesystem writable, before issuing these commands. After making changes, make sure to run the command `ro`.
11. Important **note for HDMI-USB dongle** users only. Because of this, many 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:
@ -111,6 +119,7 @@ The Pi-KVM OS is based on Arch Linux ARM and contains all the required packages
12. **27.08.2020 note about systemd**: the latest version of Arch Linux has a slightly broken systemd. The problem is that SSH to the Pi-KVM host may not work the first time, but the second or third. The Pi-KVM build environment contains a workaround for this problem: in the file `/etc/pam.d/system-login` line `-session optional pam_systemd.so` is commented. This does not have any negative impact on the PI-KVM functionality, but if you want to, after fixing the systemd (in a couple of months with the next update), you can uncomment this line.
## Further Help
If you have any problems or questions, contact us using Discord: https://discord.gg/bpmXfz5
Subscribe to our Subreddit to follow news and releases: https://www.reddit.com/r/pikvm

7
pages/troubleshooting.md
View File

@ -57,3 +57,10 @@ Details [here](https://github.com/pikvm/pikvm/issues/6). The reason is that the
### I can't copy clipboard contents from the server (the machine controlled via Pi-KVM) to the client
- The clipboard only works from the client to the server not vice versa. There is currently no way to do it.
### Chrome Certificate Issue
- The latest versions of Chrome do not allow access to the page with a self signed certificat, so if you see the following screen when loading the pi-kvm website:
<img src="../img/chrome.png" alt="Chrome Blocking" width="400"/>
- You can proceed by typing ```thisisunsafe``` and Chrome will then load the page.