Hub Agent for Private Network Services

Connect a private network to Securicloud and expose selected services manually, without opening inbound router ports.

What is a Hub Agent?

Hub Agent is a small application that runs inside the network that contains the services you want to expose through Securicloud. It lets you publish selected services without granting access to the entire network.

Once the Hub Agent is registered to your account, you can add instances manually from the Securicloud Control Panel. Each new instance gets a Default access token that you can use to connect.

Home Assistant user? If you are using the Securicloud Agent add-on for Home Assistant, you usually do not need Hub Agent. The add-on handles the Home Assistant connection automatically.
When to use Hub Agent

Use Hub Agent when:

  • you are not using the Home Assistant add-on
  • you want to expose selected services manually
  • you want to connect another network to Securicloud
  • you want to expose services other than Home Assistant
How it works
  1. Download Hub Agent for the device or platform you want to use.
  2. Run Hub Agent inside the network that contains your services.
  3. Open the registration link printed by Hub Agent.
  4. Register the Hub Agent with your Securicloud account.
  5. Add an instance manually from the Securicloud Control Panel.
  6. Use the automatically created Default access token to connect.
Download Hub Agent

Hub Agent is currently provided as a standalone executable. Installers may be added later.

Linux x64 Linux ARM64 Windows x64
Run Hub Agent
Windows x64

Download the Windows x64 build and run: 

hub-agent-x64.exe
Linux x64

Download the Linux x64 build, make it executable, and run it: 

chmod +x hub-agent-x64
./hub-agent-x64
Linux ARM64

Download the Linux ARM64 build, make it executable, and run it: 

chmod +x hub-agent-arm64
./hub-agent-arm64
Register Hub Agent

When Hub Agent starts for the first time, it generates an agent token and prints a registration link in the console or log output.

Open that registration link in your browser and sign in to your Securicloud account. This adds the Hub Agent to your account. 

[AGENT] ----------------------- registration link -----------------------
[AGENT] https://securicloud.me/add-agent/generic/xgrlu82zc5aqfn0lmmftbe3ph
[AGENT] -----------------------------------------------------------------

Until the Hub Agent is registered, it may keep reconnecting and log messages such as awaiting registration. This is expected.

After Hub Agent is registered

Open the Securicloud Control Panel and add an instance for the service you want to expose.

  1. Choose the registered Hub Agent.
  2. Add an instance for the service you want to expose.
  3. Choose the protocol, host, and port of the local service.
  4. Use the automatically created Default access token to connect.
Example

If you have a web service running inside your network at: 

http://192.168.1.50:8080

You would:

  1. Run Hub Agent on a device in the same network.
  2. Open the registration link printed by Hub Agent.
  3. Register the Hub Agent to your Securicloud account.
  4. Add an HTTP instance in Securicloud.
  5. Set the target host to 192.168.1.50.
  6. Set the target port to 8080.
  7. Use the automatically created Default access token to open the generated access link.
Notes
  • Hub Agent uses an outbound connection to Securicloud.
  • You do not need to open inbound ports on your router.
  • The Hub Agent must be registered to your account before it can be used.
  • For regular use, run Hub Agent on a device that stays powered on and keep the Hub Agent process running.
  • Home Assistant users should usually use the Securicloud Agent add-on instead.