The Connector intends to be a flexible point of interconnection and management for your sockets. Through simple yaml definitions you will be able to automatically create and run multiple sockets of different types or configurations.

Assumptions

As a base for this guide we assume you have basic knowledge of Linux command line, openssh and yaml.

Requirements

Linux based system with internet connectivity accessible via SSH(root access/sudo). This can be a container, VM or physical box. We will use Ubuntu VM for the purpose of this doc

Installation

For the basic Installation procedure we will need:

• Connector code, config and requirements files
• Border0 account credentials
• Border0 connector binary from https://download.border0.com

Install required Software

wget https://download.border0.com/linux_amd64/border0
sudo mv border0 /usr/local/bin/
chmod +x /usr/local/bin/border0 

Prepare basic configuration via yaml file:

Using your favourite text editor, open border0.yaml file
Following is the minimal basic configuration for the connector to run:

[email protected]:~$ cat border0.yaml 
connector:
   name: "my-awesome-connector"

credentials:
   user: [email protected]
   password: AVeryLongAndSecurePassword
   # token: AVeryLongAndSecurePasswordThingyTokenLikeStuffGeneratedInThePortal

We can now test the config:

[email protected]:~$  border0 connector start
2022/08/03 17:51:29 starting the connector service

📘

Default config file

By default the connector module will look for border0.yaml file current path

Optionally you can specify the configuration file:
border0 connector start --config some_other_border0_connector_config.yaml

At this point we should have a working connector service.

🚧

All sockets require authentication by default

We believe in secure access; that's why an access policy protects all sockets. By default, your organization will have a default organization-wide policy that will apply to all your services (sockets) in your organization. By default, it will only have the email address of the person that created the organization as an allowed email address.

To see what policy is applied to your service:
border0 socket -s <socket_id> policy ls

Also see:
border0 policy ls and border0 policy show -n <policy_name>

📘

More documentation about policies

Detail information about policies can be found in https://docs.border0.com/docs/policies

Plugins

The core functionality of the connector can be easily expanded with the use of plugins. Plugins can be enabled or disabled simply by adding or removing relevant YAML configuration sections.