mash-playbook/docs/services/notfellchen.md
2024-07-03 10:54:38 +02:00

1.9 KiB

Notfellchen

Notfellchen is a self-hosted tool to list animals available for adoption to increase their chance of finding a forever-home.

Warning: This service is a custom solution. Feel free to use it but don't expect a solution that works for every use case. Issues with this should be filed in the project itself.

Dependencies

This service requires the following other services:

Configuration

To enable this service, add the following configuration to your vars.yml file and re-run the installation process:

########################################################################
#                                                                      #
# notfellchen                                                          #
#                                                                      #
########################################################################

notfellchen_enabled: true
notfellchen_hostname: notfellchen.example.com

########################################################################
#                                                                      #
# /notfellchen                                                         #
#                                                                      #
########################################################################

Setting up the first user

You need to create a first user (unless you import an existing database). You can do this conveniently by running

just run-tags notfellchen-add-superuser --extra-vars=username=USERNAME --extra-vars=password=PASSWORD --extra-vars=email=EMAIL

Usage

After installation, you can go to the URL, as defined in notfellchen_hostname. Log in with the user credentials from above.