Skip to content

Commit

Permalink
update connection instructions
Browse files Browse the repository at this point in the history
  • Loading branch information
feschber committed Nov 9, 2024
1 parent 3913fa8 commit 8b0a797
Show file tree
Hide file tree
Showing 2 changed files with 21 additions and 5 deletions.
19 changes: 15 additions & 4 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -247,11 +247,17 @@ the gtk frontend (see conditional compilation).

By default the gtk frontend will open when running `lan-mouse`.

To add a new connection, simply click the `Add` button on *both* devices,
enter the corresponding hostname and activate it.
To connect a device you want to control, simply click the `Add` button and enter the hostname
of the device.

If the mouse can not be moved onto a device, make sure you have port `4242` (or the one selected)
opened up in your firewall.
On the *remote* device, authorize your *local* device for incoming traffic using the `Authorize` button
under the "Incoming Connections" section.
The fingerprint for authorization can be found under the general section of your *local* device.
It is of the form "aa:bb:cc:..."

Authorized devices can be persisted using the configuration file (see [Configuration](#configuration)).

If the device still can not be entered, make sure you have UDP port `4242` (or the one selected) opened up in your firewall.
</details>

<details>
Expand Down Expand Up @@ -319,6 +325,11 @@ port = 4242
# # possible values are "cli" and "gtk"
# frontend = "gtk"

# list of authorized tls certificate fingerprints that
# are accepted for incoming traffic
[authorized_fingerprints]
"bc:05:ab:7a:a4:de:88:8c:2f:92:ac:bc:b8:49:b8:24:0d:44:b3:e6:a4:ef:d7:0b:6c:69:6d:77:53:0b:14:80" = "iridium"

# define a client on the right side with host name "iridium"
[right]
# hostname
Expand Down
7 changes: 6 additions & 1 deletion config.toml
Original file line number Diff line number Diff line change
Expand Up @@ -3,13 +3,18 @@
# capture_backend = "LayerShell"

# release bind
release_bind = [ "KeyA", "KeyS", "KeyD", "KeyF" ]
release_bind = ["KeyA", "KeyS", "KeyD", "KeyF"]

# optional port (defaults to 4242)
port = 4242
# optional frontend -> defaults to gtk if available
# frontend = "gtk"

# list of authorized tls certificate fingerprints that
# are accepted for incoming traffic
[authorized_fingerprints]
"bc:05:ab:7a:a4:de:88:8c:2f:92:ac:bc:b8:49:b8:24:0d:44:b3:e6:a4:ef:d7:0b:6c:69:6d:77:53:0b:14:80" = "iridium"

# define a client on the right side with host name "iridium"
[right]
# hostname
Expand Down

0 comments on commit 8b0a797

Please sign in to comment.