cloudserve-infrastructure/roles/shaarli/README.md

40 lines
1.2 KiB
Markdown

# shaarli
A simple and fast bookmark manager.
Can be deployed in minutes and takes minimum amount of resources.
Be aware that shaarli installations can *not* be fully automated.
That means after running this ansible role you will still have to setup up the first run wizard and create a user and so forth
(if not running with an existing data-store).
Do this quickly after setup,
*especially* if your instance is public-facing!
{: .alert .alert-warning}
## Defaults
```
shaarli_upstream_file_dir: "{{ docker_stack_files_dir }}/{{ stack_name }}"
```
The on-target directory where the proxy configuration file should be stashed.
```
shaarli_use_https: true
```
Whether the service should be reachable through http (port 80) or through https (port 443) and provision an https certificate. Usually you will want this to stay `true`.
```
shaarli_version: latest
```
The docker image version to be used in stack creation.
```
subdomain_alias: links
```
If the deployed container should be served over a uri that is not the stack name.
By default, it will be set to `links.yourdomain.com` -
if this option is not set it will be served on `shaarli.yourdomain.com` instead.