Administrator Manual

This manual describes the administration steps, if you want to install Peep on your own machines.

Architecture

Before starting with the deployment of the application, it is a good idea to take a look at the Architecture Manual first.

Requirements

Peep does require Bash on a Linux or MacOS system. Also, you need some common GNU tools like dateor hostname which will be present on most Linux distributions. You also need a compatible Nerd Font to use the icons feature. Yet, you can replace the icons with other things.

Deploy

This section describes the necessary steps to deploy the software.

Install script

The install script is the most convenient way installing Peep on your machine. You can run it directly from the web:

# Install for the current user only
$ curl -sfL https://peep.cozybagder.de/static/install.sh | bash -

# Install for all users of the system
$ curl -sfL https://peep.cozybagder.de/static/install.sh | sudo bash -

Or download it and execute the installer locally.

# Download
$ curl -sfL https://peep.cozybagder.de/static/install.sh -o peep_install.sh
# Now you can review the script and execute it afterward

# Change permissions
$ chmod 755 peep_install.sh
# Install for the current user only
$ ./peep_install.sh

# Install for all users of the system
$ sudo ./peep_install.sh

Manual Setup

If you don't like the script or if it doesn't work for you, you can also perform a manual installation. This is also the way, if you want to pick the desired commit directly from a development branch. To do, you need to download the desired release package from the releases page.

After checking out which release might be for you, you can download it with your browser or CLI.

VERSION=YOUR_VERSION curl -fsSL -o peep.tar.gz https://gitlab.com/api/v4/projects/69789030/packages/generic/peep/$VERSION/peep.tar.gz

After doing so, you need to unpack the release:

mkdir peep
tar -xvf peep.tar.gz -C peep

Hop into the new directory:

cd peep/

And copy Peep to your desired location:

# Install for the current user only
$ mkdir -p ~/.local/bin/
$ cp bin/peep ~/.local/bin/peep
$ chmod 755 ~/.local/bin/peep

# Install for all users of the system
$ sudo mkdir -p /usr/local/bin/
$ sudo cp bin/peep /usr/local/bin/peep
$ sudo chmod 755 /usr/local/bin/peep

You may also copy the default configuration and tweak it afterwards:

# Install for the current user only
$ mkdir -p ~/.config/peep/
$ cp config/default.cfg ~/.config/peep/peep.cfg
$ chmod 644 ~/.config/peep/peep.cfg

# Install for all users of the system
$ sudo mkdir -p /etc/peep/
$ sudo cp config/default.cfg /etc/peep/peep.cfg
$ sudo chmod 644 /etc/peep/peep.cfg

Path variables

On MacOS, neither ~/.local/bin, nor /usr/local/bin might be in your path. This can also be a problem on some Linux based operating systems. Depending on your shell, you need to add the destination to your Shell configurations.

Next steps

Now, that you have a running setup, you can check out the User Manual and do some configurations.