Skip to content

Added how to connect in a reverse way and/or via a repeater #274

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
bk138 merged 3 commits into from
Mar 12, 2025
Merged

Added how to connect in a reverse way and/or via a repeater #274

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
49ca5de
Added how to connect in a reverse way and/or via a repeater
lwcorp Mar 11, 2025
47a21ca
Rephrased about UPnP
lwcorp Mar 11, 2025
3c32f5a
Rephrased Reverse VNC without a screenshot
lwcorp Mar 12, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
18 changes: 13 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,8 +31,8 @@ If you have a general question, it's best to [ask in the community chat](https:/
in case you want to access the server using MacOS's built-in Screen Sharing app.
* Ability to specify the port used.
* Start of background service on device boot.
* Reverse VNC.
* Ability to connect to a UltraVNC-style Mode-2 repeater.
* [Reverse VNC](#reverse-vnc).
* Ability to [connect to a UltraVNC-style Mode-2 repeater](#reverse-vnc).
* Functionality to provide default configuration via a JSON file.
* Zeroconf/Bonjour publishing for VNC server auto-discovery.
* Per-client mouse pointers on the controlled device.
Expand All @@ -55,9 +55,17 @@ If you have a general question, it's best to [ask in the community chat](https:/
* **End** acts as Power button
* **Escape** acts as Back button

### For accepting connections from outside

1. You should allow [Port Forwarding](https://en.wikipedia.org/wiki/Port_forwarding) in your router's Firewall settings. Login to your router's settings (usually open 192.168.1.1 in your browser, some routers have password written on them).
### How to connect?
### Disclaimer
Leaving ports always open is considered risky, and either way most users don't even know how to open them in their routers in the first place.
#### Reverse VNC
Here's how to avoid the [risk of open ports](#disclaimer):
1. Leave the VNC port **blank**, which will get the app to state the server **isn't** listening for incoming connections.
1. Make outbound connections by choosing either "Connect to a **listening viewer**" or "Connect to a **repeater**".

#### Direct VNC
If you prefer automatically accepting connections from outside (which [exposes your open ports](#disclaimer)):
1. You should allow [Port Forwarding](https://en.wikipedia.org/wiki/Port_forwarding) in your router's Firewall settings. Either find a [UPnP](https://en.wikipedia.org/wiki/Universal_Plug_and_Play) supported app to open ports dynamically or log in to your router's settings (usually open 192.168.1.1 in your browser, some routers have password written on them).
2. Find Port Forwarding, usually it's somewhere in **Network - Firewall - Port Forwards**.
3. Create a new rule, this is an example from OpenWRT firmware.

Expand Down