f8ac7c3a47
* add readeck to group_vars_mash_servers * add readeck to requirements.yml * add readeck to setup.yml * Create readeck.md
42 lines
1.6 KiB
Markdown
42 lines
1.6 KiB
Markdown
# Readeck
|
|
|
|
[Readeck](https://readeck.org) 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:
|
|
|
|
- a [Traefik](traefik.md) reverse-proxy server
|
|
|
|
|
|
## Configuration
|
|
|
|
To enable this service, add the following configuration to your `vars.yml` file and re-run the [installation](../installing.md) process:
|
|
|
|
```yaml
|
|
########################################################################
|
|
# #
|
|
# Readeck #
|
|
# #
|
|
########################################################################
|
|
|
|
readeck_enabled: true
|
|
|
|
readeck_hostname: readeck.example.com
|
|
|
|
########################################################################
|
|
# #
|
|
# /calibre-web #
|
|
# #
|
|
########################################################################
|
|
```
|
|
|
|
### 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.
|