mash-playbook/docs/services/linkding.md
Alejandro AR 3c9a69dfe4
Apply suggestions from code review
Co-authored-by: Slavi Pantaleev <slavi@devture.com>
2023-07-21 13:43:26 +02:00

2.5 KiB

Linkding

Linkding bookmark manager that is designed be to be minimal and fast.

Dependencies

This service requires the following other services:

  • a Postgres database, but SQLite is also a possibility (see linkding_database_engine below)
  • a Traefik reverse-proxy server

Configuration

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

########################################################################
#                                                                      #
# linkding                                                             #
#                                                                      #
########################################################################

linkding_enabled: true

linkding_hostname: mash.example.com
linkding_path_prefix: /linkding

# We configure Linkding to use Postgres by default. See docs/services/postgres.md.
# To use an external Postgres server, you need to tweak additional `linkding_database_*` variables.
# Feel free to remove the line below to make Linkding use SQLite.
linkding_database_engine: postgres

linkding_superuser_username: change me
linkding_superuser_password: change me

########################################################################
#                                                                      #
# /linkding                                                            #
#                                                                      #
########################################################################

In the example configuration above, we configure the service to be hosted at https://mash.example.com/linkding.

You can remove the linkding_path_prefix variable definition, so that the service is served at https://mash.example.com/.

Usage

Superuser

Please note the use of linkding_superuser_username and linkding_superuser_password variables. These are not mandatory and are meant to be set the first time you run this role.

Database

The role defaults to SQlite, but you can opt to use PostgreSQL by adding the following:

linkding_database_engine: postgres