Getting started

Installation

Once you’ve got Bun running on your system, installing Anzeiger is as simple as:

# Install Anzeigere via bun
bun install anzeiger

# Once that's done: Run it
bunx anzeiger

In case you haven’t installed Bun yet, but want to give it (& Anzeiger, of course ;)) a try, you can find the official instructions on how to install Bun in their documentation.

Copied from there:

macOS & Linux

curl -fsSL https://bun.com/install | bash

Windows

powershell -c "irm bun.sh/install.ps1|iex"

Package Managers

npm

npm install -g bun # the last `npm` command you'll ever need

Homebrew

brew install oven-sh/bun/bun

Scoop

scoop install bun

Security

Some words about security

Anzeiger will run any plugins you tell it to run. It’s impossible for us to check third-party plugins for malicious code. It’s recommended to create a separate user for Anzeiger with as few permissions as possible, or even run it inside a (Docker) container.

Configuration

Anzeiger reads it’s configuration from a configuration file, which can be .yaml, .json, … (see Configuration). When the configuration file Anzeiger attempts to load does not exist, Anzeiger will guide you through a tiny onboarding and writes a basic configuration file which you can edit to make it fit your needs.

Install Plugins

Have a look at Install Plugins.