CLI Based Local Installation

The connector program is bundled as part of the Border0 CLI (download here). The simplest way to install the connector on a machine is to download the CLI and run the command:

border0 connector install

This command will start the Border0 Connector and run it as service (on linux, this is a systemd service)

To check if the connector is installed and running use:

border0 connector status
The border0 service is currently running. (pid = 56992)

Uninstall

To undo the CLI based local installation, you may simply run

border0 connector uninstall

CLI Based Remote Installation (AWS)

If you'd like to install the Border0 connector into your AWS environment, then this is an easy way to get started.

border0 connector install --aws

Under the hood this command:

• Creates a new connector in your Border0 Organization
• Creates a new connector token for the new connector
• Creates a new AWS SSM parameter to store the new connector token
• Creates a new AWS CloudFormation stack including:
  • An IAM Role with all the necessary permissions to fetch the token from SSM and make use of all AWS-based connector plugins and be able to connect to any SSM targets and push SSH public keys to any EC2 Instance Connect targets
  • An EC2 AutoScaling Group with a Min/Max of 1
  • An EC2 Launch Configuration with user data to start the connector

Uninstall

To undo the cloud installation, you may navigate to the CloudFormation service page on the AWS Console, and delete the CloudFormation stack associated with your deployment.

To wipe all resources you will also need to identity the SSM parameter storing the token and delete it.

Finally, you may also want to delete the connector token and the connector itself from the Border0 Admin Portal.

Running the connector in Docker

You can use the Border0 provided docker image to run the connector in Docker.
First, create a new connector and a token. Then start the container like below:

export BORDER0_TOKEN=eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJjb25uZWN0....

docker run -ti -e BORDER0_TOKEN=$BORDER0_TOKEN ghcr.io/borderzero/border0 connector start

Restarting the connector

restarting the connector process differs per OS and systems manager.

Apple MacOS

sudo launchctl unload /Library/LaunchDaemons/border0.plist 
sudo launchctl load /Library/LaunchDaemons/border0.plist

Linux systemd

sudo systemctl restart border0

Upgrading the connector

You can check if there's a new version of the Border0 connector like this border0 version check

ubuntu@border0-example-connector:~$ border0 version check
You're running version v1.1-551-g33012d3

There is a newer version available (v1.1-573-gbab6239)!
Please upgrade:
border0 version upgrade

Then download and upgrade your current version with sudo border0 version upgrade

ubuntu@border0-example-connector:~$ sudo border0 version upgrade
Upgrading /usr/bin/border0 to version v1.1-573-gbab6239
Upgrade completed

Don't forget the restart the connector process as documented above.