Installation (Linux)

xltrail offers a convenient command line interface (CLI) with two installation modes: online and offline. If your server can't access the internet, then you need to expand the Offline Installation sections below to follow the instructions. Note that offline mode is part of the Enterprise plan and only available upon request.

Before you start the installation, it is recommended to have a look at the Requirements.

1. xltrail CLI

As root, install the xltrail CLI (command line interface):

curl -sSL https://www.xltrail.com/cli -o /usr/local/bin/xltrail
chmod +x /usr/local/bin/xltrail

You can get an overview of the available commands by typing xltrail in your terminal.

Most commands require that you run them as root. If you add your user to the docker group, then you'll only need sudo for install and update. To add your user to the docker group, run sudo usermod -aG docker $USER once docker is installed on your system (see Dependencies below). The docker group grants privileges equivalent to the root user, see also the Docker documentation.

Offline Installation (click to expand) Nothing special to be done here, except transferring the file manually to the offline machine.

2. Config

As root, run the following command to create the config file and to add the settings required for the installation:

xltrail config

You will be prompted for your LICENSE_KEY, the DOCKER_REGISTRY_PASSWORD (both provided to you by email) and the HOSTNAME (e.g. IP address or something like xltrail.yourcompany.com).

For any advanced configuration, edit the file directly under /etc/xltrail/xltrail.conf. For example, if you are behind a proxy server, make sure to also set PROXY_ADDRESS (see also Configuration).

Offline Installation (click to expand) When running xltrail config, you can leave the DOCKER_REGISTRY_PASSWORD empty. Once the config file has been created, edit /etc/xltrail/xltrail.conf directly to add the following line: OFFLINE=1.

3. Dependencies

xltrail is a docker-compose application and thus requires both docker and docker-compose (for minimal and recommmended versions, see Requirements). The easiest way to get them installed is by making use of the xltrail CLI as root:

xltrail install-deps

On RHEL, if you get a Requires: container-selinux >= 2.9 error, run the following command before trying again:

yum install -y http://mirror.centos.org/centos/7/extras/x86_64/Packages/container-selinux-2.74-1.el7.noarch.rpm

If you are behind a proxy, you'll need to configure Docker according to the instructions proxy. Alternatively, you can use the offline installation.

If you prefer to install docker and docker-compose manually or in offline mode, you can find the instructions here (click to expand):

Manual docker installation

As root, install Docker (min. required version: 18.06):

  • Ubuntu
  • CentOS
  • Debian
  • Red Hat Enterprise Linux (RHEL) 7:

    Either use Docker EE or install Docker CE as follows:

    yum-config-manager --add-repo https://download.docker.com/linux/centos/docker-ce.repo
yum install -y yum-utils device-mapper-persistent-data lvm2
yum install -y http://mirror.centos.org/centos/7/extras/x86_64/Packages/container-selinux-2.74-1.el7.noarch.rpm
yum install -y docker-ce docker-ce-cli containerd.io
systemctl enable docker
systemctl start docker

Double check if the installation was successful by running docker ps as root.

Offline docker installation

Download Docker according to your platform, for example:

Once the correct package has been downloaded and transferred to the offline machine it needs to be installed by using one of the following commands:

CentOS/RHEL/Fedora:

rpm -ivh .rpm

Ubuntu/Debian:

dpkg --install .deb

Different versions of Docker require different dependencies that may have to be manually downloaded/transferred/installed to the offline machine. They have to be installed following the same procedure for each one of those dependencies.

For example, for RHEL, you'll most likely also need a more recent version of container-selinux.

Manual docker-compose installation

As root, install docker-compose:

curl -L https://github.com/docker/compose/releases/download/1.24.0/docker-compose-`uname -s`-`uname -m` -o /usr/local/bin/docker-compose
chmod +x /usr/local/bin/docker-compose
See also: https://github.com/docker/compose/releases
Offline docker-compose installation Nothing special to be done here, except transferring the file manually to the offline machine.

4. xltrail

To install xltrail, type the following command as root:

xltrail install

This will download the docker images and start the application.

Offline Installation (click to expand)

To install xltrail in offline mode, you need to download the application bundle like this, then transfer it over to the airgapped machine:

curl -L "https://xltrail-airgap-stable.s3.amazonaws.com/xltrail-latest.tar.gz" -o xltrail.tar.gz

Then, instead of xltrail install, run the installer as follows:

xltrail install -f ./xltrail.tar.gz

5. Login

When the installation is done, type your server's IP address or domain name into a web browser and login with both username and password admin.

  • Once you are logged in, you can add new projects and/or Git integrations, see here.
  • You can add users manually by going to the user icon on the top right, then Settings > Team. If you would rather want to connect xltrail with your LDAP/AD directory, have a look at the LDAP docs.

You have to change the admin password either in the app via the user icon on the top right, then Change Password or by running xltrail password from a terminal. You can do the latter anytime to reset the admin password.

results matching ""

    No results matching ""