HonkIP Connect 1.4.10 — installation

Full instructions and downloads: https://honkip.com/connect/install
Manage your services: https://honkip.com/connect

NEW TO CONNECT?
Connect lets you reach a chosen app at home while you are away: a web
dashboard, file manager, Remote Desktop, SSH or a supported game. It is
available on plans that include Connect; check Plans on the website. Verify your email before setup. Keep Connect, this PC and the home app
running and awake. No router ports need opening. The included IP updater
works on its own; it keeps a home name pointed at your internet
address but does not make your apps reachable by itself.

YOUR FIRST WEB APP
1. Sign in and approve this app in your browser. The app returns to Your services.
2. In Sign in & setup, choose a name and paste the web address that already
   works at home. Use Test local app, then Save & connect on this PC.
3. Leave access Private. Choose Open in Connect portal, sign in with the same
   account and open the selected service. Change who can visit only when
   you are ready to share it.
No app ready yet? Use the temporary test steps near the end of this file.

Help & tips in the Windows app explains each choice, with setup suggestions.
For help, suggestions or the latest download:
https://honkip.com/connect/install#help
https://honkip.com/connect/install#update

WINDOWS
Download HonkIPConnect.exe from the installation page. Open Sign in & setup,
press Sign in and check the code prefilled in your browser matches the app,
then approve it. Copy code and Open sign-in page are available if needed.
After approval, the app opens Your services. Open Sign in & setup to add or
change a service, or IP updater to keep your home name current.
If you have no home name, choose Create a home name in the app, pick its name
and ending, and create it. Start the IP updater only when this PC is at home.
Names created here also appear on the website. Refresh account loads website
changes while keeping genuine unfinished edits; refresh the website after
changing something in the app. Select an
existing service hostname, or choose an available domain from your account
and enter a short app name such as files. Your active home names, verified domains and plan-eligible shared endings appear. Add and verify a missing domain on the website first.
Paste the local app's HTTP/HTTPS address, or enter its local IP, port and type.
If the app runs on this PC, choose Find running apps on this PC, select it,
then Use selected app. This fills in its address, port and a suggested type.
Check the type against the app's settings and use Test local app before saving.
New web apps start with HTTPS on port 443. Keep HTTPS if your device supports
it. Choose HTTP explicitly only when that is the address your app uses at home.
Use Test local app before Save & connect on this PC. For a service saved on the
website, use Refresh account, select it and Move / set up on this PC. This
replaces any previous connector for the service, with a confirmation.
For an existing saved connection, Start saved connection keeps its credential.
If that credential was replaced on another computer, select Move / replace
connection to issue a fresh one here. Confirming disconnects the other computer.
Changing device settings changes the action to Save & reconnect. Custom domains need
the DNS records displayed in the app. No configuration download is needed.
Python is included. Manual configuration import remains available.
Choose the service in Sign in & setup. Under Who can visit?,
choose Private (only your HonkIP account), Open (any visitor at its address),
or Password (visitors enter your separate shared password), then Save access.
New services start private. Existing service access is not changed by updating
the app. For Password, use 12–128 characters; leave the field blank only to
keep an existing password. It is sent securely and never saved by this app.
Open address opens the public/password address directly; Open in Connect portal
selects the private service in your portal. Your home app sees a connection
from this PC. Some apps trust home-network clients and skip their own login.
Keep web apps Private or Password-protected, and TCP/UDP services Private,
until you have checked their own sign-in from outside.
Pause service closes online visitor access. Enable service restores online
access, but this PC must also be connected. Start saved and Stop in Your services
only control this PC's connection. Pausing needs no new configuration file.
Usage & activity shows the account's combined upload/download usage against
its UTC calendar-month allowance, refreshing every minute while signed in.
Remaining allowance and the next reset time are shown; the reset is the first
of each month at 00:00 UTC, also displayed in your local time.
Account totals may update shortly after traffic. It also shows up to 200
connection and updater events from the current app session. These are held
in memory, cleared when the app closes, and contain no passwords, request
contents or browsing history. Open Connect portal for online management.
Open the IP updater tab, select your home name and press Start IP updater.
Use a PC that stays at home; stop the old updater for this name first.
IPv4 and IPv6 are checked every five minutes. Sign-in is valid for up to
30 days, bounded by the approving browser session. Revoke app access at
https://honkip.com/desktop/approve or sign out in the app. If access expires,
choose Sign in again, then set up the saved service again. Sign-in has a
countdown and Cancel sign-in. Refresh account keeps your unfinished edits.
Sign out removes account-managed credentials and stops the updater and those
connections on this PC, even offline. If online revocation cannot complete,
the app tells you to revoke the approved app on the website when online.
Minimize to stay connected; closing stops the connection. Start with Windows
is optional. The Windows download is unsigned and installs only for your user.

