Skip to content

Latest commit

 

History

History
94 lines (74 loc) · 3.93 KB

installation.md

File metadata and controls

94 lines (74 loc) · 3.93 KB
Raw

Installation

Introduction

If you've ever used Docker before, running Arken is as simple as pulling and configuring a new docker container. If you haven't used docker before, no worries, we'll walk you through it!

First you'll need an old computer or home server that's got at least 5 Gigabytes of space free and can run Linux. (Although Linux is not required to run Arken, it's what we're going to be covering in this article. For more information on running Docker containers on Windows check out the link here.

(Option 1) Installing with Docker

Step 1: Installing Docker on Your Machine

Once you've got your machine up and running, we'll need to install docker to deploy & manage the Arken container. Depending on the distribution of Linux your running on your local machine the instructions for installing docker might vary slightly. In this article we're going to focus on installing Docker on a machine running Debian. So if you're running a different form of Linux we recommend you look at the specific instructions for your distribution here.

Step 2: Configuring the Docker Repo

$ sudo apt-get update

$ sudo apt-get install \
    apt-transport-https \
    ca-certificates \
    curl \
    gnupg-agent \
    software-properties-common

$ curl -fsSL https://download.docker.com/linux/debian/gpg | sudo apt-key add -

$ sudo add-apt-repository \
    "deb [arch=amd64] https://download.docker.com/linux/debian \
    $(lsb_release -cs) \
    stable"

Step 3: Install the Docker Container Engine

$ sudo apt-get update
$ sudo apt-get install docker-ce docker-ce-cli containerd.io

Step 4: Enable Docker to Start When the Computer Does

$ sudo systemctl enable --now docker

Step 5: Installing Docker-Compose

Docker-Compose is a tool in the family of docker applications that allows us to easily define a group of docker containers and how we want to configure them. You can learn more about docker-compose here.

$ sudo curl -L "https://github.com/docker/compose/releases/download/1.29.2/docker-compose-$(uname -s)-$(uname -m)"\-o /usr/local/bin/docker-compose

$ sudo chmod +x /usr/local/bin/docker-compose

$ sudo ln -s /usr/local/bin/docker-compose /usr/bin/docker-compose

Step 6: Installing Arken as a Container

Now that you've got Docker and Docker-Compose up and running on your computer it's time for the fun part. Let's first define our docker-compose configuration file. Put this file anywhere you want and have easy access to.

Run the following to download a template Arken Config File,

wget https://raw.githubusercontent.com/arken/arken/main/docs/examples/docker-compose.yml

Now you can open that file by typing,

nano docker-compose.yml

Read through this file and change all of the fields with the < and > markers.

Once you are finished updating the file you can save your changes by pressing CTRL + X. Now we can launch the docker containers by running,

sudo docker-compose up -d

And that's it! Arken is now running on your local machine! If you'd like to see the status of the application you can type,

sudo docker-compose logs -f arken

(Option 2) Download Binary from GitHub

  1. Head over to the Arken GitHub repository releases.
  2. Copy the link to your corresponding OS and Architecture.
  3. Run sudo curl -L "PATH-TO-RELEASE" -o /usr/local/bin/arken
  4. Run sudo chmod a+x /usr/local/bin/arken
  5. (Optional) Run sudo ln -s /usr/local/bin/arken /usr/bin/arken

(Option 3) Build from Source

  1. Download the Ark source code git repository by running. git clone https://github.com/arken/arken.git
  2. Enter the repository folder by typing cd arken
  3. Build the application by running go build .
  4. Install the application by moving it to your bin by running, cp ark /usr/bin/arken