Skip to content

Installing on host

Tip

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

Linux

Note

This guide assumes you have a Linux distribution with systemd running. This reflects the majority of all actual distributions, such as Ubuntu, Debian, Fedora, ...

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

    Syntax

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

    Matrix

    Cells express support in format of <generic>/<extended>. See our documentation of distributions of Bifröst to learn more.

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

    Example - Linux AMD64

    1
    curl -sSLf https://github.com/engity-com/bifroest/releases/download/v0.4.0/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.4.0/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. Download our example service configuration: 

    1
    sudo curl -sSLf https://raw.githubusercontent.com/engity-com/bifroest/v0.4.0/contrib/systemd/bifroest.service -o /etc/systemd/system/bifroest.service

  4. Reload the systemd daemon: 

    1
    sudo systemctl daemon-reload

  5. Enable and start Bifröst: 

    1
2
    sudo systemctl enable bifroest.service
sudo systemctl start bifroest.service

  6. Now you can log in to Bifröst the first time: 

    1
    ssh demo@localhost

Windows

  1. Open a Powershell Terminal with Administrator privileges.

  2. Download and extract Bifröst (see release page):

    Syntax

    1
2
3
    curl -sSLf https://github.com/engity-com/bifroest/releases/download/v0.4.0/bifroest-windows-<arch>-<edition>.zip -o "${Env:Temp}\bifroest.zip"
mkdir -Force 'C:\Program Files\Engity\Bifroest'
Expand-Archive "${Env:Temp}\bifroest.zip" -DestinationPath 'C:\Program Files\Engity\Bifroest'

    Matrix

    Cells express support in format of <generic>/<extended>. See our documentation of distributions of Bifröst to learn more.

    Architecturewindows
    amd64/
    arm64/

    Example - Windows AMD64

    1
2
3
    curl -sSLf https://github.com/engity-com/bifroest/releases/download/v0.4.0/bifroest-windows-amd64-generic.zip -o "${Env:Temp}\bifroest.zip"
mkdir -Force 'C:\Program Files\Engity\Bifroest'
Expand-Archive "${Env:Temp}\bifroest.zip" -DestinationPath 'C:\Program Files\Engity\Bifroest'

  3. 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
    mkdir -Force 'C:\ProgramData\Engity\Bifroest'
curl -sSLf https://raw.githubusercontent.com/engity-com/bifroest/v0.4.0/contrib/configurations/dummy-windows.yaml -o 'C:\ProgramData\Engity\Bifroest\configuration.yaml'
# Adjust it to your needs
notepad 'C:\ProgramData\Engity\Bifroest\configuration.yaml'

  4. Enable and start Bifröst: 

    1
    'C:\Program Files\Engity\Bifroest\bifroest.exe' service install

  5. Now you can log in to Bifröst the first time: 

    1
    ssh demo@localhost

What's next?