Miroirs/rkvm
1
0
Fork 0
mirror of https://github.com/htrefil/rkvm.git synced 2025-02-07 20:45:52 +01:00
Code Issues Projects Releases Packages Wiki Activity

Update README

Browse source
This commit is contained in:
htrefil 2020-11-14 13:23:37 +01:00
parent 357f85512a
commit e4c09a9abf
1 changed files with 7 additions and 5 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

12
README.md
View file

@ -1,5 +1,5 @@
# rkvm # rkvm
rkvm is a tool for sharing keyboard and mouse across multiple Linux computers. rkvm is a tool for sharing keyboard and mouse across multiple Linux and Windows machines.
It is based on a client/server architecture, where server is the machine controlling mouse and keyboard and relays events (mouse move, key presses, ...) to clients. It is based on a client/server architecture, where server is the machine controlling mouse and keyboard and relays events (mouse move, key presses, ...) to clients.
Switching between different clients is done by a configurable keyboard shortcut. Switching between different clients is done by a configurable keyboard shortcut.
@ -10,9 +10,11 @@ Switching between different clients is done by a configurable keyboard shortcut.
- Low overhead - Low overhead
## Requirements ## Requirements
- Rust 1.48 and higher
## Linux requirements
- The uinput Linux kernel module, enabled by default in most distros - The uinput Linux kernel module, enabled by default in most distros
- libevdev - libevdev
- Rust 1.48 and higher
## Building ## Building
Run `cargo build --release`. Run `cargo build --release`.
@ -24,9 +26,9 @@ Run `cargo run certificate-gen -- --help` to see and usage.
## Setting up ## Setting up
First, build the project and generate certificates. Client accepts certificates both in PEM and DER formats. First, build the project and generate certificates. Client accepts certificates both in PEM and DER formats.
You either need to run either of the programs as root or make `/dev/uinput` accessible by the user it runs as. On Linux, you either need to run either of the programs as root or make `/dev/uinput` accessible by the user it runs as.
By default, the programs reads their config files from /etc/rkvm/{server,client}.toml, this can be changed by passing the path as the first command line parameter. By default, the programs reads their config files from /etc/rkvm/{server,client}.toml on Linux and C:/rkvm/{server,client}.toml on Windows, this can be changed by passing the path as the first command line parameter.
The [example](example) directory contains example configurations and systemd service files. The [example](example) directory contains example configurations and systemd service files.
@ -39,7 +41,7 @@ Regardless, if you want a working and stable solution for crossplatform keyboard
## Limitations ## Limitations
- Only keyboard and relative mouse events work (that is, can be forwarded to clients) - Only keyboard and relative mouse events work (that is, can be forwarded to clients)
- No Windows or macOS support - Clients only are supported on Windows, however, server support will be added in the future
## Project structure ## Project structure
- `server` - server application code - `server` - server application code