Miroirs/rkvm
1
0
Fork 0
mirror of https://github.com/htrefil/rkvm.git synced 2025-01-18 10:26:12 +01:00
Code Issues Projects Releases Packages Wiki Activity

Add test instructions to README

Browse source
This commit is contained in:
Jan Trefil 2023-05-13 18:56:44 +02:00
parent 0da5dc759f
commit d93a19d668
1 changed files with 13 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

18
README.md
View file

@ -8,7 +8,7 @@ Switching between different clients is done by a configurable keyboard shortcut.
## Features ## Features
- TLS encrypted by default, backed by [rustls](https://github.com/rustls/rustls) - TLS encrypted by default, backed by [rustls](https://github.com/rustls/rustls)
- Display server agnostic - Display server agnostic (in fact, it doesn't require a display server at all)
- Low overhead - Low overhead
## Requirements ## Requirements
@ -33,8 +33,8 @@ $ sudo cp systemd/rkvm-server.service /usr/lib/systemd/system/
After installation: After installation:
- Generate a certificate and private key using the `rkvm-certificate-gen` tool or provide your own from other sources. - Generate a certificate and private key using the `rkvm-certificate-gen` tool or provide your own from other sources.
- For server, place both the certificate and private key in `/etc/rkvm/certificate.pem` and `/etc/rkvm/key.pem` respectively. - For server, place both the certificate and private key in `/etc/rkvm/certificate.pem` and `/etc/rkvm/key.pem` respectively.
- For client, place the certificate to `/etc/rkvm/certificate.pem` - For client, place the certificate to `/etc/rkvm/certificate.pem`.
- Create a config if you haven't done so already. - Create a config if you haven't done so already.
Server: Server:
``` ```
# cp /etc/rkvm/server.example.toml /etc/rkvm/server.toml # cp /etc/rkvm/server.example.toml /etc/rkvm/server.toml
@ -44,8 +44,16 @@ After installation:
# cp /etc/rkvm/client.example.toml /etc/rkvm/client.toml # cp /etc/rkvm/client.example.toml /etc/rkvm/client.toml
``` ```
Do not edit the example configs, they will be overwritten by your package manager. Do not edit the example configs, they will be overwritten by your package manager.
- **Change the password** and optionally reconfigure the network listen address and key bindings for switching clients - **Change the password** and optionally reconfigure the network listen address and key bindings for switching clients
- Enable and start the systemd service. - Since rkvm-server grabs all input, i's a good idea to do a test run first to make sure you won't end up
being unable to user your keyboard and/or mouse because your display server is not properly configured to receive input from rkvm.
Run the following command to start rkvm-server for 15 seconds to test that your keyboard, mouse, etc. works properly:
```
# rkvm-server /etc/rkvm/server.toml --shutdown-after 15
```
- Enable and start the systemd service.
Server: Server:
``` ```
# systemctl enable rkvm-server # systemctl enable rkvm-server