mash-playbook/docs/services/readeck.md
Slavi Pantaleev d5f099d62c Fix comment
2024-09-12 21:09:12 +03:00

1.6 KiB

Readeck

Readeck is a simple web application that lets you save the precious readable content of web pages you like and want to keep forever. See it as a bookmark manager and a read later tool.

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:

########################################################################
#                                                                      #
# Readeck                                                              #
#                                                                      #
########################################################################

readeck_enabled: true

readeck_hostname: readeck.example.com

########################################################################
#                                                                      #
# /Readeck                                                             #
#                                                                      #
########################################################################

URL

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

Usage

After installation, you can go to the Readeck URL, as defined in readeck_hostname, and create a user. The User Documentation is embedded in Readeck so it's easy to access and always up-to-date.