Installation

Prerequisites

1. Running Ubuntu
2. Have permission to clone the Heimdall repository

Install Docker

Set up Docker's apt repository.

1. 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: (1)
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 

1. I'm a code annotation! I can contain code, formatted text, images, ... basically anything that can be written in Markdown.

2. Install the Docker packages.

To install the latest version, run:

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

3. (Optional) Verify that the installation is successful:

sudo docker run hello-world

Connect device to tailnet

1. Install Tailscale

curl -fsSL https://tailscale.com/install.sh | sh

3. Sign out of any existing Tailscale sessions:

sudo tailscale logout

4. Authenticate your device with Tailscale:

sudo tailscale up

You will be prompted to authenticate your device with Tailscale. Follow the instructions in the terminal to complete the authentication process. Select the tailnet associated with [email protected].

5. Verify that your device is connected to Tailscale:

tailscale status

Set up directories for Heimdall to store videos

1. Create the data directory:

mkdir ~/data
sudo chown -R $USER:docker ~/data

Install Heimdall

Steps to install Heimdall

1. Clone the Heimdall repository:

cd ~
git clone [email protected]:Tylerjames1504/heimdall.git

2. Create the server/.env file:

cd ~/heimdall/server
cp .env.template .env