Skip to main content

FreeBSD

This guide provides instructions for building, installing, and configuring the ShellHub Agent on FreeBSD, allowing you to remotely manage your device through ShellHub.

Prerequisites​

  • FreeBSD System: A FreeBSD system with root access.
  • ShellHub Access: A valid tenant ID for your ShellHub Cloud or self-hosted instance.
  • Git Installed: Required to clone the FreeBSD Ports Collection repository.

Step 1: Cloning the FreeBSD Ports Collection​

Begin by cloning the ShellHub Agent port from the FreeBSD Ports Collection repository to your system:

git clone https://github.com/shellhub-io/ports.git

Once cloned, navigate to the directory containing the ShellHub Port:

cd ports

Step 2: Building and Installing ShellHub Agent​

To build and install the ShellHub Agent, run:

make install clean

This command compiles and installs the ShellHub Agent on your system.

Step 3: Configuring ShellHub Agent​

After installation, configure the ShellHub Agent by adding the necessary settings to /etc/rc.conf:

# Enable ShellHub Agent
shellhub_enable="YES"

# Set the ShellHub Server Address
shellhub_server_address="https://cloud.shellhub.io"

# Set the Tenant ID
shellhub_tenant_id="00000000-0000-0000-0000-000000000000"
note

If you don't know how to get your Tenant ID, see Retrieving Your Tenant ID

Step 4: Starting the ShellHub Agent​

To start the ShellHub Agent, use:

service shellhub start

The ShellHub Agent will now connect in the background using the specified server address and tenant ID.

Conclusion​

With ShellHub Agent installed on FreeBSD, your device is now set up for remote management. For more information on FreeBSD Ports, see the FreeBSD Handbook on Ports and Packages.