kogutdocs

    Type to search page titles, headings and text.

    Installation

    Linux

    Install kogut on Linux and configure its systemd service.

    The install script downloads the static binary for x86_64 or aarch64, checks its SHA-256 checksum, and starts a systemd service when systemd is available.

    Install

    Run as root or with sudo. The script needs curl or wget. To read it first:

    curl -fsSL https://kogut.dev/install -o install.sh
less install.sh
sh install.sh

    Or run it directly:

    curl -fsSL https://kogut.dev/install | sh

    Open http://<server>:8484 and create your account with the setup token from the journal or /var/lib/kogut/setup-token (First run):

    journalctl -u kogut | grep setup_token

    Configure the service

    The installer writes /usr/local/bin/kogut and /etc/systemd/system/kogut.service. The service uses DynamicUser and keeps data in /var/lib/kogut, which systemd stores at /var/lib/private/kogut. Edit kogut.toml there as root.

    Put service settings in a drop-in, so reinstalling does not overwrite them:

    sudo systemctl edit kogut

    For HTTPS through Caddy on the same host, add:

    [Service]
Environment=KOGUT_URL=https://kogut.acme.com
Environment=KOGUT_LISTEN=127.0.0.1:8484

    Then restart the service:

    sudo systemctl restart kogut

    See Environment variables, and install-script options for a fixed version or a binary-only install.

    Read logs

    journalctl -u kogut -f

    For more detail, add Environment=RUST_LOG=debug to the drop-in and restart.

    Install without systemd

    Run the same installer, then start kogut serve under your supervisor, with KOGUT_DATA set to a persistent directory and KOGUT_LISTEN to the address (defaults). Have the supervisor restart kogut when it exits with an error; the database stays consistent.

    Install the agent

    On each monitored server, run the command from Hosts → Add a server:

    curl -fsSL https://kogut.dev/install | sh -s -- agent --server https://kogut.acme.com --token <token>

    This installs kogut-agent.service and saves its connection settings in /etc/kogut/agent.env, readable only by root. For both server and agent on one host, run the installer once for each. See Installing the agent.

    For the agent alone, the installer downloads the smaller agent-only build. Where kogut already runs the server, it keeps the full binary, which runs the agent too.

    To create the first account without the panel, call the setup endpoint of the HTTP API with the setup token and an Origin matching the panel.

    Shell completion

    kogut completions <shell> prints a completion script. Save it where your shell looks for completions, then open a new shell:

    kogut completions bash > ~/.local/share/bash-completion/completions/kogut
kogut completions zsh > ~/.zfunc/_kogut   # a directory on $fpath, before compinit
kogut completions fish > ~/.config/fish/completions/kogut.fish

    For zsh, the file must be named _kogut, and ~/.zshrc needs fpath=(~/.zfunc $fpath) before compinit.

    Uninstall

    sudo systemctl disable --now kogut
sudo rm /etc/systemd/system/kogut.service /usr/local/bin/kogut
sudo systemctl daemon-reload

    Data remains in /var/lib/private/kogut. Take a backup before removing it.