Skip to content

Getting started

Tip

This guide shows how to install Bifröst from downloadable archive. If you like to use Bifröst inside a container, see our documentation for OCI/Docker Images.

Installation

  1. Download Bifröst (see release page):

    Syntax

    1
    curl -sSLf https://github.com/engity-com/bifroest/releases/download/v0.3.1/bifroest-<os>-<arch>-<edition>.tgz | sudo tar -zxv -C /usr/bin bifroest

    Matrix

    Cells express support in format of <generic>/<extended>.

    Architecturelinuxwindows
    i386//
    amd64//
    armv6//
    armv7//
    arm64//
    mips64le//
    riscv64//

    Example

    1
    curl -sSLf https://github.com/engity-com/bifroest/releases/download/v0.3.1/bifroest-linux-amd64-extended.tgz | sudo tar -zxv -C /usr/bin bifroest

  2. Configure Bifröst. For example download the demo configuration and adjust it to your needs (see documentation of configuration for the documentation about it): 

    1
2
3
4
    sudo mkdir -p /etc/engity/bifroest/
sudo curl -sSLf https://raw.githubusercontent.com/engity-com/bifroest/v0.3.1/contrib/configurations/sshd-dropin-replacement.yaml -o /etc/engity/bifroest/configuration.yaml
# Adjust it to your needs
sudo vi /etc/engity/bifroest/configuration.yaml

  3. Run Bifröst: 

    1
    sudo bifroest run

Autostart

...when the system starts.

systemd

To enable Bifröst to run on every server, start where systemd is available, simply: 1. Download our example service configuration: 

1
sudo curl -sSLf https://raw.githubusercontent.com/engity-com/bifroest/v0.3.1/contrib/systemd/bifroest.service -o /etc/systemd/system/bifroest.service
2. Reload the systemd daemon: 
1
sudo systemctl daemon-reload
3. Enable and start Bifröst: 
1
2
sudo systemctl enable bifroest.service
sudo systemctl start bifroest.service

What's next?

Read Use-Cases and the configuration documentation to see what you can do more with Bifröst.