Skip to content

Gateway Tunnelling Development Setup Improvements #110

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

Open
wants to merge 3 commits into
base: main
Choose a base branch
from
Open

Gateway Tunnelling Development Setup Improvements #110

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
b63447f
Update documentation to include changes needed to locally run the cen…
pankalog Oct 18, 2025
97c6b0e
Update documentation to include changes needed to locally run the cen…
pankalog Oct 28, 2025
dddbdc6
Merge branch 'main' into feature/gateway-tunneling-local-dev-setup
pankalog Oct 28, 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
29 changes: 29 additions & 0 deletions docs/developer-guide/gateway-tunnelling-setup.md
View file
Open in desktop
Copy link
Member

@richturner richturner Oct 29, 2025

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

What about the wildcard DNS resolution and the need to put entries in the /etc/hosts

Original file line number Diff line number Diff line change
Expand Up @@ -39,3 +39,32 @@ This guide describes the steps necessary to setup the gateway tunnelling functio
* Set TCP port range in sish service (to allow raw TCP tunnelling)
* Allow inbound access to port `2222` and to the TCP port range exposed on the instance
* Generate or select existing SSH private key and add this to the deployment image and set SISH variable: `--private-keys-directory`

# Gateway Tunnelling Development Setup

To run the manager locally as an edge gateway, to test the gateway tunnelling functionality, two different docker compose profiles need to be running:
* The central instance profile (e.g. `docker-compose.central.yml`) needs to be running to provide the sish server functionality, with the correctly configured environment variables
* The testing (unproxied) development profile needs to be running to allow the manager to run properly in the IDE.

You need to setup the SSH keys as described in the "Edge Instance Setup" section above.

For the **central instance** profile:

Run the main `docker-compose.yml` file with `OR_HOSTNAME=localhost`, and add the following:
* In the proxy service:
* SISH_PORT: 8090
* SISH_HOST: sish
* In the manager service:
* Add ``8008:8008`` to allow attaching the debugger from the IDE
* Optionally, set the manager to be built from context ``./manager/build/install/manager``, so that code changes are reflected during Docker image rebuild (after running `./gradlew clean installDist`)
* Add `OR_JAVA_OPTS: "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=*:8008"` to allow remote debugging from the IDE
* `OR_METRICS_ENABLED: false`
* `OR_GATEWAY_TUNNEL_SSH_HOSTNAME: "localhost"`
* `OR_GATEWAY_TUNNEL_SSH_PORT: 2222`
* `OR_GATEWAY_TUNNEL_TCP_START: 9000`
* `OR_GATEWAY_TUNNEL_HOSTNAME: "localhost"`
* `OR_GATEWAY_TUNNEL_AUTO_CLOSE_MINUTES: 2`
* Add the ``sish`` service, as found in `deploy.yml`, and modify:
* Add volume ``./deployment:/deployment`` so that you can map the SSH keys that were generated above

The above setup should make the **`org.openremote.test.gateway.GatewayTest#Gateway Tunneling Edge Gateway Integration test`** pass when run from the IDE or via Gradle.