WINDOWS UPDATES AND REMOVAL
Open the latest HonkIPConnect.exe download and confirm Update and restart.
Confirm Stop and close in the running app if asked. The update preserves saved
settings and pauses connections briefly; it does not force-kill the app.
Opening the installed shortcut again brings its existing window forward.
To remove the installed app, use Windows Settings > Apps > Installed apps >
HonkIP Connect > Uninstall (Apps & features on Windows 10). This removes the
app, startup entry and saved settings on this PC. Backups and unrelated files
are kept. Revoke the approved app and pause or remove services on honkip.com
to revoke online access too. Uninstalling alone does not do that online action.

LINUX / MACOS / NAS WITH PYTHON 3.12+
Extract this package in a folder owned by your user. Download the service's
configuration into it as honkip-connect.json. Run from the extracted folder:

python3 -m venv .venv
.venv/bin/python -m pip install -r connect_service/requirements.txt
chmod 600 honkip-connect.json
.venv/bin/python -m connect_service.connector --config honkip-connect.json

Enable the service on the website. Keep this process running; Ctrl+C stops it.
Use a separate file and process for each additional service. The .venv folder
is private to this installation; do not change your device's system Python.

LINUX USER SERVICE (optional, after the manual connection works)
This example assumes the extracted folder is $HOME/HonkIPConnect and the
configuration is $HOME/HonkIPConnect/honkip-connect.json. Change both paths
if you installed elsewhere. Save the following as:
$HOME/.config/systemd/user/honkip-connect.service

[Unit]
Description=HonkIP Connect home app
After=network-online.target
[Service]
WorkingDirectory=%h/HonkIPConnect
ExecStart=%h/HonkIPConnect/.venv/bin/python -m connect_service.connector --config %h/HonkIPConnect/honkip-connect.json
Restart=on-failure
RestartSec=10
NoNewPrivileges=true
UMask=0077
[Install]
WantedBy=default.target

Then run:
systemctl --user daemon-reload
systemctl --user enable --now honkip-connect.service
systemctl --user status honkip-connect.service

This user service starts when you sign in. Continuing after sign-out requires
the device administrator to enable user lingering deliberately. Do not assume
it starts before login. NAS startup tools differ; use the same absolute Python
and configuration paths in the NAS's supported startup manager.

To stop and disable the Linux user service:
systemctl --user disable --now honkip-connect.service

Then remove its unit file and run systemctl --user daemon-reload. Delete your
connector folder only after confirming its path and that no service uses it.
Pause or remove the online service to revoke access too.

SECURITY AND TROUBLESHOOTING
Keep the configuration private. Downloading it again revokes the earlier
credential. The Windows app saves an encrypted copy for your Windows user;
the original downloaded JSON is still a credential-bearing file.
PC connected means the connection to HonkIP is up; it does not prove the home
app works. Use Test local app for a local HTTP response, then check the remote
address through the portal. A successful local test does not test every page.
An HTTPS device needs a valid certificate matching its configured name.
For a device that uses its own certificate, select Use this device’s certificate.
The app reads the public certificate from the local IP and port you entered.
Check its name, expiry date and fingerprint against your device's settings
before confirming. Connect saves the certificate for this service on this PC;
it does not add trust for other apps or change Windows certificate settings.
Certificate checks stay enabled. An expired or changed certificate needs your
attention; it is not silently accepted. Use Test local app, then save and
reconnect. This does not install HTTPS on a device that only supports HTTP.
For a certificate file provided by your device's administrator, use Show manual
certificate settings. Enter the Name on the certificate first if it differs
from the IP. Choose Import file, select the trusted PEM file, then review and
confirm it. Leave these blank for normal system trust and the device IP. Never use or share a private key file.
Step-by-step help: https://honkip.com/connect/install#certificates
For the command-line connector, add ca_file with an absolute PEM file path and,
if needed, server_name with the certificate DNS name in your private config.
The connection still targets the configured local IP. Local-device CA trust
does not replace the public relay's normal system trust.
No port forwarding is required. Connect handles HTTP/HTTPS web apps,
WebSockets and individual TCP/UDP services. Some games need multiple ports;
device discovery and every game or app are not guaranteed to work.

For web apps, HonkIP arranges HTTPS for the public address automatically.
That connection ends at HonkIP. The connection from HonkIP to this PC is
encrypted; the final connection to your home app uses the HTTP or HTTPS
setting you chose. Open TCP/UDP ports do not get automatic HTTPS or a
browser password page: the actual service must provide its own sign-in and
encryption. Signed-in visiting access uses an encrypted connection to HonkIP.

PORTS AND LOCAL ACCESS
Read the Ports & local access tab in the Windows app, or:
https://honkip.com/connect/install#ports

