Installation

Install Docker Engine for Linux Installation Reference

Verify Docker is installed correctly

docker run hello-world

Install the Edge

source <(curl -sS https://raw.githubusercontent.com/xyte-io/edge/refs/heads/main/edge_runner_script.sh)

Common errors

Error: telnet is not installed. Please install it and try again.

# Install telnet
sudo apt install telnet

docker: permission denied while trying to connect to the Docker daemon

The current user doesn't have permission to run docker containers, either run the script as sudo (not recommended) or allow user to run docker containers:

# Allow current user to run Docker without sudo
sudo usermod -aG docker $USER
newgrp docker

Ubuntu/Debian Installation Guide

1. Install Telnet

sudo apt install telnet

2. Install Docker Engine

Setup the Docker APT Repository

# Add Docker's official GPG key:
sudo apt-get update
sudo apt-get install ca-certificates curl
sudo install -m 0755 -d /etc/apt/keyrings
sudo curl -fsSL https://download.docker.com/linux/ubuntu/gpg -o /etc/apt/keyrings/docker.asc
sudo chmod a+r /etc/apt/keyrings/docker.asc

# Add the repository to Apt sources:
echo \
  "deb [arch=$(dpkg --print-architecture) signed-by=/etc/apt/keyrings/docker.asc] https://download.docker.com/linux/ubuntu \
  $(. /etc/os-release && echo "${UBUNTU_CODENAME:-$VERSION_CODENAME}") stable" | \
  sudo tee /etc/apt/sources.list.d/docker.list > /dev/null
sudo apt-get update

Install the Docker Packages

sudo apt-get install docker-ce docker-ce-cli containerd.io docker-buildx-plugin docker-compose-plugin

Verify the installation was successful by running the 'hello-world' image

		sudo docker run hello-world

3. Docker Post-Installation Steps

Create the Docker Group

sudo groupadd docker

Add your user to the docker group

sudo usermod -aG docker $USER

Activate changes to the group

newgrp docker

Verify you can run the docker commands without Sudo

docker run hello-world

4. Install the Connect+ Edge Container

source <(curl -sS https://raw.githubusercontent.com/xyte-io/edge/refs/heads/main/edge_runner_script.sh)

Response return should appear as

Edge Id: xxxxxxxx-xxxx-xxxx-xxxx-xxxxxxxxxxxx

If the script does not return an ID, the relevant ID is stored in a text file and may be retrieved with the following command:

docker exec -it xyte_edge /bin/bash -c "cat edge_data/proxy_name.txt && echo"