Installing on FreeBSD

FreeBSD is supported, but not by the install script. If you run it there, the installer stops and points you here:

Automatic installation is not supported on FreeBSD. Please refer to the ShellHub port at https://github.com/shellhub-io/ports

The port

The port lives in github.com/shellhub-io/ports, not in the official FreeBSD ports tree. There is no binary package — you build from source.

$ git clone https://github.com/shellhub-io/ports.git /usr/local/shellhub-ports
$ cd /usr/local/shellhub-ports/shellhub
$ make install clean

The port pulls Go as a build dependency and installs the agent as an rc.d service.

Configuration

In /etc/rc.conf:

shellhub_enable="YES"
shellhub_server_address="https://cloud.shellhub.io"
shellhub_tenant_id="<your-tenant-id>"

Both the server address and the tenant ID are required — the rc.d script validates them at startup and exits with an error if either is missing.

The script names the namespace by its tenant ID and has no setting for a provisioning key, so a FreeBSD device always lands pending until somebody accepts it.

The agent generates a private key on first run and stores it at shellhub_private_key, which defaults to /usr/local/etc/shellhub.key. That key is the device’s identity: delete it and the device re-registers as a new one, so it belongs on persistent storage.

Managing the service

$ service shellhub start
$ service shellhub stop
$ service shellhub restart
$ service shellhub status

Updating

The port has no package manager behind it, so an update is a rebuild:

$ cd /usr/local/shellhub-ports && git pull
$ cd shellhub
$ make deinstall
$ make install clean
$ service shellhub restart

Where to go next

• Quickstart — Accepting it into a namespace.
• Agent Configuration — The variables behind the rc.conf names.