From d381f5f51db19d6599ac3bb44e2c77934ce897db Mon Sep 17 00:00:00 2001 From: Henrik Hautakoski Date: Tue, 20 Jun 2023 12:17:18 +0200 Subject: [PATCH] Adding docs/install/debian.md --- docs/install/debian.md | 69 ++++++++++++++++++++++++++++++++++++++++++ 1 file changed, 69 insertions(+) create mode 100644 docs/install/debian.md diff --git a/docs/install/debian.md b/docs/install/debian.md new file mode 100644 index 0000000..a962b2d --- /dev/null +++ b/docs/install/debian.md @@ -0,0 +1,69 @@ +# Installation - Debian + +The following documentation assumes that you have already set up a `redis` server, a `leap SHIP` node, and a running `leap API` node. + +## 1. Installing the package + +### Using Sw/edens apt repository + +First, obtain the key. + +```sh +sudo apt-get install software-properties-common +curl -sS https://apt.eossweden.org/key | gpg --dearmor | sudo tee /etc/apt/trusted.gpg.d/eossweden-2023.gpg > /dev/null +``` + +Next, install the package. + +#### For bash shell + +```sh +sudo apt-add-repository -y "deb [arch=amd64] https://apt.eossweden.org/main `lsb_release -cs` stable" +sudo apt-get install thalos +``` + +#### For fish shell + +```sh +sudo apt-add-repository -y "deb [arch=amd64] https://apt.eossweden.org/main "(lsb_release -cs)" stable" +sudo apt-get install thalos +``` + +### Manual installation + +Alternatively, you can manually install the package by downloading the .deb file from the [latest](https://github.com/eosswedenorg/thalos/releases/latest) release. + +```sh +curl https://github.com/eosswedenorg/thalos/releases/download//thalos__amd64.deb + +sudo apt-get install ./thalos__amd64.deb +``` + +## 2. Configuration + +The configuration file is located at `/etc/thalos/config.yml` and contains an example configuration with extensive documentation. Below are the essential fields that you need to modify. You can adjust the settings according to your preferences. + +```yml +name: MyShipReader +api: "http://api.example.com:8888" + +ship: + url: "ws://ship.example.com:8080" +``` + +## 3. Starting the Server via systemd + +```sh +sudo systemctl enable thalos-server +sudo systemctl start thalos-server +``` + +After executing these commands, the server should be up and running. You can check the logs at `/var/log/thalos.log` (unless specified otherwise in the configuration), or by running `sudo systemctl status thalos-server`. + +### Starting Manually + +If desired, Thalos can also be started manually for quick configuration testing or in cases where running systemd is not preferable: + +```sh +/usr/bin/thalos-server --config /etc/thalos/thalos.yml +```