An IP identifies the device and a port identifies the app. For example,
http://192.168.1.50:8080 means HTTP, local IP 192.168.1.50, port 8080.
Use the port actually configured by your app; entering a number in HonkIP
does not make that port start listening. With no explicit port in a URL,
HTTP normally uses 80 and HTTPS uses 443.

First open the local address in a browser on the Connect computer. Use
127.0.0.1 only if the app runs on this same computer. A different device
needs its LAN IP, a running app accepting LAN connections and any needed
device-firewall allowance. Guest Wi-Fi isolation may prevent LAN access.

On a Windows device hosting the home app, allow that app through Windows
Security's firewall settings on your trusted Private network. If an explicit
rule is needed, use Advanced settings, Inbound Rules, New Rule, Custom.
Choose the app's program where possible, TCP or UDP to match the service,
its exact local port and a remote-address scope limited to the Connect PC's
local IP. Allow the
connection on Private only. An administrator must make this change; remove
the rule when it is no longer needed. Keep the firewall enabled.

Do not open inbound router ports or add DMZ/UPnP rules for Connect. Connect
itself needs outgoing HTTPS on TCP 443 and no inbound firewall allowance.
If outgoing access is restricted, ask the network administrator to allow it.
Remote web apps use HTTPS on 443. Public TCP/UDP uses the assigned internet port; signed-in visiting access uses a loopback port on the visiting PC.
After changing local settings in the Windows app, use Save & reconnect.
Normal reconnection uses Start saved connection. Manual clients need a freshly
downloaded configuration after device settings change.

Official Windows instructions:
https://support.microsoft.com/en-us/windows/security/firewall/risks-of-allowing-apps-through-windows-firewall
https://learn.microsoft.com/en-us/windows/security/operating-system-security/network-security/windows-firewall/configure#create-an-inbound-port-rule

PRESETS, ADAPTERS AND TEMPORARY TESTS
Find running apps on this PC shows apps already accepting connections here.
Choose one, then Use selected app to fill in the local settings. Common web
ports suggest HTTP or HTTPS; other entries suggest TCP or UDP. Check the type
against that app's settings. Use Test local app for a web app; check Remote
Desktop, SSH and games with their own client. Finding an app only reads this
PC's list: it does not scan other devices, change firewall rules or make the
app public. You can find apps before signing in; connecting them still needs
an account with Connect access. For an app on another device, enter its local
IP and port yourself.
Choose a preset or custom HTTP/HTTPS/TCP/UDP port. Find this PC’s adapters lists its active local addresses only; enter another device’s IP manually. Presets do not install or enable the actual service.
A new name directly under honkip.com uses a spare hostname slot on your plan.
Names under your existing home and verified domains remain available.

TRY A TEMPORARY TEST PAGE
1. In Sign in & setup, choose Add a new hostname. Keep real services separate.
2. Open Test & visit. Leave the type as http and the port as 8765 for a first
   web test, then choose Start test server. The local settings fill in for you.
3. Return to Sign in & setup. Enter a separate test name, then choose
   Save & connect on this PC. Leave access Private.
4. Choose Open in Connect portal, sign in with the same account and open the
   test service. For an independent outside check, turn Wi-Fi off on a phone,
   sign in at https://honkip.com/connect and choose Open service for the test.
   Compare the code with this PC, then confirm on the test page.
   If you deliberately chose Open or Password access, use Open address instead.
5. STOP TEST SERVER WHEN FINISHED. Pause or remove its service in the portal.

The test serves only a page/code on 127.0.0.1, never your files. It stops after
ten minutes, on sign-out and on exit. Test connections never auto-start, and
the test does not change firewall rules. A local check alone does not prove
outside access.

For a TCP/UDP test, select that type before starting. Use the public test
check for an Open service, or sign in on a second Windows PC and start
visiting access to the test service, then choose Check visiting test server.
Compare the code with the home PC. Use another internet connection for an
independent outside check.

PRIVATE TCP/UDP: sign in on the visiting PC, select the service in Test & visit and Start visiting access. Use 127.0.0.1 and the displayed local port in the service client. Stop visiting access when finished. It is not saved or started automatically.
PUBLIC TCP/UDP: explicitly save Open access, then use the assigned hostname:port directly. The public port can differ from the local port. Browser passwords do not protect raw ports; use the service’s own authentication and encryption. Only the home and signed-in visiting connections are always encrypted.
UDP supports datagrams up to 32768 bytes and expires idle peer sessions after 30 seconds. Direct public UDP responses are bounded to four times received data (with a 64-byte minimum) to limit reflection. This and carrying UDP over a reliable encrypted connection can affect game compatibility and latency. LAN broadcast/discovery does not cross the connection; some games need multiple ports.
