helfertoolctl

Repositories

There are Debian and CentOS repositories for helfertoolctl on https://repo.helfertool.org/.

Debian

There is a stable repository for Debian Buster:

deb https://repo.helfertool.org/debian/ buster main

Additionally, there is a repository for Debian Unstable that may contain a less stable version:

deb https://repo.helfertool.org/debian/ unstable main

CentOS

There is a stable and testing repository for CentOS 7, see repo file:

[helfertoolctl-stable]
name=helfertoolctl stable - $basearch
baseurl=https://repo.helfertool.org/centos/7/$basearch/stable
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://repo.helfertool.org/gpg.key
enabled=1
protect=1

[helfertoolctl-testing]
name=helfertoolctl testing - $basearch
baseurl=https://repo.helfertool.org/centos/7/$basearch/testing
gpgcheck=1
repo_gpgcheck=1
gpgkey=https://repo.helfertool.org/gpg.key
enabled=0
protect=1

Basic commands

Start

To start the Helfertool service, run:

sudo systemctl start helfertool

It is also possible to run helfertoolctl start, but usually the systemd service should be used.

Stop

To stop the Helfertool service, run:

sudo systemctl stop helfertool

It is also possible to run helfertoolctl stop, but usually the systemd service should be used.

Reload

It is possible to reload the configuration file without restarting the Docker container:

sudo systemctl reload helfertool

helfertoolctl reload is the same here and can also be called.

Updates

To download the newest version of Helfertool, run:

sudo helfertoolctl download

After that, the service needs to be restarted. To check, if a restart is necessary, you can run:

sudo helfertoolctl needsrestart

Initialize

After the installation, the database needs to be filled with some initial data:

sudo helfertoolctl init

Warning

Only run this once at the beginning!

Create administrator

To create a new administrator account using the command line, run:

sudo helfertoolctl createadmin

Show some statistics

To get the number of events, jobs, shifts and total number of helpers including archived helpers, run:

sudo helfertoolctl statistics

Commands for automation

Open / close public registration automatically

helfertoolctl provides commands to open and close the registration of events:

sudo helfertoolctl open <url_name>
sudo helfertoolctl close <url_name>

To open the registration for a event at a specific time, the at daemon can be used:

at '13:55 10/18/2018'

Disable old accounts

Inactive accounts can be disabled with the disableaccounts command. Inactive means that

  • the user did not log in since a specified date or

  • the user never logged in, but the account was created before the specified date.

Accounts from external authentication sources (LDAP) are not changed since the active flag is synced again from there.

sudo helfertoolctl disableaccounts [--dry-run] YYYY-MM-DD

Advanced commands

Shell access

To start a shell inside the Docker container, run:

sudo helfertoolctl shell

Django management command

To run some Django management command directly, run:

sudo helfertoolctl manage [...]

Log file postrotate

After the log file was rotated (by logrotate), postrotate must be executed:

sudo helfertoolctl postrotate