mash-playbook/docs/services/notfellchen.md
Julian-Samuel Gebühr 5e79289871
Custom role Notfellchen (#190)
* feat: Add notfellchen

* fix: Restric salt size

* docs: Add notfellchen documentation

* feat(notfellchen): Add sws to serve media files

---------

Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2024-05-01 09:29:09 +03:00

1.9 KiB

ILMO

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.