Compare commits
27 commits
03bf0efe44
...
3236ca332f
| Author | SHA1 | Date | |
|---|---|---|---|
|
|
3236ca332f | ||
|
|
19864d79b2 | ||
|
|
1dcff92240 | ||
|
|
a9c33baed9 | ||
|
|
60464e6d23 | ||
|
|
f0cd8ba432 | ||
|
|
3855b3e0e7 | ||
|
|
ce50bdb4d3 | ||
|
|
6411f94cce | ||
|
|
99d8968a2e | ||
|
|
2104e5fe7d | ||
|
|
c3cf779532 | ||
|
|
c11f019aae | ||
|
|
a492c3ee04 | ||
|
|
b19ac2270a | ||
|
|
e1d604effc | ||
|
|
4655c8f037 | ||
|
|
9a9039c4d3 | ||
|
|
dc8f1e2ecd | ||
| 05fb62c75d | |||
|
|
2c2dbbc648 | ||
| 951b1822fe | |||
|
|
30f3c16b59 | ||
|
|
fb81f60f9d | ||
|
|
48d12a1b4a | ||
| 03af64ca2c | |||
| 53e80ad7be |
128 changed files with 6328 additions and 796 deletions
69
README.md
69
README.md
|
|
@ -1,3 +1,68 @@
|
|||
# Ansible Collection - digitalboard.core
|
||||
# Ansible Collection — digitalboard.core
|
||||
|
||||
Documentation for the collection.
|
||||
This collection bundles the Ansible roles used to deploy the
|
||||
[Digitalboard](https://git.digitalboard.ch/Digitalboard) platform: a set of
|
||||
self-hosted, Docker-Compose-based services running behind Traefik, with
|
||||
single sign-on provided by authentik or Keycloak.
|
||||
|
||||
Each role provisions one service (or building block) as a self-contained
|
||||
Docker Compose stack. Roles are consumed from the deployment repository
|
||||
[reference-ansible](https://git.digitalboard.ch/Digitalboard/reference-ansible),
|
||||
where inventories and playbooks tie the roles to concrete hosts.
|
||||
|
||||
## Roles
|
||||
|
||||
| Role | Description |
|
||||
| --- | --- |
|
||||
| `base` | Host baseline: Docker, apt packages and convenience tooling on Debian/Ubuntu. |
|
||||
| `traefik` | Traefik v3 reverse proxy as a public DMZ proxy (file provider) or backend proxy (docker provider). |
|
||||
| `authentik` | [authentik](https://goauthentik.io) IdP (server + worker + Postgres); resources via blueprints. |
|
||||
| `authentik_outpost_ldap` | authentik LDAP outpost exposing an LDAP interface for apps that cannot speak OIDC. |
|
||||
| `keycloak` | [Keycloak](https://www.keycloak.org/) IdP with a PostgreSQL backend. |
|
||||
| `389ds` | [389 Directory Server](https://www.port389.org/) LDAP directory via Docker Compose. |
|
||||
| `nextcloud` | [Nextcloud](https://nextcloud.com/) (fpm) + Postgres + Redis, optional Collabora/draw.io/notify_push. |
|
||||
| `opencloud` | [OpenCloud](https://opencloud.eu/) file platform via Docker Compose. |
|
||||
| `collabora` | [Collabora Online](https://www.collaboraonline.com/) (CODE), used as the WOPI backend for Nextcloud. |
|
||||
| `bookstack` | [BookStack](https://www.bookstackapp.com/) wiki (LSIO + MariaDB) with OIDC SSO and daily backups. |
|
||||
| `drawio` | [draw.io](https://www.drawio.com/) diagram editor, with optional authentik ForwardAuth gating. |
|
||||
| `homarr` | [Homarr](https://github.com/homarr-labs/homarr) dashboard with seeded admin user and OIDC group. |
|
||||
| `opnform` | [OpnForm](https://github.com/OpnForm/OpnForm) self-hosted form builder (api + ui + db + redis). |
|
||||
| `send` | [Send](https://github.com/timvisee/send) (timvisee fork) file sharing with a Redis backend. |
|
||||
| `garage` | [Garage](https://garagehq.deuxfleurs.fr/) S3-compatible object storage with key/bucket provisioning. |
|
||||
| `httpbin` | [httpbin](https://httpbin.org/) HTTP request/response testing service for validating Traefik ingress. |
|
||||
|
||||
## Usage
|
||||
|
||||
Roles are not run from this repository directly. They are consumed from the
|
||||
deployment repository
|
||||
[reference-ansible](https://git.digitalboard.ch/Digitalboard/reference-ansible),
|
||||
which holds the inventories, group/host variables and playbooks. See that
|
||||
repository's `docs/` directory for getting-started instructions, how to run
|
||||
Ansible and how secrets are managed.
|
||||
|
||||
Per-role variables and their defaults are documented in each role's own
|
||||
`README.md` and `meta/argument_specs.yml`.
|
||||
|
||||
## Requirements
|
||||
|
||||
- A Debian/Ubuntu target host (the `base` role bootstraps Docker there).
|
||||
- ansible-core 2.15 or newer on the controller.
|
||||
- The `community.docker` collection (used by nearly every role) and
|
||||
`community.general` (used by the `keycloak` role). Both are declared as
|
||||
`dependencies` in `galaxy.yml` and pulled in automatically when this
|
||||
collection is installed via `ansible-galaxy`.
|
||||
|
||||
The role READMEs use `community.hashi_vault` lookups in their examples to source
|
||||
secrets from HashiCorp Vault. That is a documented convention, not a hard
|
||||
dependency of the roles — supply the variables however you prefer.
|
||||
|
||||
## Role ordering
|
||||
|
||||
Within a play, apply the roles in dependency order: `base` first (Docker and the
|
||||
host baseline), then `traefik` (the shared reverse proxy and its Docker network),
|
||||
then the individual service roles (`authentik`, `keycloak`, `nextcloud`, …),
|
||||
which attach to Traefik's network and expect Docker to be present.
|
||||
|
||||
## License
|
||||
|
||||
MIT-0. See individual roles for per-role license metadata.
|
||||
|
|
|
|||
26
galaxy.yml
26
galaxy.yml
|
|
@ -19,15 +19,16 @@ readme: README.md
|
|||
authors:
|
||||
- Bert-Jan Fikse <bert-jan@whatwedo.ch>
|
||||
- Tobias Wüst <tobias.wuest@wksbern.ch>
|
||||
- Simon Bärlocher <simon@whatwedo.ch>
|
||||
|
||||
### OPTIONAL but strongly recommended
|
||||
# A short summary description of the collection
|
||||
description: your collection description
|
||||
description: Ansible roles to deploy the Digitalboard self-hosted service platform (Docker Compose + Traefik + SSO)
|
||||
|
||||
# Either a single license or a list of licenses for content inside of a collection. Ansible Galaxy currently only
|
||||
# accepts L(SPDX,https://spdx.org/licenses/) licenses. This key is mutually exclusive with 'license_file'
|
||||
license:
|
||||
- GPL-2.0-or-later
|
||||
- MIT-0
|
||||
|
||||
# The path to the license file for the collection. This path is relative to the root of the collection. This key is
|
||||
# mutually exclusive with 'license'
|
||||
|
|
@ -35,25 +36,36 @@ license_file: ''
|
|||
|
||||
# A list of tags you want to associate with the collection for indexing/searching. A tag name has the same character
|
||||
# requirements as 'namespace' and 'name'
|
||||
tags: []
|
||||
tags:
|
||||
- digitalboard
|
||||
- docker
|
||||
- traefik
|
||||
- sso
|
||||
- selfhosted
|
||||
|
||||
# Collections that this collection requires to be installed for it to be usable. The key of the dict is the
|
||||
# collection label 'namespace.name'. The value is a version range
|
||||
# L(specifiers,https://python-semanticversion.readthedocs.io/en/latest/#requirement-specification). Multiple version
|
||||
# range specifiers can be set and are separated by ','
|
||||
dependencies: {}
|
||||
dependencies:
|
||||
# Used by nearly every role: docker_compose_v2, docker_container,
|
||||
# docker_container_exec, docker_network. Hard runtime dependency.
|
||||
community.docker: '>=3.0.0'
|
||||
# Used by the keycloak role (keycloak_realm/client/group/user and
|
||||
# related modules) in roles/keycloak/tasks/provisioning.yml.
|
||||
community.general: '>=7.0.0'
|
||||
|
||||
# The URL of the originating SCM repository
|
||||
repository: https://git.digitalboard.ch/Digitalboard/digitalboard.core
|
||||
|
||||
# The URL to any online docs
|
||||
documentation: http://docs.example.com
|
||||
documentation: https://git.digitalboard.ch/Digitalboard/digitalboard.core
|
||||
|
||||
# The URL to the homepage of the collection/project
|
||||
homepage: http://example.com
|
||||
homepage: https://git.digitalboard.ch/Digitalboard/digitalboard.core
|
||||
|
||||
# The URL to the collection issue tracker
|
||||
issues: http://example.com/issue/tracker
|
||||
issues: https://git.digitalboard.ch/Digitalboard/digitalboard.core/issues
|
||||
|
||||
# A list of file glob-like patterns used to filter any files or directories that should not be included in the build
|
||||
# artifact. A pattern is matched from the relative path of the file or directory of the collection directory. This
|
||||
|
|
|
|||
|
|
@ -1,8 +1,9 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# Collections must specify a minimum required ansible version to upload
|
||||
# to galaxy
|
||||
# requires_ansible: '>=2.9.10'
|
||||
# to galaxy. Aligned with the highest min_ansible_version declared by the
|
||||
# roles (the traefik role requires ansible-core 2.15).
|
||||
requires_ansible: '>=2.15.0'
|
||||
|
||||
# Content that Ansible needs to load from another location or that has
|
||||
# been deprecated/removed
|
||||
|
|
|
|||
|
|
@ -1,31 +1,32 @@
|
|||
# Collections Plugins Directory
|
||||
# Collection Plugins — digitalboard.core
|
||||
|
||||
This directory can be used to ship various plugins inside an Ansible collection. Each plugin is placed in a folder that
|
||||
is named after the type of plugin it is in. It can also include the `module_utils` and `modules` directory that
|
||||
would contain module utils and modules respectively.
|
||||
This collection ships a small number of custom plugins that support the roles.
|
||||
They are addressed by their fully qualified name, `digitalboard.core.<name>`.
|
||||
|
||||
Here is an example directory of the majority of plugins currently supported by Ansible:
|
||||
## Filter plugins (`filter/`)
|
||||
|
||||
```
|
||||
└── plugins
|
||||
├── action
|
||||
├── become
|
||||
├── cache
|
||||
├── callback
|
||||
├── cliconf
|
||||
├── connection
|
||||
├── filter
|
||||
├── httpapi
|
||||
├── inventory
|
||||
├── lookup
|
||||
├── module_utils
|
||||
├── modules
|
||||
├── netconf
|
||||
├── shell
|
||||
├── strategy
|
||||
├── terminal
|
||||
├── test
|
||||
└── vars
|
||||
`homarr_layout` — computes Homarr dashboard grid layouts (desktop / tablet /
|
||||
mobile breakpoints) from a list of apps, returning a ready-to-render data
|
||||
structure for the SQL seed. Used by the `homarr` role.
|
||||
|
||||
```yaml
|
||||
- name: Compute Homarr app layouts
|
||||
ansible.builtin.set_fact:
|
||||
homarr_layout: "{{ homarr_apps | digitalboard.core.homarr_compute_layouts }}"
|
||||
```
|
||||
|
||||
A full list of plugin types can be found at [Working With Plugins](https://docs.ansible.com/ansible-core/2.19/plugins/plugins.html).
|
||||
## Lookup plugins (`lookup/`)
|
||||
|
||||
`garage_credentials` — returns S3 credentials (`key_id`, `secret_key`) for a
|
||||
named Garage key by executing a docker command on the target host. Used to wire
|
||||
Garage object storage into consuming roles such as `nextcloud`.
|
||||
|
||||
```yaml
|
||||
nextcloud_s3_key: >-
|
||||
{{ lookup('digitalboard.core.garage_credentials', 'nextcloud', host='backend')['key_id'] }}
|
||||
nextcloud_s3_secret: >-
|
||||
{{ lookup('digitalboard.core.garage_credentials', 'nextcloud', host='backend')['secret_key'] }}
|
||||
```
|
||||
|
||||
No other plugin types (modules, action, callback, inventory, etc.) are currently
|
||||
shipped by this collection.
|
||||
|
|
|
|||
|
|
@ -1,38 +1,43 @@
|
|||
Role Name
|
||||
=========
|
||||
# 389ds
|
||||
|
||||
A brief description of the role goes here.
|
||||
Deploys [389 Directory Server](https://www.port389.org/) (`389ds/dirsrv`)
|
||||
as an LDAP directory via Docker Compose. After the container starts, the
|
||||
role creates the configured suffix and a set of base organizational
|
||||
units (e.g. `users`, `groups`).
|
||||
|
||||
Requirements
|
||||
------------
|
||||
## Requirements
|
||||
|
||||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
||||
- Docker and Docker Compose on the target host (e.g. via
|
||||
`digitalboard.core.base`)
|
||||
- Ansible collection: `community.docker`
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
## Role variables
|
||||
|
||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `ds389_image` | `docker.io/389ds/dirsrv:3.1` | Container image. |
|
||||
| `ds389_suffix` | `dc=example,dc=com` | Root suffix of the directory. |
|
||||
| `ds389_root_dn` | `cn=Directory Manager` | Directory Manager bind DN. |
|
||||
| `ds389_root_password` | `changeme` | Directory Manager password — **override this**. |
|
||||
| `ds389_instance_name` | `localhost` | Directory server instance name (slapd config dir). |
|
||||
| `ds389_hostname` | `389ds` | Container hostname (defaults to `ds389_service_name`). |
|
||||
| `ds389_backend_network` | `backend` | Docker network LDAP clients connect over (created by Compose). |
|
||||
| `ds389_ldap_port` | `3389` | Published LDAP port (container port 3389). |
|
||||
| `ds389_ldaps_port` | `3636` | Published LDAPS port (container port 3636). |
|
||||
| `ds389_base_ous` | `[users, groups]` | Base OUs created after startup. |
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
## Example
|
||||
|
||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
||||
```yaml
|
||||
- hosts: directory
|
||||
become: true
|
||||
roles:
|
||||
- role: digitalboard.core.389ds
|
||||
vars:
|
||||
ds389_suffix: "dc=example,dc=org"
|
||||
ds389_root_password: "{{ vault_ds389_root_password }}"
|
||||
```
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
## License
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
|
||||
- hosts: servers
|
||||
roles:
|
||||
- { role: username.rolename, x: 42 }
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
BSD
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -1,35 +1,26 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy 389 Directory Server (LDAP) via Docker Compose
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.2
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- 389ds
|
||||
- ldap
|
||||
- directory
|
||||
- docker
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
|
|
@ -1,28 +1,136 @@
|
|||
# Authentik
|
||||
|
||||
Deploys Authentik identity provider with Docker Compose.
|
||||
Deploys [authentik](https://goauthentik.io) (server + worker + Postgres)
|
||||
as a Docker Compose stack behind Traefik, with all resources provisioned
|
||||
via templated blueprints.
|
||||
|
||||
## What this role does
|
||||
|
||||
- Renders the Compose stack with traefik labels and an optional
|
||||
split-horizon host rewrite (see below)
|
||||
- Provisions local users, groups, OIDC apps, Proxy/ForwardAuth apps,
|
||||
LDAP apps and outposts, and Entra ID OAuth sources via blueprints
|
||||
- Configures the login screen (visible sources, local login fields)
|
||||
- Supports declarative cleanup via `authentik_removed_*` lists
|
||||
|
||||
## Variables
|
||||
|
||||
See `defaults/main.yml` for all available variables.
|
||||
Full spec with types and defaults: `meta/argument_specs.yml`. The most
|
||||
common overrides:
|
||||
|
||||
## Blueprints
|
||||
### Service
|
||||
|
||||
- `authentik_domains` (required, list): FQDNs the router accepts. First
|
||||
entry is the canonical hostname; further entries cover internal
|
||||
`*.int.*` names for server-to-server traffic.
|
||||
- `authentik_secret_key` (required): PG fernet / signing secret.
|
||||
Generate with `openssl rand -base64 60`.
|
||||
- `authentik_postgres_password` (required).
|
||||
- `authentik_image`, `authentik_port`, `authentik_log_level`.
|
||||
|
||||
### Split-horizon host rewrite
|
||||
|
||||
`authentik_host_rewrite_domains` lists hostnames that should reach the
|
||||
authentik container but make it generate URLs (OIDC issuer, password
|
||||
reset links, etc.) as if the request had arrived on
|
||||
`authentik_domains[0]`.
|
||||
|
||||
For each entry the role:
|
||||
|
||||
- Creates a dedicated traefik router on that hostname
|
||||
- Routes it to a URL-based loadbalancer service that disables
|
||||
`passHostHeader`, so the upstream Host header becomes the canonical
|
||||
FQDN
|
||||
- Pins `X-Forwarded-Host` via middleware so the iss claim stays aligned
|
||||
with the public hostname browsers see
|
||||
|
||||
Use case: an internal `auth.int.example.com` keeps server-to-server
|
||||
traffic in the LAN, but Keycloak/Nextcloud/etc. still receive issuer
|
||||
URLs matching `auth.example.com`.
|
||||
|
||||
### Blueprints
|
||||
|
||||
The role renders blueprints for:
|
||||
|
||||
- Local users (`authentik_local_users`)
|
||||
- Groups (`authentik_groups`)
|
||||
- OIDC applications (`authentik_oidc_apps`)
|
||||
- Proxy applications (`authentik_proxy_apps`)
|
||||
- Proxy outposts (`authentik_proxy_outposts`)
|
||||
- LDAP applications (`authentik_ldap_apps`)
|
||||
- LDAP outpost (`authentik_ldap_outpost`)
|
||||
- Entra ID sources (`authentik_entra_sources`)
|
||||
- Login screen sources (`authentik_login_source_ids`)
|
||||
- Login-screen source visibility (`authentik_login_sources`)
|
||||
|
||||
Secrets are passed via `authentik_blueprint_env` using environment variable references.
|
||||
Secrets are passed via the `authentik_blueprint_env` env-var indirection
|
||||
so they never land in rendered blueprint YAML on disk.
|
||||
|
||||
#### Proxy apps: mode and group restrictions
|
||||
|
||||
Each entry in `authentik_proxy_apps` supports:
|
||||
|
||||
- `mode` (default `forward_single`): one of `proxy`, `forward_single`,
|
||||
`forward_domain`
|
||||
- `allowed_groups`: when set, a `PolicyBinding` is emitted per group on
|
||||
the application. authentik OR-evaluates bindings, so users in any
|
||||
listed group pass and users in none are denied.
|
||||
|
||||
Example:
|
||||
|
||||
```yaml
|
||||
authentik_proxy_apps:
|
||||
- slug: drawio
|
||||
name: drawio
|
||||
external_host: "https://drawio.example.com"
|
||||
mode: forward_single
|
||||
allowed_groups:
|
||||
- drawio-users
|
||||
- admins
|
||||
```
|
||||
|
||||
## Removing resources
|
||||
|
||||
To remove resources from Authentik, move slugs to the removal lists:
|
||||
Move slugs from the active list to the matching removal list:
|
||||
|
||||
- `authentik_removed_oidc_apps`
|
||||
- `authentik_removed_proxy_apps`
|
||||
- `authentik_removed_local_users`
|
||||
|
||||
After confirming deletion, remove the slug from the list.
|
||||
After authentik has applied the deletion blueprint, remove the slug
|
||||
from the list to keep state clean.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Run `digitalboard.core.base` first (Docker) and have the `community.docker`
|
||||
collection installed; the role drives the stack via
|
||||
`community.docker.docker_compose_v2`.
|
||||
- Traefik network (`authentik_traefik_network`, default `proxy`) must exist
|
||||
beforehand (e.g. created by the traefik role); it is referenced as an
|
||||
external network in the Compose file.
|
||||
- Internal backend network (`authentik_backend_network`, default `backend`).
|
||||
|
||||
## Example playbook
|
||||
|
||||
```yaml
|
||||
- hosts: identity_servers
|
||||
roles:
|
||||
- role: digitalboard.core.authentik
|
||||
vars:
|
||||
authentik_domains:
|
||||
- "auth.example.com"
|
||||
- "auth.int.example.com"
|
||||
authentik_host_rewrite_domains:
|
||||
- "auth.int.example.com"
|
||||
authentik_secret_key: "{{ vault_authentik_secret_key }}"
|
||||
authentik_postgres_password: "{{ vault_authentik_pg_password }}"
|
||||
authentik_proxy_apps:
|
||||
- slug: drawio
|
||||
name: drawio
|
||||
external_host: "https://drawio.example.com"
|
||||
mode: forward_single
|
||||
allowed_groups: [drawio-users]
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -12,7 +12,20 @@ authentik_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ authentik_servic
|
|||
authentik_docker_volume_dir: "{{ docker_volume_base_dir }}/{{ authentik_service_name }}"
|
||||
|
||||
# Authentik service configuration
|
||||
authentik_domain: "authentik.local.test"
|
||||
# FQDNs the authentik router accepts. The first entry is the canonical
|
||||
# domain; further entries cover internal *.int.* names used for
|
||||
# server-to-server traffic so backend calls don't hairpin via DMZ.
|
||||
authentik_domains:
|
||||
- "authentik.local.test"
|
||||
|
||||
# Hostnames that should reach authentik but make it generate URLs (OIDC
|
||||
# issuer, password reset links, etc.) as if requested from the canonical
|
||||
# `authentik_domains[0]` instead. Used for split-horizon setups where an
|
||||
# internal FQDN (e.g. `auth.int.example.com`) keeps server-to-server
|
||||
# traffic in the LAN but the iss claim must still match the public
|
||||
# hostname that browsers see. Traefik handles each entry via a separate
|
||||
# router that rewrites the Host header before forwarding to authentik.
|
||||
authentik_host_rewrite_domains: []
|
||||
authentik_image: "ghcr.io/goauthentik/server:2026.2.2"
|
||||
authentik_port: 9000
|
||||
authentik_secret_key: "changeme-generate-a-random-string"
|
||||
|
|
|
|||
193
roles/authentik/meta/argument_specs.yml
Normal file
193
roles/authentik/meta/argument_specs.yml
Normal file
|
|
@ -0,0 +1,193 @@
|
|||
---
|
||||
argument_specs:
|
||||
main:
|
||||
short_description: Deploy authentik (server + worker + Postgres) via Docker Compose.
|
||||
description:
|
||||
- Renders a Compose stack for authentik with traefik labels, optional
|
||||
TLS and a configurable split-horizon host-rewrite that keeps the OIDC
|
||||
issuer URL on the canonical public hostname even when traffic enters
|
||||
on an internal FQDN.
|
||||
- Provisions resources through templated blueprints
|
||||
(local users, groups, OIDC/Proxy/LDAP apps, outposts, OAuth sources).
|
||||
options:
|
||||
docker_compose_base_dir:
|
||||
type: path
|
||||
default: /etc/docker/compose
|
||||
docker_volume_base_dir:
|
||||
type: path
|
||||
default: /srv/data
|
||||
authentik_service_name:
|
||||
type: str
|
||||
default: authentik
|
||||
authentik_docker_compose_dir:
|
||||
type: path
|
||||
description: Defaults to C({{ docker_compose_base_dir }}/{{ authentik_service_name }}).
|
||||
authentik_docker_volume_dir:
|
||||
type: path
|
||||
description: Defaults to C({{ docker_volume_base_dir }}/{{ authentik_service_name }}).
|
||||
|
||||
authentik_domains:
|
||||
type: list
|
||||
elements: str
|
||||
required: true
|
||||
description:
|
||||
- FQDNs the authentik router accepts. The first entry is the
|
||||
canonical (public) hostname and is used for the network alias,
|
||||
the X-Forwarded-Host rewrite target, and as the default OIDC
|
||||
issuer. Further entries cover internal C(*.int.*) names used
|
||||
for server-to-server traffic.
|
||||
authentik_host_rewrite_domains:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
description:
|
||||
- Hostnames that should reach authentik but make it generate URLs
|
||||
(OIDC issuer, password reset links, etc.) as if the request had
|
||||
arrived on C(authentik_domains[0]).
|
||||
- Each entry gets its own traefik router and a URL-based
|
||||
loadbalancer service that disables passHostHeader and pins
|
||||
X-Forwarded-Host via middleware. Used for split-horizon setups
|
||||
where the LAN keeps server-to-server traffic but the iss claim
|
||||
must match the public hostname browsers see.
|
||||
authentik_image:
|
||||
type: str
|
||||
default: ghcr.io/goauthentik/server:2026.2.2
|
||||
authentik_port:
|
||||
type: int
|
||||
default: 9000
|
||||
authentik_secret_key:
|
||||
type: str
|
||||
required: true
|
||||
description: PG fernet key / signing secret. Generate with C(openssl rand -base64 60).
|
||||
|
||||
authentik_postgres_image:
|
||||
type: str
|
||||
default: postgres:16-alpine
|
||||
authentik_postgres_db:
|
||||
type: str
|
||||
default: authentik
|
||||
authentik_postgres_user:
|
||||
type: str
|
||||
default: authentik
|
||||
authentik_postgres_password:
|
||||
type: str
|
||||
required: true
|
||||
|
||||
authentik_traefik_network:
|
||||
type: str
|
||||
default: proxy
|
||||
authentik_backend_network:
|
||||
type: str
|
||||
default: backend
|
||||
authentik_use_ssl:
|
||||
type: bool
|
||||
default: true
|
||||
|
||||
authentik_log_level:
|
||||
type: str
|
||||
choices: [trace, debug, info, warning, error]
|
||||
default: info
|
||||
authentik_error_reporting_enabled:
|
||||
type: bool
|
||||
default: false
|
||||
|
||||
authentik_proxy_apps:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
description:
|
||||
- Proxy/ForwardAuth applications rendered via the
|
||||
C(blueprint-proxy-app.yaml.j2) template.
|
||||
options:
|
||||
slug:
|
||||
type: str
|
||||
required: true
|
||||
name:
|
||||
type: str
|
||||
required: true
|
||||
internal_host:
|
||||
type: str
|
||||
description: Required when C(mode=proxy).
|
||||
external_host:
|
||||
type: str
|
||||
required: true
|
||||
mode:
|
||||
type: str
|
||||
choices: [proxy, forward_single, forward_domain]
|
||||
default: forward_single
|
||||
description:
|
||||
- "C(proxy): the outpost itself proxies traffic to internal_host."
|
||||
- "C(forward_single): a single app behind an external reverse
|
||||
proxy via ForwardAuth."
|
||||
- "C(forward_domain): wildcard mode — one provider guards every
|
||||
host on a cookie domain."
|
||||
allowed_groups:
|
||||
type: list
|
||||
elements: str
|
||||
description:
|
||||
- If set, PolicyBindings are emitted (one per group, OR-evaluated).
|
||||
Users in none of the listed groups are denied.
|
||||
skip_path_regex:
|
||||
type: str
|
||||
flows:
|
||||
type: dict
|
||||
description: Authentication / authorization / invalidation flow slugs.
|
||||
|
||||
authentik_proxy_outposts:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
|
||||
authentik_ldap_apps:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
authentik_ldap_outpost:
|
||||
type: dict
|
||||
default: {}
|
||||
|
||||
authentik_oidc_apps:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
|
||||
authentik_entra_sources:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
authentik_login_sources:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
authentik_identification_stage_name:
|
||||
type: str
|
||||
default: default-authentication-identification
|
||||
authentik_login_user_fields:
|
||||
type: list
|
||||
elements: str
|
||||
choices: [username, email, upn]
|
||||
default: [username, email]
|
||||
description: Local login fields shown on the login screen. Empty list hides local login.
|
||||
|
||||
authentik_groups:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
authentik_local_users:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
|
||||
authentik_removed_oidc_apps:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
description: OIDC application slugs scheduled for deletion.
|
||||
authentik_removed_proxy_apps:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
authentik_removed_local_users:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
|
|
@ -1,35 +1,28 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy authentik (server + worker + Postgres) via Docker Compose with blueprint-provisioned resources
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.2
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- authentik
|
||||
- oidc
|
||||
- sso
|
||||
- idp
|
||||
- docker
|
||||
- traefik
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
|
|
@ -16,8 +16,10 @@ entries:
|
|||
{% for field in authentik_login_user_fields %}
|
||||
- {{ field }}
|
||||
{% endfor %}
|
||||
{% if authentik_login_sources %}
|
||||
# OAuth/social login sources (use !Find to reference sources from other blueprints)
|
||||
sources:
|
||||
{% for src in authentik_login_sources %}
|
||||
- !Find [authentik_sources_oauth.oauthsource, [slug, {{ src.slug }}]]
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -20,6 +20,16 @@ entries:
|
|||
|
||||
internal_host: "{{ item.internal_host }}"
|
||||
external_host: "{{ item.external_host }}"
|
||||
{# Provider mode controls how authentik treats the proxy app:
|
||||
- proxy : the outpost itself proxies traffic to internal_host
|
||||
- forward_single : a single app behind an external reverse proxy
|
||||
(traefik forwardauth talks to authentik per-domain)
|
||||
- forward_domain : wildcard mode — one provider guards every host on a
|
||||
cookie domain; configure forward_auth_mode=domain on
|
||||
the outpost in that case. Default to forward_single
|
||||
since that's the common ForwardAuth-with-traefik
|
||||
pattern. #}
|
||||
mode: {{ item.mode | default('forward_single') }}
|
||||
|
||||
{% if item.skip_path_regex is defined and item.skip_path_regex|length > 0 %}
|
||||
skip_path_regex: |
|
||||
|
|
@ -34,3 +44,20 @@ entries:
|
|||
name: "{{ item.name | default(item.slug) }}"
|
||||
slug: {{ item.slug }}
|
||||
provider: !KeyOf proxy-provider-{{ item.slug }}
|
||||
|
||||
{% if item.allowed_groups is defined and item.allowed_groups | length > 0 %}
|
||||
{# Restrict access to listed groups: one PolicyBinding per group, all bound
|
||||
to the application. Authentik treats multiple bindings on the same target
|
||||
as OR (a user matching any binding passes), and a request from a user in
|
||||
none of the bound groups is denied. #}
|
||||
{% for group_name in item.allowed_groups %}
|
||||
- model: authentik_policies.policybinding
|
||||
identifiers:
|
||||
target: !KeyOf app-{{ item.slug }}
|
||||
order: {{ loop.index0 }}
|
||||
group: !Find [authentik_core.group, [name, "{{ group_name }}"]]
|
||||
attrs:
|
||||
enabled: true
|
||||
negate: false
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -43,19 +43,57 @@ services:
|
|||
postgres:
|
||||
condition: service_healthy
|
||||
networks:
|
||||
- {{ authentik_backend_network }}
|
||||
- {{ authentik_traefik_network }}
|
||||
{{ authentik_backend_network }}: {}
|
||||
# Network alias so traefik (which shares this network) can resolve
|
||||
# the canonical FQDN to this container directly. The URL-based
|
||||
# service below uses that to send upstream traffic with a fixed
|
||||
# Host header equal to the canonical hostname.
|
||||
{{ authentik_traefik_network }}:
|
||||
aliases:
|
||||
- {{ authentik_domains[0] }}
|
||||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network={{ authentik_traefik_network }}
|
||||
- traefik.http.routers.{{ authentik_service_name }}.rule=Host(`{{ authentik_domain }}`)
|
||||
- traefik.http.routers.{{ authentik_service_name }}.rule={% for d in authentik_domains %}Host(`{{ d }}`){% if not loop.last %} || {% endif %}{% endfor +%}
|
||||
- traefik.http.routers.{{ authentik_service_name }}.service={{ authentik_service_name }}
|
||||
{% if authentik_use_ssl %}
|
||||
- traefik.http.routers.{{ authentik_service_name }}.entrypoints=websecure
|
||||
- traefik.http.routers.{{ authentik_service_name }}.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.{{ authentik_service_name }}.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.{{ authentik_service_name }}.entrypoints=web
|
||||
{% endif %}
|
||||
- traefik.http.services.{{ authentik_service_name }}.loadbalancer.server.port={{ authentik_port }}
|
||||
{% if authentik_host_rewrite_domains | length > 0 %}
|
||||
# Server-to-server entry: a separate service points at this very
|
||||
# container by the canonical FQDN (resolved via the network alias
|
||||
# above) and disables passHostHeader so the upstream Host header
|
||||
# becomes `{{ authentik_domains[0] }}`. Authentik builds OIDC issuer
|
||||
# URLs from X-Forwarded-Host (not Host), so we also pin that header
|
||||
# via middleware. Together this keeps the iss claim aligned with
|
||||
# the public hostname browsers see during login, even when the
|
||||
# request itself arrived on an internal *.int.* FQDN.
|
||||
- traefik.http.services.{{ authentik_service_name }}-rewrite.loadbalancer.server.url=http://{{ authentik_domains[0] }}:{{ authentik_port }}
|
||||
- traefik.http.services.{{ authentik_service_name }}-rewrite.loadbalancer.passhostheader=false
|
||||
- traefik.http.middlewares.{{ authentik_service_name }}-xfh-rewrite.headers.customrequestheaders.X-Forwarded-Host={{ authentik_domains[0] }}
|
||||
{% for d in authentik_host_rewrite_domains %}
|
||||
- traefik.http.routers.{{ authentik_service_name }}-rewrite-{{ loop.index0 }}.rule=Host(`{{ d }}`)
|
||||
- traefik.http.routers.{{ authentik_service_name }}-rewrite-{{ loop.index0 }}.priority=100
|
||||
- traefik.http.routers.{{ authentik_service_name }}-rewrite-{{ loop.index0 }}.service={{ authentik_service_name }}-rewrite
|
||||
- traefik.http.routers.{{ authentik_service_name }}-rewrite-{{ loop.index0 }}.middlewares={{ authentik_service_name }}-xfh-rewrite
|
||||
{% if authentik_use_ssl %}
|
||||
- traefik.http.routers.{{ authentik_service_name }}-rewrite-{{ loop.index0 }}.entrypoints=websecure
|
||||
- traefik.http.routers.{{ authentik_service_name }}-rewrite-{{ loop.index0 }}.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.{{ authentik_service_name }}-rewrite-{{ loop.index0 }}.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.{{ authentik_service_name }}-rewrite-{{ loop.index0 }}.entrypoints=web
|
||||
{% endif %}
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
worker:
|
||||
image: {{ authentik_image }}
|
||||
|
|
|
|||
|
|
@ -1,38 +1,44 @@
|
|||
Role Name
|
||||
=========
|
||||
# authentik_outpost_ldap
|
||||
|
||||
A brief description of the role goes here.
|
||||
Deploys an [authentik](https://goauthentik.io) LDAP outpost via Docker
|
||||
Compose. The outpost exposes an LDAP interface backed by authentik, so
|
||||
applications that cannot speak OIDC (e.g. Nextcloud or OpenCloud LDAP
|
||||
backends) can still authenticate against the central IdP.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
The outpost connects back to an authentik server using an outpost token
|
||||
issued in the authentik admin interface. The image version must match
|
||||
the authentik server version.
|
||||
|
||||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
||||
## Requirements
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
- Docker and Docker Compose on the target host (e.g. via
|
||||
`digitalboard.core.base`)
|
||||
- Ansible collection: `community.docker`
|
||||
|
||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
|
||||
## Role variables
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `authentik_outpost_ldap_image` | `ghcr.io/goauthentik/ldap:2026.2.2` | Outpost image (match the server version). |
|
||||
| `authentik_outpost_ldap_host` | `https://authentik.local.test` | URL of the authentik server. |
|
||||
| `authentik_outpost_ldap_token` | `changeme` | Outpost token — **override this**. |
|
||||
| `authentik_outpost_ldap_insecure` | `"true"` | Skip TLS verification toward the authentik server. |
|
||||
| `authentik_outpost_ldap_network` | `ldap` | Docker network LDAP clients connect over (created by the role). |
|
||||
| `authentik_outpost_ldap_authentik_network` | _unset_ | Optional extra external network to the authentik server. |
|
||||
| `authentik_outpost_ldap_extra_hosts` | `[]` | Extra `host:ip` entries for in-container DNS. |
|
||||
|
||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
||||
## Example
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
```yaml
|
||||
- hosts: directory
|
||||
become: true
|
||||
roles:
|
||||
- role: digitalboard.core.authentik_outpost_ldap
|
||||
vars:
|
||||
authentik_outpost_ldap_host: "https://auth.example.com"
|
||||
authentik_outpost_ldap_token: "{{ vault_authentik_ldap_outpost_token }}"
|
||||
```
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
## License
|
||||
|
||||
- hosts: servers
|
||||
roles:
|
||||
- { role: username.rolename, x: 42 }
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
BSD
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -1,35 +1,27 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy an authentik LDAP outpost via Docker Compose for applications that cannot use OIDC
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.2
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- authentik
|
||||
- ldap
|
||||
- outpost
|
||||
- sso
|
||||
- docker
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
|
|
@ -1,38 +1,45 @@
|
|||
Role Name
|
||||
=========
|
||||
# base
|
||||
|
||||
A brief description of the role goes here.
|
||||
Host baseline for the Digitalboard platform. Installs Docker (engine,
|
||||
CLI, containerd, buildx, compose plugin) and a small set of apt and
|
||||
convenience packages on Debian/Ubuntu, and sets the shared directory
|
||||
layout every other role builds on.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
This role is intended to run first on every host, before any
|
||||
service role.
|
||||
|
||||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
||||
## What it does
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
- Installs Docker prerequisites (`apt-transport-https`, `ca-certificates`,
|
||||
`curl`, `gnupg`, `lsb-release`, `apache2-utils` for `htpasswd`) plus
|
||||
convenience packages (`htop`, `ncdu`, `vim`) and Docker itself
|
||||
(`docker-ce`, `docker-ce-cli`, `containerd.io`, `docker-buildx-plugin`,
|
||||
`docker-compose-plugin`).
|
||||
- Optionally configures Docker registry mirrors via `/etc/docker/daemon.json`.
|
||||
- Starts and enables the Docker service and writes a custom `/etc/motd`.
|
||||
|
||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
|
||||
This role defines the shared directory-layout variables
|
||||
(`docker_compose_base_dir`, `docker_volume_base_dir`) that every service
|
||||
role consumes, but the per-service subdirectories are created by the
|
||||
respective service roles, not here.
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
## Role variables
|
||||
|
||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `docker_compose_base_dir` | `/etc/docker/compose` | Root directory for per-service Compose projects. |
|
||||
| `docker_volume_base_dir` | `/srv/data` | Root directory for per-service persistent volumes. |
|
||||
| `docker_registry_mirrors` | `[]` | Optional list of registry mirror URLs; empty disables mirrors. |
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
## Example
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
```yaml
|
||||
- hosts: all
|
||||
become: true
|
||||
roles:
|
||||
- digitalboard.core.base
|
||||
```
|
||||
|
||||
- hosts: servers
|
||||
roles:
|
||||
- { role: username.rolename, x: 42 }
|
||||
## License
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
BSD
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -1,35 +1,25 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Host baseline — install Docker, required apt packages and convenience tooling on Debian/Ubuntu
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.1
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- base
|
||||
- docker
|
||||
- bootstrap
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
154
roles/bookstack/README.md
Normal file
154
roles/bookstack/README.md
Normal file
|
|
@ -0,0 +1,154 @@
|
|||
# Ansible Role: bookstack
|
||||
|
||||
Deploys [BookStack](https://www.bookstackapp.com/) as a self-contained Docker
|
||||
Compose stack behind Traefik, with its own MariaDB container, OIDC SSO
|
||||
(Entra ID by default) and a daily systemd-timer driven backup of database
|
||||
and uploads.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Docker Engine + Compose plugin on the target host
|
||||
- Traefik already running, with the external network referenced by
|
||||
`bookstack_traefik_network` (default: `proxy`)
|
||||
- `community.docker` collection on the controller
|
||||
- DNS for `bookstack_domain` pointing at the Traefik host
|
||||
|
||||
## Required variables
|
||||
|
||||
The role asserts these are set; the play fails fast if any is empty:
|
||||
|
||||
| Variable | Description |
|
||||
|---|---|
|
||||
| `bookstack_db_root_password` | MariaDB root password |
|
||||
| `bookstack_db_password` | MariaDB user password |
|
||||
| `bookstack_admin_password` | Initial local admin password |
|
||||
| `bookstack_oidc_client_id` | OIDC client ID (if OIDC on) |
|
||||
| `bookstack_oidc_client_secret` | OIDC client secret (if OIDC on) |
|
||||
|
||||
When OIDC is on, the role also asserts that `bookstack_oidc_issuer`
|
||||
resolves to a concrete URL. For Entra ID this means setting
|
||||
`bookstack_entra_tenant_id` (the default issuer interpolates it; an unset
|
||||
tenant leaves `//v2.0` and fails the assert). For other IdPs (Authentik,
|
||||
Keycloak) set `bookstack_oidc_issuer` directly instead.
|
||||
|
||||
Provide via OpenBao lookup, Ansible Vault or `--extra-vars`. Never commit
|
||||
real secrets.
|
||||
|
||||
## Optional variables
|
||||
|
||||
See `defaults/main.yml`. Frequently overridden:
|
||||
|
||||
- `bookstack_domain`, `bookstack_base_url`
|
||||
- `bookstack_extra_domains` (extra Host-rule hostnames, e.g. an internal
|
||||
`*.int.*` FQDN for a DMZ reverseproxy)
|
||||
- `bookstack_extra_hosts` (container `/etc/hosts` overrides for
|
||||
split-horizon IdP access; entries as `host:ip`)
|
||||
- `bookstack_image`, `bookstack_db_image` (pin in production)
|
||||
- `bookstack_oidc_enabled` (set `false` to disable OIDC entirely)
|
||||
- `bookstack_oidc_auto_initiate` (`true` redirects straight to IdP)
|
||||
- `bookstack_oidc_user_to_groups` (`true` syncs roles from Entra groups)
|
||||
- `bookstack_backup_enabled`, `bookstack_backup_schedule`,
|
||||
`bookstack_backup_retention_days`
|
||||
|
||||
## Entra ID app registration
|
||||
|
||||
1. Azure Portal → Entra ID → App registrations → New registration
|
||||
2. Redirect URI (Web): `https://<bookstack_domain>/oidc/callback`
|
||||
3. Front-channel logout URL: `https://<bookstack_domain>/logout`
|
||||
4. Certificates & secrets → New client secret →
|
||||
`bookstack_oidc_client_secret`
|
||||
5. For group sync (`bookstack_oidc_user_to_groups: true`):
|
||||
- Token configuration → Add groups claim → Security groups
|
||||
- In BookStack, create roles whose **External Auth ID** equals the
|
||||
Entra group Object ID, so the mapping resolves on first login.
|
||||
|
||||
## What the role does
|
||||
|
||||
| Phase | Action |
|
||||
|---|---|
|
||||
| Validate | `assert` all required secrets are set |
|
||||
| Prepare | install packages, create volume dirs, generate persistent `APP_KEY`, verify Traefik network |
|
||||
| Deploy | render `docker-compose.yml`, pull images, bring stack up |
|
||||
| Configure | wait for the app, create the initial local admin via `php artisan bookstack:create-admin` (idempotent) |
|
||||
| Backup | render `/usr/local/bin/bookstack-backup.sh` + systemd timer (daily 03:00, 14-day retention) |
|
||||
|
||||
## Example playbook
|
||||
|
||||
```yaml
|
||||
- name: Deploy BookStack service
|
||||
hosts: bookstack_servers
|
||||
become: true
|
||||
roles:
|
||||
- digitalboard.core.bookstack
|
||||
```
|
||||
|
||||
With inventory variables:
|
||||
|
||||
```yaml
|
||||
# group_vars/bookstack_servers.yml
|
||||
bookstack_domain: wiki.digitalboard.ch
|
||||
bookstack_base_url: "https://wiki.digitalboard.ch"
|
||||
bookstack_entra_tenant_id: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/bookstack',
|
||||
mount_point='kv').data.data.tenant_id }}"
|
||||
bookstack_oidc_client_id: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/bookstack',
|
||||
mount_point='kv').data.data.client_id }}"
|
||||
bookstack_oidc_client_secret: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/bookstack',
|
||||
mount_point='kv').data.data.client_secret }}"
|
||||
bookstack_db_root_password: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/bookstack',
|
||||
mount_point='kv').data.data.db_root_password }}"
|
||||
bookstack_db_password: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/bookstack',
|
||||
mount_point='kv').data.data.db_password }}"
|
||||
bookstack_admin_password: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/bookstack',
|
||||
mount_point='kv').data.data.admin_password }}"
|
||||
```
|
||||
|
||||
## Backup / restore
|
||||
|
||||
Backups land in `{{ bookstack_backup_dir }}` (default
|
||||
`/srv/data/bookstack/backup`) with three files per run:
|
||||
|
||||
- `bookstack-db-<stamp>.sql.gz` — mariadb-dump
|
||||
- `bookstack-files-<stamp>.tar.gz` — uploads, attachments
|
||||
- `bookstack-appkey-<stamp>.txt` — APP_KEY (required for restore!)
|
||||
|
||||
Manual trigger: `systemctl start bookstack-backup.service`
|
||||
Timer status: `systemctl list-timers bookstack-backup.timer`
|
||||
|
||||
Restore procedure:
|
||||
|
||||
1. Stop the stack: `docker compose down` in `bookstack_docker_compose_dir`
|
||||
2. Restore the APP_KEY: copy the `.txt` content to
|
||||
`{{ bookstack_docker_volume_dir }}/.app_key` (the key MUST match or
|
||||
encrypted DB values become unreadable)
|
||||
3. Start only the DB container, then load the dump:
|
||||
```bash
|
||||
gunzip -c bookstack-db-<stamp>.sql.gz \
|
||||
| docker exec -i bookstack-db \
|
||||
mariadb -u root -p"<root-pw>" bookstack
|
||||
```
|
||||
4. Extract the files: `tar -xzf bookstack-files-<stamp>.tar.gz -C
|
||||
{{ bookstack_appdata_dir }}/www/`
|
||||
5. Bring the stack back up: `docker compose up -d`
|
||||
|
||||
## Notes
|
||||
|
||||
- `bookstack_oidc_auto_initiate: false` (default) shows a login page
|
||||
with an SSO button alongside the local login form. With `true`, users
|
||||
go straight to the IdP — the local admin then has to use
|
||||
`https://<domain>/login?email_login=1`.
|
||||
- `bookstack_oidc_user_to_groups: true` only makes sense once BookStack
|
||||
roles with the correct **External Auth IDs** (= Entra group Object
|
||||
IDs) exist; otherwise users lose their role assignment on every login.
|
||||
- Image tags default to pinned versions; bump them deliberately rather
|
||||
than chasing `latest`.
|
||||
- BookStack officially supports MySQL/MariaDB only — no PostgreSQL.
|
||||
|
||||
## License
|
||||
|
||||
MIT-0
|
||||
93
roles/bookstack/defaults/main.yml
Normal file
93
roles/bookstack/defaults/main.yml
Normal file
|
|
@ -0,0 +1,93 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# defaults file for bookstack
|
||||
|
||||
# Base directory configuration (inherited from base role or defined here)
|
||||
docker_compose_base_dir: /etc/docker/compose
|
||||
docker_volume_base_dir: /srv/data
|
||||
|
||||
# bookstack-specific configuration
|
||||
bookstack_service_name: bookstack
|
||||
bookstack_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ bookstack_service_name }}"
|
||||
bookstack_docker_volume_dir: "{{ docker_volume_base_dir }}/{{ bookstack_service_name }}"
|
||||
bookstack_appdata_dir: "{{ bookstack_docker_volume_dir }}/appdata"
|
||||
bookstack_db_data_dir: "{{ bookstack_docker_volume_dir }}/db"
|
||||
bookstack_backup_dir: "{{ bookstack_docker_volume_dir }}/backup"
|
||||
|
||||
# Service configuration
|
||||
bookstack_domain: "wiki.local.test"
|
||||
# Additional hostnames the bookstack router answers on (e.g. an internal
|
||||
# *.int.* FQDN so a DMZ reverseproxy can hit a backend hostname covered
|
||||
# by the cert).
|
||||
bookstack_extra_domains: []
|
||||
# Container-level /etc/hosts overrides — useful in split-horizon setups
|
||||
# where the BookStack container needs to reach an IdP's public FQDN
|
||||
# (used in the OIDC `iss` claim) over the LAN rather than via the DMZ.
|
||||
bookstack_extra_hosts: []
|
||||
bookstack_base_url: "https://{{ bookstack_domain }}"
|
||||
|
||||
# Images — pin via inventory in production
|
||||
bookstack_image: "lscr.io/linuxserver/bookstack:version-v26.03.3"
|
||||
bookstack_db_image: "lscr.io/linuxserver/mariadb:11.4.9"
|
||||
|
||||
# Traefik configuration
|
||||
bookstack_traefik_network: "proxy"
|
||||
bookstack_traefik_certresolver: "le"
|
||||
|
||||
# Timezone / UID
|
||||
bookstack_tz: "Europe/Zurich"
|
||||
bookstack_puid: "1000"
|
||||
bookstack_pgid: "1000"
|
||||
|
||||
# Database configuration
|
||||
bookstack_db_name: "bookstack"
|
||||
bookstack_db_user: "bookstack"
|
||||
|
||||
# REQUIRED SECRETS — empty defaults force `assert` to fail until set.
|
||||
# Provide via OpenBao lookup, Ansible Vault, or extra-vars.
|
||||
# Never commit real secrets to version control.
|
||||
#
|
||||
# Generate with:
|
||||
# bookstack_db_root_password: openssl rand -base64 32 | tr -d '/+='
|
||||
# bookstack_db_password: openssl rand -base64 32 | tr -d '/+='
|
||||
# bookstack_admin_password: openssl rand -base64 24 | tr -d '/+='
|
||||
bookstack_db_root_password: ""
|
||||
bookstack_db_password: ""
|
||||
bookstack_admin_password: ""
|
||||
bookstack_oidc_client_secret: ""
|
||||
|
||||
# APP_KEY is generated automatically on first run and persisted on the host.
|
||||
# Set explicitly only if restoring an existing instance.
|
||||
bookstack_app_key: ""
|
||||
|
||||
# Initial local admin (fallback account, lives alongside OIDC)
|
||||
bookstack_admin_name: "Admin"
|
||||
bookstack_admin_email: "admin@local.test"
|
||||
bookstack_artisan_path: "/app/www/artisan"
|
||||
|
||||
# Mail configuration
|
||||
bookstack_mail_driver: "smtp"
|
||||
bookstack_mail_host: "smtp.local.test"
|
||||
bookstack_mail_port: 587
|
||||
bookstack_mail_encryption: "tls"
|
||||
bookstack_mail_from: "bookstack@local.test"
|
||||
bookstack_mail_from_name: "BookStack"
|
||||
bookstack_mail_username: ""
|
||||
bookstack_mail_password: ""
|
||||
|
||||
# OIDC configuration (Entra ID by default; override `bookstack_oidc_issuer`
|
||||
# for Keycloak or any other provider)
|
||||
bookstack_oidc_enabled: false
|
||||
bookstack_oidc_name: "SSO"
|
||||
bookstack_entra_tenant_id: ""
|
||||
bookstack_oidc_issuer: "https://login.microsoftonline.com/{{ bookstack_entra_tenant_id }}/v2.0"
|
||||
bookstack_oidc_client_id: ""
|
||||
bookstack_oidc_auto_initiate: false
|
||||
bookstack_oidc_user_to_groups: false
|
||||
bookstack_oidc_groups_claim: "groups"
|
||||
bookstack_oidc_additional_scopes: "openid profile email"
|
||||
|
||||
# Backup configuration
|
||||
bookstack_backup_enabled: true
|
||||
bookstack_backup_retention_days: 14
|
||||
bookstack_backup_schedule: "*-*-* 03:00:00"
|
||||
19
roles/bookstack/handlers/main.yml
Normal file
19
roles/bookstack/handlers/main.yml
Normal file
|
|
@ -0,0 +1,19 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# handlers file for bookstack
|
||||
|
||||
- name: stop bookstack
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ bookstack_docker_compose_dir }}"
|
||||
state: stopped
|
||||
listen: restart bookstack
|
||||
|
||||
- name: start bookstack
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ bookstack_docker_compose_dir }}"
|
||||
state: present
|
||||
listen: restart bookstack
|
||||
|
||||
- name: reload systemd
|
||||
ansible.builtin.systemd:
|
||||
daemon_reload: true
|
||||
212
roles/bookstack/meta/argument_specs.yml
Normal file
212
roles/bookstack/meta/argument_specs.yml
Normal file
|
|
@ -0,0 +1,212 @@
|
|||
---
|
||||
argument_specs:
|
||||
main:
|
||||
short_description: Deploy BookStack (LSIO image + MariaDB) via Docker Compose.
|
||||
description:
|
||||
- Renders a Compose stack for the linuxserver.io BookStack image
|
||||
with a sibling MariaDB container behind Traefik, then bootstraps
|
||||
the initial admin user via C(php artisan bookstack:create-admin)
|
||||
and optionally enables OIDC SSO (Entra ID by default).
|
||||
- "Persists the Laravel C(APP_KEY) on the host so the same key is
|
||||
re-used across deploys (a fresh key would orphan all encrypted
|
||||
database values: 2FA secrets, API tokens, OIDC client_secret)."
|
||||
- Ships an optional systemd timer that backs up the database dump,
|
||||
uploads tarball and APP_KEY daily with configurable retention.
|
||||
options:
|
||||
docker_compose_base_dir:
|
||||
type: path
|
||||
default: /etc/docker/compose
|
||||
docker_volume_base_dir:
|
||||
type: path
|
||||
default: /srv/data
|
||||
bookstack_service_name:
|
||||
type: str
|
||||
default: bookstack
|
||||
bookstack_docker_compose_dir:
|
||||
type: path
|
||||
bookstack_docker_volume_dir:
|
||||
type: path
|
||||
bookstack_appdata_dir:
|
||||
type: path
|
||||
bookstack_db_data_dir:
|
||||
type: path
|
||||
bookstack_backup_dir:
|
||||
type: path
|
||||
|
||||
bookstack_domain:
|
||||
type: str
|
||||
default: wiki.local.test
|
||||
description: Hostname used in the Traefik Host rule.
|
||||
bookstack_extra_domains:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
description:
|
||||
- Additional hostnames the Traefik router answers on, OR-combined
|
||||
with C(bookstack_domain). Useful for an internal C(*.int.*) FQDN
|
||||
so a DMZ reverseproxy can reach a backend hostname covered by the
|
||||
cert.
|
||||
bookstack_extra_hosts:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
description:
|
||||
- Container-level C(/etc/hosts) overrides (Compose C(extra_hosts)
|
||||
entries, C("host:ip")). Useful in split-horizon setups where the
|
||||
BookStack container must reach an IdP's public FQDN (used in the
|
||||
OIDC C(iss) claim) over the LAN rather than via the DMZ.
|
||||
bookstack_base_url:
|
||||
type: str
|
||||
description: Defaults to C("https://{{ bookstack_domain }}").
|
||||
|
||||
bookstack_image:
|
||||
type: str
|
||||
default: "lscr.io/linuxserver/bookstack:version-v26.03.3"
|
||||
bookstack_db_image:
|
||||
type: str
|
||||
default: "lscr.io/linuxserver/mariadb:11.4.9"
|
||||
|
||||
bookstack_traefik_network:
|
||||
type: str
|
||||
default: proxy
|
||||
bookstack_traefik_certresolver:
|
||||
type: str
|
||||
default: le
|
||||
|
||||
bookstack_tz:
|
||||
type: str
|
||||
default: Europe/Zurich
|
||||
bookstack_puid:
|
||||
type: str
|
||||
default: "1000"
|
||||
bookstack_pgid:
|
||||
type: str
|
||||
default: "1000"
|
||||
|
||||
bookstack_db_name:
|
||||
type: str
|
||||
default: bookstack
|
||||
bookstack_db_user:
|
||||
type: str
|
||||
default: bookstack
|
||||
bookstack_db_root_password:
|
||||
type: str
|
||||
required: true
|
||||
description: MariaDB C(root) password. Override per-inventory.
|
||||
bookstack_db_password:
|
||||
type: str
|
||||
required: true
|
||||
description: MariaDB C(bookstack_db_user) password. Override per-inventory.
|
||||
|
||||
bookstack_admin_password:
|
||||
type: str
|
||||
required: true
|
||||
description:
|
||||
- Password for the local admin user that the role creates via
|
||||
C(bookstack:create-admin). Lives alongside any OIDC users.
|
||||
|
||||
bookstack_app_key:
|
||||
type: str
|
||||
default: ''
|
||||
description:
|
||||
- When empty the role generates a persistent C(APP_KEY) on first
|
||||
run and stores it under C({{ bookstack_docker_volume_dir }}/.app_key).
|
||||
Override only when restoring an existing instance — a mismatching
|
||||
key orphans all encrypted database values.
|
||||
|
||||
bookstack_admin_name:
|
||||
type: str
|
||||
default: Admin
|
||||
bookstack_admin_email:
|
||||
type: str
|
||||
default: admin@local.test
|
||||
bookstack_artisan_path:
|
||||
type: path
|
||||
default: /app/www/artisan
|
||||
description:
|
||||
- Path to BookStack's C(artisan) script inside the container. The
|
||||
LSIO image's C(WORKDIR) is not the app directory, so this must
|
||||
be absolute.
|
||||
|
||||
bookstack_mail_driver:
|
||||
type: str
|
||||
choices: [smtp, log, sendmail, mailgun, ses, postmark]
|
||||
default: smtp
|
||||
bookstack_mail_host:
|
||||
type: str
|
||||
default: smtp.local.test
|
||||
bookstack_mail_port:
|
||||
type: int
|
||||
default: 587
|
||||
bookstack_mail_encryption:
|
||||
type: str
|
||||
choices: [tls, ssl, '']
|
||||
default: tls
|
||||
bookstack_mail_from:
|
||||
type: str
|
||||
default: bookstack@local.test
|
||||
bookstack_mail_from_name:
|
||||
type: str
|
||||
default: BookStack
|
||||
bookstack_mail_username:
|
||||
type: str
|
||||
default: ''
|
||||
bookstack_mail_password:
|
||||
type: str
|
||||
default: ''
|
||||
|
||||
bookstack_oidc_enabled:
|
||||
type: bool
|
||||
default: false
|
||||
bookstack_oidc_name:
|
||||
type: str
|
||||
default: SSO
|
||||
description: Display name of the SSO button on the login page.
|
||||
bookstack_entra_tenant_id:
|
||||
type: str
|
||||
default: ''
|
||||
description: Entra tenant UUID. Required when C(bookstack_oidc_enabled=true).
|
||||
bookstack_oidc_issuer:
|
||||
type: str
|
||||
description:
|
||||
- OIDC issuer URL. Defaults to the Entra v2 issuer template
|
||||
built from C(bookstack_entra_tenant_id). Override for
|
||||
Keycloak or any other provider.
|
||||
bookstack_oidc_client_id:
|
||||
type: str
|
||||
default: ''
|
||||
description: Required when C(bookstack_oidc_enabled=true).
|
||||
bookstack_oidc_client_secret:
|
||||
type: str
|
||||
default: ''
|
||||
description: Required when C(bookstack_oidc_enabled=true).
|
||||
bookstack_oidc_auto_initiate:
|
||||
type: bool
|
||||
default: false
|
||||
description:
|
||||
- When true users are redirected straight to the IdP and the
|
||||
local login is reachable only via C(?email_login=1).
|
||||
bookstack_oidc_user_to_groups:
|
||||
type: bool
|
||||
default: false
|
||||
description:
|
||||
- When true BookStack syncs roles from the IdP groups claim
|
||||
on every login. Requires BookStack roles whose
|
||||
C(External Auth ID) matches the IdP group's Object ID.
|
||||
bookstack_oidc_groups_claim:
|
||||
type: str
|
||||
default: groups
|
||||
bookstack_oidc_additional_scopes:
|
||||
type: str
|
||||
default: openid profile email
|
||||
|
||||
bookstack_backup_enabled:
|
||||
type: bool
|
||||
default: true
|
||||
bookstack_backup_retention_days:
|
||||
type: int
|
||||
default: 14
|
||||
bookstack_backup_schedule:
|
||||
type: str
|
||||
default: "*-*-* 03:00:00"
|
||||
description: systemd C(OnCalendar) expression for the backup timer.
|
||||
25
roles/bookstack/meta/main.yml
Normal file
25
roles/bookstack/meta/main.yml
Normal file
|
|
@ -0,0 +1,25 @@
|
|||
galaxy_info:
|
||||
author: digitalboard
|
||||
description: Deploy BookStack as a self-contained Docker Compose stack behind Traefik
|
||||
company: digitalboard
|
||||
license: MIT-0
|
||||
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
galaxy_tags:
|
||||
- docker
|
||||
- bookstack
|
||||
- wiki
|
||||
- documentation
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
229
roles/bookstack/tasks/main.yml
Normal file
229
roles/bookstack/tasks/main.yml
Normal file
|
|
@ -0,0 +1,229 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# tasks file for bookstack
|
||||
|
||||
# =====================================================================
|
||||
# 1. VALIDATE REQUIRED SECRETS
|
||||
# =====================================================================
|
||||
|
||||
- name: Assert required secrets are set
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- bookstack_db_root_password | length > 0
|
||||
- bookstack_db_password | length > 0
|
||||
- bookstack_admin_password | length > 0
|
||||
- (not bookstack_oidc_enabled) or (bookstack_oidc_client_id | length > 0)
|
||||
- (not bookstack_oidc_enabled) or (bookstack_oidc_client_secret | length > 0)
|
||||
# Issuer URL must resolve to something concrete. The Entra default
|
||||
# interpolates bookstack_entra_tenant_id; an unset tenant leaves
|
||||
# "//v2.0" in the URL. Allow non-Entra IdPs (Authentik, Keycloak)
|
||||
# that override bookstack_oidc_issuer directly.
|
||||
- (not bookstack_oidc_enabled) or
|
||||
(bookstack_oidc_issuer | length > 0 and
|
||||
'//v2.0' not in bookstack_oidc_issuer)
|
||||
fail_msg: >-
|
||||
One or more required secrets are unset. Provide them via OpenBao
|
||||
lookup, Ansible Vault or --extra-vars. See README for the full list.
|
||||
quiet: true
|
||||
|
||||
# =====================================================================
|
||||
# 2. PREPARATION: Packages, directories, APP_KEY
|
||||
# =====================================================================
|
||||
|
||||
- name: Ensure required packages are installed
|
||||
ansible.builtin.package:
|
||||
name:
|
||||
- python3-docker
|
||||
- python3-requests
|
||||
state: present
|
||||
|
||||
- name: Create docker compose directory
|
||||
ansible.builtin.file:
|
||||
path: "{{ bookstack_docker_compose_dir }}"
|
||||
state: directory
|
||||
mode: '0755'
|
||||
|
||||
- name: Create BookStack data directories
|
||||
ansible.builtin.file:
|
||||
path: "{{ item }}"
|
||||
state: directory
|
||||
owner: "{{ bookstack_puid }}"
|
||||
group: "{{ bookstack_pgid }}"
|
||||
mode: '0755'
|
||||
loop:
|
||||
- "{{ bookstack_docker_volume_dir }}"
|
||||
- "{{ bookstack_appdata_dir }}"
|
||||
- "{{ bookstack_db_data_dir }}"
|
||||
- "{{ bookstack_backup_dir }}"
|
||||
|
||||
- name: Verify Traefik network exists
|
||||
community.docker.docker_network_info:
|
||||
name: "{{ bookstack_traefik_network }}"
|
||||
register: _traefik_net
|
||||
failed_when: not _traefik_net.exists
|
||||
|
||||
- name: Check whether APP_KEY has been generated before
|
||||
ansible.builtin.stat:
|
||||
path: "{{ bookstack_docker_volume_dir }}/.app_key"
|
||||
register: _app_key_file
|
||||
|
||||
- name: Generate persistent APP_KEY on first run
|
||||
ansible.builtin.shell: |
|
||||
set -o pipefail
|
||||
umask 077
|
||||
echo "base64:$(openssl rand -base64 32)" > {{ bookstack_docker_volume_dir }}/.app_key
|
||||
args:
|
||||
executable: /bin/bash
|
||||
creates: "{{ bookstack_docker_volume_dir }}/.app_key"
|
||||
when:
|
||||
- not _app_key_file.stat.exists
|
||||
- bookstack_app_key | length == 0
|
||||
|
||||
- name: Write inventory-provided APP_KEY
|
||||
ansible.builtin.copy:
|
||||
content: "{{ bookstack_app_key }}\n"
|
||||
dest: "{{ bookstack_docker_volume_dir }}/.app_key"
|
||||
mode: '0600'
|
||||
when:
|
||||
- not _app_key_file.stat.exists
|
||||
- bookstack_app_key | length > 0
|
||||
no_log: true
|
||||
|
||||
- name: Read APP_KEY back into a fact
|
||||
ansible.builtin.slurp:
|
||||
src: "{{ bookstack_docker_volume_dir }}/.app_key"
|
||||
register: _app_key_slurp
|
||||
no_log: true
|
||||
|
||||
- name: Register APP_KEY fact
|
||||
ansible.builtin.set_fact:
|
||||
bookstack_resolved_app_key: "{{ _app_key_slurp.content | b64decode | trim }}"
|
||||
no_log: true
|
||||
|
||||
# =====================================================================
|
||||
# 3. DEPLOY: Render compose, bring stack up
|
||||
# =====================================================================
|
||||
|
||||
- name: Render docker-compose.yml for BookStack
|
||||
ansible.builtin.template:
|
||||
src: docker-compose.yml.j2
|
||||
dest: "{{ bookstack_docker_compose_dir }}/docker-compose.yml"
|
||||
mode: '0640'
|
||||
notify: restart bookstack
|
||||
|
||||
- name: Start BookStack containers
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ bookstack_docker_compose_dir }}"
|
||||
state: present
|
||||
pull: always
|
||||
wait: true
|
||||
|
||||
# =====================================================================
|
||||
# 4. CONFIGURE: Wait for app and seed initial admin user
|
||||
# =====================================================================
|
||||
|
||||
- name: Wait for BookStack to be ready
|
||||
ansible.builtin.command:
|
||||
cmd: docker exec {{ bookstack_service_name }} curl -sf -o /dev/null -w "%{http_code}" http://localhost/login
|
||||
register: _bookstack_health
|
||||
retries: 30
|
||||
delay: 5
|
||||
until: _bookstack_health.stdout == "200"
|
||||
changed_when: false
|
||||
|
||||
- name: Wait for BookStack migrations to be complete
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ bookstack_service_name }}-db"
|
||||
argv:
|
||||
- mariadb
|
||||
- --protocol=tcp
|
||||
- -h
|
||||
- 127.0.0.1
|
||||
- -u
|
||||
- "{{ bookstack_db_user }}"
|
||||
- "-p{{ bookstack_db_password }}"
|
||||
- "{{ bookstack_db_name }}"
|
||||
- -Nse
|
||||
- "SHOW TABLES LIKE 'users';"
|
||||
register: _users_table
|
||||
retries: 30
|
||||
delay: 5
|
||||
until: _users_table.stdout | trim == 'users'
|
||||
changed_when: false
|
||||
no_log: true
|
||||
|
||||
- name: Check whether the initial admin already exists
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ bookstack_service_name }}-db"
|
||||
argv:
|
||||
- mariadb
|
||||
- --protocol=tcp
|
||||
- -h
|
||||
- 127.0.0.1
|
||||
- -u
|
||||
- "{{ bookstack_db_user }}"
|
||||
- "-p{{ bookstack_db_password }}"
|
||||
- "{{ bookstack_db_name }}"
|
||||
- -Nse
|
||||
- "SELECT COUNT(*) FROM users WHERE email = '{{ bookstack_admin_email }}';"
|
||||
register: _admin_exists
|
||||
changed_when: false
|
||||
no_log: true
|
||||
|
||||
- name: Create initial admin user
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ bookstack_service_name }}"
|
||||
argv:
|
||||
- php
|
||||
- "{{ bookstack_artisan_path }}"
|
||||
- bookstack:create-admin
|
||||
- "--email={{ bookstack_admin_email }}"
|
||||
- "--name={{ bookstack_admin_name }}"
|
||||
- "--password={{ bookstack_admin_password }}"
|
||||
when: (_admin_exists.stdout | trim | int) == 0
|
||||
no_log: true
|
||||
|
||||
# =====================================================================
|
||||
# 5. BACKUP: systemd timer for daily DB + uploads dump
|
||||
# =====================================================================
|
||||
|
||||
- name: Render backup script
|
||||
ansible.builtin.template:
|
||||
src: backup.sh.j2
|
||||
dest: /usr/local/bin/bookstack-backup.sh
|
||||
owner: root
|
||||
group: root
|
||||
mode: '0750'
|
||||
when: bookstack_backup_enabled | bool
|
||||
|
||||
- name: Render backup systemd service
|
||||
ansible.builtin.template:
|
||||
src: bookstack-backup.service.j2
|
||||
dest: /etc/systemd/system/bookstack-backup.service
|
||||
mode: '0644'
|
||||
when: bookstack_backup_enabled | bool
|
||||
notify: reload systemd
|
||||
|
||||
- name: Render backup systemd timer
|
||||
ansible.builtin.template:
|
||||
src: bookstack-backup.timer.j2
|
||||
dest: /etc/systemd/system/bookstack-backup.timer
|
||||
mode: '0644'
|
||||
when: bookstack_backup_enabled | bool
|
||||
notify: reload systemd
|
||||
|
||||
- name: Enable and start backup timer
|
||||
ansible.builtin.systemd:
|
||||
name: bookstack-backup.timer
|
||||
enabled: true
|
||||
state: started
|
||||
daemon_reload: true
|
||||
when: bookstack_backup_enabled | bool
|
||||
|
||||
- name: Disable backup timer when feature is off
|
||||
ansible.builtin.systemd:
|
||||
name: bookstack-backup.timer
|
||||
enabled: false
|
||||
state: stopped
|
||||
when: not (bookstack_backup_enabled | bool)
|
||||
failed_when: false
|
||||
41
roles/bookstack/templates/backup.sh.j2
Normal file
41
roles/bookstack/templates/backup.sh.j2
Normal file
|
|
@ -0,0 +1,41 @@
|
|||
#!/bin/bash
|
||||
# {{ ansible_managed }}
|
||||
set -euo pipefail
|
||||
|
||||
BACKUP_DIR="{{ bookstack_backup_dir }}"
|
||||
RETENTION_DAYS={{ bookstack_backup_retention_days }}
|
||||
APPDATA_DIR="{{ bookstack_appdata_dir }}"
|
||||
STAMP="$(date +%Y%m%d-%H%M%S)"
|
||||
|
||||
mkdir -p "$BACKUP_DIR"
|
||||
|
||||
# --- DB dump (mariadb-dump from inside the DB container) ---
|
||||
# Use the app user via TCP because root@localhost is unix_socket-auth only
|
||||
# in the LSIO MariaDB image and root@% does not exist.
|
||||
docker exec {{ bookstack_service_name }}-db \
|
||||
mariadb-dump \
|
||||
--protocol=tcp -h 127.0.0.1 \
|
||||
-u "{{ bookstack_db_user }}" -p"{{ bookstack_db_password }}" \
|
||||
--single-transaction --routines --triggers --quick \
|
||||
"{{ bookstack_db_name }}" \
|
||||
| gzip -9 > "$BACKUP_DIR/bookstack-db-$STAMP.sql.gz"
|
||||
|
||||
# --- File uploads (images, attachments) ---
|
||||
# LSIO BookStack stores user uploads under /config/www/{uploads,storage/uploads,files}.
|
||||
tar --warning=no-file-changed \
|
||||
-czf "$BACKUP_DIR/bookstack-files-$STAMP.tar.gz" \
|
||||
-C "$APPDATA_DIR/www" \
|
||||
uploads storage/uploads files 2>/dev/null || true
|
||||
|
||||
# --- APP_KEY backup (critical for restore!) ---
|
||||
install -m 0600 "{{ bookstack_docker_volume_dir }}/.app_key" \
|
||||
"$BACKUP_DIR/bookstack-appkey-$STAMP.txt"
|
||||
|
||||
# --- Retention ---
|
||||
find "$BACKUP_DIR" -type f \
|
||||
\( -name 'bookstack-db-*.sql.gz' \
|
||||
-o -name 'bookstack-files-*.tar.gz' \
|
||||
-o -name 'bookstack-appkey-*.txt' \) \
|
||||
-mtime +"$RETENTION_DAYS" -delete
|
||||
|
||||
echo "Backup complete: $STAMP"
|
||||
12
roles/bookstack/templates/bookstack-backup.service.j2
Normal file
12
roles/bookstack/templates/bookstack-backup.service.j2
Normal file
|
|
@ -0,0 +1,12 @@
|
|||
# {{ ansible_managed }}
|
||||
[Unit]
|
||||
Description=BookStack backup (DB + uploads)
|
||||
Requires=docker.service
|
||||
After=docker.service
|
||||
|
||||
[Service]
|
||||
Type=oneshot
|
||||
ExecStart=/usr/local/bin/bookstack-backup.sh
|
||||
Nice=10
|
||||
IOSchedulingClass=best-effort
|
||||
IOSchedulingPriority=7
|
||||
11
roles/bookstack/templates/bookstack-backup.timer.j2
Normal file
11
roles/bookstack/templates/bookstack-backup.timer.j2
Normal file
|
|
@ -0,0 +1,11 @@
|
|||
# {{ ansible_managed }}
|
||||
[Unit]
|
||||
Description=Daily BookStack backup
|
||||
|
||||
[Timer]
|
||||
OnCalendar={{ bookstack_backup_schedule }}
|
||||
Persistent=true
|
||||
RandomizedDelaySec=300
|
||||
|
||||
[Install]
|
||||
WantedBy=timers.target
|
||||
93
roles/bookstack/templates/docker-compose.yml.j2
Normal file
93
roles/bookstack/templates/docker-compose.yml.j2
Normal file
|
|
@ -0,0 +1,93 @@
|
|||
#---------------------------------------------------------------------#
|
||||
# BookStack - Self-hosted wiki / knowledge base. #
|
||||
#---------------------------------------------------------------------#
|
||||
---
|
||||
services:
|
||||
{{ bookstack_service_name }}:
|
||||
image: {{ bookstack_image }}
|
||||
container_name: {{ bookstack_service_name }}
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
PUID: "{{ bookstack_puid }}"
|
||||
PGID: "{{ bookstack_pgid }}"
|
||||
TZ: "{{ bookstack_tz }}"
|
||||
APP_URL: "{{ bookstack_base_url }}"
|
||||
APP_KEY: "{{ bookstack_resolved_app_key }}"
|
||||
DB_HOST: "{{ bookstack_service_name }}-db"
|
||||
DB_PORT: "3306"
|
||||
DB_DATABASE: "{{ bookstack_db_name }}"
|
||||
DB_USERNAME: "{{ bookstack_db_user }}"
|
||||
DB_PASSWORD: "{{ bookstack_db_password }}"
|
||||
MAIL_DRIVER: "{{ bookstack_mail_driver }}"
|
||||
MAIL_HOST: "{{ bookstack_mail_host }}"
|
||||
MAIL_PORT: "{{ bookstack_mail_port }}"
|
||||
MAIL_USERNAME: "{{ bookstack_mail_username }}"
|
||||
MAIL_PASSWORD: "{{ bookstack_mail_password }}"
|
||||
MAIL_ENCRYPTION: "{{ bookstack_mail_encryption }}"
|
||||
MAIL_FROM: "{{ bookstack_mail_from }}"
|
||||
MAIL_FROM_NAME: "{{ bookstack_mail_from_name }}"
|
||||
{% if bookstack_oidc_enabled %}
|
||||
AUTH_METHOD: "oidc"
|
||||
AUTH_AUTO_INITIATE: "{{ bookstack_oidc_auto_initiate | string | lower }}"
|
||||
OIDC_NAME: "{{ bookstack_oidc_name }}"
|
||||
OIDC_DISPLAY_NAME_CLAIMS: "name"
|
||||
OIDC_CLIENT_ID: "{{ bookstack_oidc_client_id }}"
|
||||
OIDC_CLIENT_SECRET: "{{ bookstack_oidc_client_secret }}"
|
||||
OIDC_ISSUER: "{{ bookstack_oidc_issuer }}"
|
||||
OIDC_ISSUER_DISCOVER: "true"
|
||||
OIDC_END_SESSION_ENDPOINT: "true"
|
||||
OIDC_ADDITIONAL_SCOPES: "{{ bookstack_oidc_additional_scopes }}"
|
||||
OIDC_USER_TO_GROUPS: "{{ bookstack_oidc_user_to_groups | string | lower }}"
|
||||
OIDC_GROUPS_CLAIM: "{{ bookstack_oidc_groups_claim }}"
|
||||
{% endif %}
|
||||
volumes:
|
||||
- {{ bookstack_appdata_dir }}:/config
|
||||
networks:
|
||||
- {{ bookstack_traefik_network }}
|
||||
- internal
|
||||
{% if bookstack_extra_hosts | length > 0 %}
|
||||
extra_hosts:
|
||||
{% for host in bookstack_extra_hosts %}
|
||||
- "{{ host }}"
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
depends_on:
|
||||
{{ bookstack_service_name }}-db:
|
||||
condition: service_healthy
|
||||
labels:
|
||||
- "traefik.enable=true"
|
||||
- "traefik.docker.network={{ bookstack_traefik_network }}"
|
||||
- "traefik.http.routers.{{ bookstack_service_name }}.rule={% set _all_domains = [bookstack_domain] + (bookstack_extra_domains | default([])) %}{% for d in _all_domains %}Host(`{{ d }}`){% if not loop.last %} || {% endif %}{% endfor +%}"
|
||||
- "traefik.http.routers.{{ bookstack_service_name }}.entrypoints=websecure"
|
||||
- "traefik.http.routers.{{ bookstack_service_name }}.tls=true"
|
||||
- "traefik.http.routers.{{ bookstack_service_name }}.tls.certresolver={{ bookstack_traefik_certresolver }}"
|
||||
- "traefik.http.services.{{ bookstack_service_name }}.loadbalancer.server.port=80"
|
||||
|
||||
{{ bookstack_service_name }}-db:
|
||||
image: {{ bookstack_db_image }}
|
||||
container_name: {{ bookstack_service_name }}-db
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
PUID: "{{ bookstack_puid }}"
|
||||
PGID: "{{ bookstack_pgid }}"
|
||||
TZ: "{{ bookstack_tz }}"
|
||||
MYSQL_ROOT_PASSWORD: "{{ bookstack_db_root_password }}"
|
||||
MYSQL_DATABASE: "{{ bookstack_db_name }}"
|
||||
MYSQL_USER: "{{ bookstack_db_user }}"
|
||||
MYSQL_PASSWORD: "{{ bookstack_db_password }}"
|
||||
volumes:
|
||||
- {{ bookstack_db_data_dir }}:/config
|
||||
networks:
|
||||
- internal
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "mariadb-admin ping -h 127.0.0.1 -u root --password=\"$$MYSQL_ROOT_PASSWORD\" --silent"]
|
||||
interval: 10s
|
||||
timeout: 5s
|
||||
retries: 12
|
||||
start_period: 60s
|
||||
|
||||
networks:
|
||||
{{ bookstack_traefik_network }}:
|
||||
external: true
|
||||
internal:
|
||||
driver: bridge
|
||||
1
roles/bookstack/tests/inventory
Normal file
1
roles/bookstack/tests/inventory
Normal file
|
|
@ -0,0 +1 @@
|
|||
localhost
|
||||
5
roles/bookstack/tests/test.yml
Normal file
5
roles/bookstack/tests/test.yml
Normal file
|
|
@ -0,0 +1,5 @@
|
|||
---
|
||||
- hosts: localhost
|
||||
remote_user: root
|
||||
roles:
|
||||
- bookstack
|
||||
3
roles/bookstack/vars/main.yml
Normal file
3
roles/bookstack/vars/main.yml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# vars file for bookstack
|
||||
|
|
@ -1,38 +1,42 @@
|
|||
Role Name
|
||||
=========
|
||||
# collabora
|
||||
|
||||
A brief description of the role goes here.
|
||||
Deploys [Collabora Online](https://www.collaboraonline.com/) (CODE,
|
||||
`collabora/code`) via Docker Compose behind Traefik. Collabora is the
|
||||
WOPI backend that renders office documents for Nextcloud and OpenCloud.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
The role templates `coolwsd.xml` to declare which WOPI hosts may call
|
||||
Collabora and which origins may embed it in an iframe.
|
||||
|
||||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
||||
## Role variables
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `collabora_domains` | `[office.local.test]` | FQDNs the router accepts; first is canonical. |
|
||||
| `collabora_image` | `collabora/code:latest` | Container image. |
|
||||
| `collabora_port` | `9980` | Container port Traefik forwards to. |
|
||||
| `collabora_traefik_network` | `proxy` | Docker network shared with Traefik. |
|
||||
| `collabora_use_ssl` | `true` | Enable the TLS resolver on the router. |
|
||||
| `collabora_ssl_verification` | `true` | Verify TLS on WOPI callbacks (false for self-signed). |
|
||||
| `collabora_allowed_domains` | `[nextcloud.local.test]` | WOPI hosts allowed to call Collabora (regex). |
|
||||
| `collabora_frame_ancestors` | `[nextcloud.local.test]` | Origins allowed to embed Collabora in an iframe. |
|
||||
| `collabora_extra_hosts` | `[]` | Extra `host:ip` entries for in-container DNS. |
|
||||
|
||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
|
||||
## Example
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
```yaml
|
||||
- hosts: services
|
||||
become: true
|
||||
roles:
|
||||
- role: digitalboard.core.collabora
|
||||
vars:
|
||||
collabora_domains:
|
||||
- "office.example.com"
|
||||
collabora_allowed_domains:
|
||||
- "cloud.example.com"
|
||||
collabora_frame_ancestors:
|
||||
- "cloud.example.com"
|
||||
```
|
||||
|
||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
||||
## License
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
|
||||
- hosts: servers
|
||||
roles:
|
||||
- { role: username.rolename, x: 42 }
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
BSD
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -12,7 +12,11 @@ collabora_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ collabora_servic
|
|||
collabora_docker_volume_dir: "{{ docker_volume_base_dir }}/{{ collabora_service_name }}"
|
||||
|
||||
# Service configuration
|
||||
collabora_domain: "office.local.test"
|
||||
# FQDNs the collabora router accepts. The first entry is the canonical
|
||||
# domain; further entries cover internal *.int.* names used for
|
||||
# server-to-server WOPI discovery.
|
||||
collabora_domains:
|
||||
- "office.local.test"
|
||||
collabora_image: "collabora/code:latest"
|
||||
collabora_port: 9980
|
||||
collabora_extra_hosts: []
|
||||
|
|
|
|||
|
|
@ -5,4 +5,4 @@
|
|||
- name: restart collabora
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ collabora_docker_compose_dir }}"
|
||||
state: restarted
|
||||
state: present
|
||||
|
|
@ -1,35 +1,27 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy Collabora Online (CODE) as a WOPI backend via Docker Compose behind Traefik
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.2
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- collabora
|
||||
- office
|
||||
- wopi
|
||||
- nextcloud
|
||||
- docker
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
|
|
@ -20,11 +20,14 @@ services:
|
|||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network={{ collabora_traefik_network }}
|
||||
- traefik.http.routers.{{ collabora_service_name }}.rule=Host(`{{ collabora_domain }}`)
|
||||
- traefik.http.routers.{{ collabora_service_name }}.rule={% for d in collabora_domains %}Host(`{{ d }}`){% if not loop.last %} || {% endif %}{% endfor +%}
|
||||
- traefik.http.services.{{ collabora_service_name }}.loadbalancer.server.port={{ collabora_port }}
|
||||
{% if collabora_use_ssl %}
|
||||
- traefik.http.routers.{{ collabora_service_name }}.entrypoints=websecure
|
||||
- traefik.http.routers.{{ collabora_service_name }}.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.{{ collabora_service_name }}.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.{{ collabora_service_name }}.entrypoints=web
|
||||
{% endif %}
|
||||
|
|
|
|||
69
roles/coturn/README.md
Normal file
69
roles/coturn/README.md
Normal file
|
|
@ -0,0 +1,69 @@
|
|||
# coturn
|
||||
|
||||
Deploys a [coturn](https://github.com/coturn/coturn) TURN/STUN server with `network_mode: host`,
|
||||
optionally accompanied by an `acme.sh` sidecar that obtains and renews a public TLS certificate
|
||||
via RFC2136 (`nsupdate`) and restarts coturn on renewal.
|
||||
|
||||
This is the recommended pairing for `digitalboard.core.talk` (Nextcloud Talk HPB).
|
||||
|
||||
## What it does
|
||||
|
||||
- Renders `/etc/docker/compose/coturn/docker-compose.yml`
|
||||
- (acme mode) Deploys the TSIG key from `playbooks/secrets/{{ inventory_hostname }}/nsupdate.key`
|
||||
- (selfsigned mode) Generates an ECC keypair + selfsigned cert in `{{ coturn_cert_dir }}`
|
||||
- Starts the stack via `community.docker.docker_compose_v2`
|
||||
|
||||
## Required variables
|
||||
|
||||
| Variable | Description |
|
||||
|---|---|
|
||||
| `coturn_realm` | Public DNS name used as realm + cert CN (e.g. `stun.digitalboard.ch`) |
|
||||
| `coturn_external_ip` | Mapping for `--external-ip`, format `PUBLIC[/PRIVATE]` |
|
||||
| `coturn_static_auth_secret` | Shared secret for HMAC-based credentials; **must match** `talk_turn_secret` on the HPB host |
|
||||
|
||||
## Important variables
|
||||
|
||||
| Variable | Default | Description |
|
||||
|---|---|---|
|
||||
| `coturn_cert_mode` | `file` | One of `acme`, `file`, `selfsigned` |
|
||||
| `coturn_listening_port` | `443` | TCP/UDP non-TLS port |
|
||||
| `coturn_tls_listening_port` | `443` | TLS port (shared with non-TLS via STUN mux) |
|
||||
| `coturn_min_relay_port` / `coturn_max_relay_port` | `49160` / `49200` | UDP relay range |
|
||||
| `coturn_internal_realm` | `""` | Optional second SAN for split-horizon DNS |
|
||||
| `coturn_image` | `coturn/coturn:4.6.2-r5-alpine` | Pinned by default; override as needed |
|
||||
|
||||
## ACME / nsupdate mode
|
||||
|
||||
When `coturn_cert_mode: acme` is set, also configure:
|
||||
|
||||
```yaml
|
||||
coturn_acme_email: "admin@digitalboard.ch"
|
||||
coturn_acme_nsupdate_server: "ns1.digitalboard.ch"
|
||||
coturn_acme_nsupdate_server_ip: "172.16.9.169" # optional pin
|
||||
coturn_acme_nsupdate_zone: "digitalboard._acme.digitalboard.ch"
|
||||
# optional: override the auto-built challenge alias mapping
|
||||
coturn_acme_challenge_aliases:
|
||||
- name: stun.digitalboard.ch
|
||||
alias: stun.digitalboard._acme.digitalboard.ch
|
||||
- name: stun.int.digitalboard.ch
|
||||
alias: stun.int.digitalboard._acme.digitalboard.ch
|
||||
```
|
||||
|
||||
Place your TSIG key at `playbooks/secrets/{{ inventory_hostname }}/nsupdate.key` (mode 0600).
|
||||
|
||||
## Secrets
|
||||
|
||||
Place the static auth secret at:
|
||||
|
||||
```
|
||||
playbooks/secrets/{{ inventory_hostname }}/coturn_static_auth_secret
|
||||
```
|
||||
|
||||
Mode 0600. The same value must be deployed to the HPB host as `talk_turn_secret`.
|
||||
|
||||
## Firewall
|
||||
|
||||
The role does not manage firewall rules. Ensure the host has:
|
||||
|
||||
- `443/tcp` and `443/udp` reachable from the internet
|
||||
- UDP `{{ coturn_min_relay_port }}-{{ coturn_max_relay_port }}` reachable from the internet
|
||||
77
roles/coturn/defaults/main.yml
Normal file
77
roles/coturn/defaults/main.yml
Normal file
|
|
@ -0,0 +1,77 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# defaults file for coturn
|
||||
|
||||
# Base directories (inherited from base role)
|
||||
docker_compose_base_dir: /etc/docker/compose
|
||||
docker_volume_base_dir: /srv/data
|
||||
|
||||
# Service-specific paths
|
||||
coturn_service_name: coturn
|
||||
coturn_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ coturn_service_name }}"
|
||||
coturn_docker_volume_dir: "{{ docker_volume_base_dir }}/{{ coturn_service_name }}"
|
||||
|
||||
# Container images (pin per host_vars in production)
|
||||
coturn_image: "coturn/coturn:4.6.2-r5-alpine"
|
||||
coturn_acme_image: "neilpang/acme.sh:3.1.0"
|
||||
|
||||
# Public DNS name used for the realm and the public certificate
|
||||
coturn_realm: "stun.example.test"
|
||||
# Optional second DNS name issued on the same certificate (for split-horizon "internal" name)
|
||||
coturn_internal_realm: "" # e.g. "stun.int.example.test"
|
||||
|
||||
# Ports
|
||||
# Defaults follow IANA standards (3478/TURN, 5349/TURNS) so coturn can
|
||||
# co-exist with a Traefik instance on the same host. Override to 443/443
|
||||
# in restrictive-network environments where punching through firewalls matters.
|
||||
coturn_listening_port: 3478 # TURN / STUN (TCP+UDP)
|
||||
coturn_tls_listening_port: 5349 # TURNS (TCP+UDP)
|
||||
coturn_min_relay_port: 49160
|
||||
coturn_max_relay_port: 49200
|
||||
|
||||
# IP advertisement: must be set in host_vars for production
|
||||
# Format follows coturn's --external-ip: "PUBLIC_IP" or "PUBLIC_IP/PRIVATE_IP"
|
||||
coturn_external_ip: "" # e.g. "203.0.113.10/172.18.0.2"
|
||||
coturn_listening_ip: "0.0.0.0"
|
||||
|
||||
# Shared secret used by HPB to mint short-lived TURN credentials.
|
||||
# Loaded by default from a plain file in playbooks/secrets/{host}/coturn_static_auth_secret
|
||||
# Override per host_vars if you want to use a vault or different lookup.
|
||||
coturn_static_auth_secret: "{{ lookup('file', playbook_dir ~ '/secrets/' ~ inventory_hostname ~ '/coturn_static_auth_secret') }}"
|
||||
|
||||
# Additional CLI flags (list of strings, appended verbatim to command:)
|
||||
coturn_extra_args: []
|
||||
|
||||
# --- TLS certificate ---
|
||||
# 'acme' : run an acme.sh sidecar that issues + renews via RFC2136 / nsupdate, restarts coturn
|
||||
# 'file' : assume a certificate already lives at {{ coturn_cert_dir }}/{{ coturn_cert_file }} on the host (you manage it)
|
||||
# 'selfsigned' : generate a selfsigned cert on first run (for vagrant/dev only)
|
||||
coturn_cert_mode: "file"
|
||||
|
||||
coturn_cert_dir: "{{ docker_volume_base_dir }}/acme/certs"
|
||||
coturn_cert_file: "fullchain.cer"
|
||||
coturn_key_file: "{{ coturn_realm }}.key"
|
||||
|
||||
# --- acme.sh sidecar (only used when coturn_cert_mode == 'acme') ---
|
||||
coturn_acme_email: "admin@example.test"
|
||||
coturn_acme_directory: "https://acme-v02.api.letsencrypt.org/directory"
|
||||
# Stage URL for testing: "https://acme-staging-v02.api.letsencrypt.org/directory"
|
||||
coturn_acme_keylength: "ec-256"
|
||||
coturn_acme_dnssleep: 60
|
||||
coturn_acme_data_dir: "{{ docker_volume_base_dir }}/acme/acme"
|
||||
|
||||
# DNS-01 RFC2136 / nsupdate configuration
|
||||
coturn_acme_nsupdate_server: "" # e.g. "ns1.example.test"
|
||||
coturn_acme_nsupdate_server_ip: "" # optional extra_hosts pin (string IP) for the server
|
||||
coturn_acme_nsupdate_zone: "" # e.g. "example._acme.example.test"
|
||||
# Per-name challenge alias zones (one entry per SAN)
|
||||
# When empty (default), built automatically as "{{ realm }}._acme.{{ zone-tail }}"
|
||||
coturn_acme_challenge_aliases: []
|
||||
# Example:
|
||||
# - name: stun.example.test
|
||||
# alias: stun.example._acme.example.test
|
||||
# - name: stun.int.example.test
|
||||
# alias: stun.int.example._acme.example.test
|
||||
|
||||
# Path of the TSIG key file inside the container (mounted from secrets)
|
||||
coturn_acme_nsupdate_key_src: "{{ playbook_dir }}/secrets/{{ inventory_hostname }}/nsupdate.key"
|
||||
10
roles/coturn/handlers/main.yml
Normal file
10
roles/coturn/handlers/main.yml
Normal file
|
|
@ -0,0 +1,10 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# handlers file for coturn
|
||||
|
||||
- name: Restart coturn container
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ coturn_docker_compose_dir }}"
|
||||
state: restarted
|
||||
services:
|
||||
- coturn
|
||||
148
roles/coturn/meta/argument_specs.yml
Normal file
148
roles/coturn/meta/argument_specs.yml
Normal file
|
|
@ -0,0 +1,148 @@
|
|||
---
|
||||
argument_specs:
|
||||
main:
|
||||
short_description: Deploy a coturn TURN/STUN server with optional acme.sh sidecar.
|
||||
description:
|
||||
- "Renders a Docker Compose stack for coturn running in
|
||||
C(network_mode: host), with an optional C(acme.sh) sidecar that
|
||||
issues + renews a public TLS certificate via RFC2136 / nsupdate
|
||||
and restarts coturn on renewal."
|
||||
- Designed to be paired with the C(digitalboard.core.talk) role
|
||||
(Nextcloud Talk High Performance Backend).
|
||||
options:
|
||||
docker_compose_base_dir:
|
||||
type: path
|
||||
default: /etc/docker/compose
|
||||
docker_volume_base_dir:
|
||||
type: path
|
||||
default: /srv/data
|
||||
coturn_service_name:
|
||||
type: str
|
||||
default: coturn
|
||||
coturn_docker_compose_dir:
|
||||
type: path
|
||||
coturn_docker_volume_dir:
|
||||
type: path
|
||||
|
||||
coturn_image:
|
||||
type: str
|
||||
default: "coturn/coturn:4.6.2-r5-alpine"
|
||||
coturn_acme_image:
|
||||
type: str
|
||||
default: "neilpang/acme.sh:3.1.0"
|
||||
|
||||
coturn_realm:
|
||||
type: str
|
||||
default: stun.example.test
|
||||
description: Public DNS name used for the TURN realm and the public certificate.
|
||||
coturn_internal_realm:
|
||||
type: str
|
||||
default: ''
|
||||
description:
|
||||
- Optional second DNS name issued on the same certificate, used for
|
||||
split-horizon internal access (e.g. C(stun.int.example.test)).
|
||||
|
||||
coturn_listening_port:
|
||||
type: int
|
||||
default: 3478
|
||||
description: TURN/STUN port (TCP + UDP). IANA standard is 3478.
|
||||
coturn_tls_listening_port:
|
||||
type: int
|
||||
default: 5349
|
||||
description: TURNS port (TCP + UDP). IANA standard is 5349.
|
||||
coturn_min_relay_port:
|
||||
type: int
|
||||
default: 49160
|
||||
coturn_max_relay_port:
|
||||
type: int
|
||||
default: 49200
|
||||
|
||||
coturn_external_ip:
|
||||
type: str
|
||||
default: ''
|
||||
description:
|
||||
- coturn C(--external-ip) value. Format C("PUBLIC_IP") or
|
||||
C("PUBLIC_IP/PRIVATE_IP"). Must be set in host_vars for production.
|
||||
coturn_listening_ip:
|
||||
type: str
|
||||
default: '0.0.0.0'
|
||||
|
||||
coturn_static_auth_secret:
|
||||
type: str
|
||||
required: true
|
||||
description:
|
||||
- Shared secret used by the HPB signaling server to mint short-lived
|
||||
TURN credentials. Default lookup reads
|
||||
C(playbooks/secrets/<host>/coturn_static_auth_secret).
|
||||
|
||||
coturn_extra_args:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
description: Additional CLI flags appended verbatim to the container C(command:).
|
||||
|
||||
coturn_cert_mode:
|
||||
type: str
|
||||
choices: [acme, file, selfsigned]
|
||||
default: file
|
||||
description:
|
||||
- C(acme) runs an acme.sh sidecar that issues + renews via RFC2136
|
||||
and restarts coturn. C(file) assumes a certificate already lives
|
||||
on the host (you manage it). C(selfsigned) generates one on first
|
||||
run (vagrant/dev only).
|
||||
coturn_cert_dir:
|
||||
type: path
|
||||
coturn_cert_file:
|
||||
type: str
|
||||
default: fullchain.cer
|
||||
coturn_key_file:
|
||||
type: str
|
||||
description: Defaults to C("{{ coturn_realm }}.key").
|
||||
|
||||
coturn_acme_email:
|
||||
type: str
|
||||
default: admin@example.test
|
||||
coturn_acme_directory:
|
||||
type: str
|
||||
default: https://acme-v02.api.letsencrypt.org/directory
|
||||
coturn_acme_keylength:
|
||||
type: str
|
||||
default: ec-256
|
||||
choices: [ec-256, ec-384, '2048', '3072', '4096']
|
||||
coturn_acme_dnssleep:
|
||||
type: int
|
||||
default: 60
|
||||
coturn_acme_data_dir:
|
||||
type: path
|
||||
|
||||
coturn_acme_nsupdate_server:
|
||||
type: str
|
||||
default: ''
|
||||
description: Authoritative nameserver acme.sh sends C(nsupdate) packets to.
|
||||
coturn_acme_nsupdate_server_ip:
|
||||
type: str
|
||||
default: ''
|
||||
description: Optional C(extra_hosts) pin (string IP) for the nsupdate server.
|
||||
coturn_acme_nsupdate_zone:
|
||||
type: str
|
||||
default: ''
|
||||
description: Delegated challenge zone (e.g. C(example._acme.example.test)).
|
||||
coturn_acme_challenge_aliases:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
description:
|
||||
- Per-name challenge alias zones (one entry per SAN). When empty,
|
||||
built automatically as C({{ realm }}._acme.{{ zone-tail }}).
|
||||
options:
|
||||
name:
|
||||
type: str
|
||||
required: true
|
||||
description: SAN the challenge is for.
|
||||
alias:
|
||||
type: str
|
||||
required: true
|
||||
description: CNAME target where the C(_acme-challenge) TXT lives.
|
||||
coturn_acme_nsupdate_key_src:
|
||||
type: path
|
||||
description: Path of the TSIG key file on the controller, mounted into the acme container.
|
||||
15
roles/coturn/meta/main.yml
Normal file
15
roles/coturn/meta/main.yml
Normal file
|
|
@ -0,0 +1,15 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: Digital Board Team
|
||||
description: Deploy a coturn TURN/STUN server with optional acme.sh sidecar (RFC2136/nsupdate)
|
||||
company: digitalboard.ch
|
||||
license: GPL-2.0-or-later
|
||||
min_ansible_version: "2.14"
|
||||
galaxy_tags:
|
||||
- turn
|
||||
- stun
|
||||
- coturn
|
||||
- webrtc
|
||||
- nextcloud
|
||||
- talk
|
||||
dependencies: []
|
||||
110
roles/coturn/tasks/main.yml
Normal file
110
roles/coturn/tasks/main.yml
Normal file
|
|
@ -0,0 +1,110 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# tasks file for coturn
|
||||
|
||||
- name: Assert minimum configuration
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- coturn_realm | length > 0
|
||||
- coturn_external_ip | length > 0
|
||||
- coturn_static_auth_secret | length > 0
|
||||
fail_msg: >
|
||||
coturn_realm, coturn_external_ip and coturn_static_auth_secret must be set.
|
||||
Provide them in host_vars or via a secrets file.
|
||||
|
||||
- name: Create coturn compose directory
|
||||
ansible.builtin.file:
|
||||
path: "{{ coturn_docker_compose_dir }}"
|
||||
state: directory
|
||||
mode: "0755"
|
||||
|
||||
- name: Create coturn data directory
|
||||
ansible.builtin.file:
|
||||
path: "{{ coturn_docker_volume_dir }}"
|
||||
state: directory
|
||||
mode: "0755"
|
||||
|
||||
- name: Create certificate directory
|
||||
ansible.builtin.file:
|
||||
path: "{{ coturn_cert_dir }}"
|
||||
state: directory
|
||||
mode: "0755"
|
||||
|
||||
# --- TLS certificate provisioning -------------------------------------------------
|
||||
|
||||
- name: Configure acme.sh sidecar (TSIG key + acme data dir)
|
||||
when: coturn_cert_mode == 'acme'
|
||||
block:
|
||||
- name: Create acme.sh data directory
|
||||
ansible.builtin.file:
|
||||
path: "{{ coturn_acme_data_dir }}"
|
||||
state: directory
|
||||
mode: "0700"
|
||||
|
||||
- name: Deploy nsupdate TSIG key
|
||||
ansible.builtin.copy:
|
||||
src: "{{ coturn_acme_nsupdate_key_src }}"
|
||||
dest: "{{ coturn_docker_compose_dir }}/nsupdate.key"
|
||||
mode: "0600"
|
||||
no_log: true
|
||||
notify: Restart coturn container
|
||||
|
||||
- name: Build effective challenge alias list (default if not provided)
|
||||
ansible.builtin.set_fact:
|
||||
_coturn_challenge_aliases: >-
|
||||
{{ coturn_acme_challenge_aliases
|
||||
if coturn_acme_challenge_aliases | length > 0
|
||||
else (
|
||||
[{'name': coturn_realm,
|
||||
'alias': (coturn_realm.split('.')[:-2] | join('.')) ~ '.' ~ coturn_acme_nsupdate_zone }]
|
||||
+ ([{'name': coturn_internal_realm,
|
||||
'alias': (coturn_internal_realm.split('.')[:-2] | join('.')) ~ '.' ~ coturn_acme_nsupdate_zone }]
|
||||
if coturn_internal_realm | length > 0 else [])
|
||||
)
|
||||
}}
|
||||
|
||||
- name: Generate selfsigned certificate (vagrant / dev only)
|
||||
when: coturn_cert_mode == 'selfsigned'
|
||||
block:
|
||||
- name: Ensure openssl is available
|
||||
ansible.builtin.package:
|
||||
name: openssl
|
||||
state: present
|
||||
|
||||
- name: Generate selfsigned private key
|
||||
community.crypto.openssl_privatekey:
|
||||
path: "{{ coturn_cert_dir }}/{{ coturn_key_file }}"
|
||||
type: ECC
|
||||
curve: secp256r1
|
||||
mode: "0600"
|
||||
|
||||
- name: Generate selfsigned CSR
|
||||
community.crypto.openssl_csr:
|
||||
path: "{{ coturn_cert_dir }}/{{ coturn_realm }}.csr"
|
||||
privatekey_path: "{{ coturn_cert_dir }}/{{ coturn_key_file }}"
|
||||
common_name: "{{ coturn_realm }}"
|
||||
subject_alt_name:
|
||||
- "DNS:{{ coturn_realm }}"
|
||||
mode: "0644"
|
||||
|
||||
- name: Issue selfsigned certificate
|
||||
community.crypto.x509_certificate:
|
||||
path: "{{ coturn_cert_dir }}/{{ coturn_cert_file }}"
|
||||
privatekey_path: "{{ coturn_cert_dir }}/{{ coturn_key_file }}"
|
||||
csr_path: "{{ coturn_cert_dir }}/{{ coturn_realm }}.csr"
|
||||
provider: selfsigned
|
||||
mode: "0644"
|
||||
|
||||
# --- Compose + start --------------------------------------------------------------
|
||||
|
||||
- name: Generate docker-compose.yml for coturn
|
||||
ansible.builtin.template:
|
||||
src: docker-compose.yml.j2
|
||||
dest: "{{ coturn_docker_compose_dir }}/docker-compose.yml"
|
||||
mode: "0644"
|
||||
notify: Restart coturn container
|
||||
|
||||
- name: Start coturn stack
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ coturn_docker_compose_dir }}"
|
||||
state: present
|
||||
78
roles/coturn/templates/docker-compose.yml.j2
Normal file
78
roles/coturn/templates/docker-compose.yml.j2
Normal file
|
|
@ -0,0 +1,78 @@
|
|||
services:
|
||||
coturn:
|
||||
image: {{ coturn_image }}
|
||||
container_name: {{ coturn_service_name }}
|
||||
restart: always
|
||||
network_mode: host
|
||||
volumes:
|
||||
- {{ coturn_cert_dir }}:/certs:ro
|
||||
command:
|
||||
- --use-auth-secret
|
||||
- --static-auth-secret={{ coturn_static_auth_secret }}
|
||||
- --realm={{ coturn_realm }}
|
||||
- --fingerprint
|
||||
- --no-multicast-peers
|
||||
- --no-cli
|
||||
- --listening-ip={{ coturn_listening_ip }}
|
||||
- --listening-port={{ coturn_listening_port }}
|
||||
- --tls-listening-port={{ coturn_tls_listening_port }}
|
||||
- --min-port={{ coturn_min_relay_port }}
|
||||
- --max-port={{ coturn_max_relay_port }}
|
||||
- --cert=/certs/{{ coturn_cert_file }}
|
||||
- --pkey=/certs/{{ coturn_key_file }}
|
||||
- --external-ip={{ coturn_external_ip }}
|
||||
{% for arg in coturn_extra_args %}
|
||||
- {{ arg }}
|
||||
{% endfor %}
|
||||
|
||||
{% if coturn_cert_mode == 'acme' %}
|
||||
acme:
|
||||
image: {{ coturn_acme_image }}
|
||||
container_name: acme-{{ coturn_service_name }}
|
||||
restart: always
|
||||
environment:
|
||||
NSUPDATE_SERVER: "{{ coturn_acme_nsupdate_server }}"
|
||||
NSUPDATE_KEY: "/acme.sh/nsupdate.key"
|
||||
ACME_DIRECTORY: "{{ coturn_acme_directory }}"
|
||||
NSUPDATE_ZONE: "{{ coturn_acme_nsupdate_zone }}"
|
||||
{% if coturn_acme_nsupdate_server_ip | length > 0 %}
|
||||
extra_hosts:
|
||||
- "{{ coturn_acme_nsupdate_server }}:{{ coturn_acme_nsupdate_server_ip }}"
|
||||
{% endif %}
|
||||
volumes:
|
||||
- {{ coturn_cert_dir }}:/certs
|
||||
- /var/run/docker.sock:/var/run/docker.sock
|
||||
- {{ coturn_docker_compose_dir }}/nsupdate.key:/acme.sh/nsupdate.key:ro
|
||||
- {{ coturn_acme_data_dir }}:/acme.sh
|
||||
entrypoint:
|
||||
- /bin/sh
|
||||
- -c
|
||||
- |
|
||||
set -eu
|
||||
acme.sh --set-default-ca --server "$$ACME_DIRECTORY"
|
||||
acme.sh --register-account -m {{ coturn_acme_email }} || true
|
||||
set +e
|
||||
acme.sh --issue \
|
||||
{% for san in _coturn_challenge_aliases %}
|
||||
-d {{ san.name }} \
|
||||
--challenge-alias {{ san.alias }} \
|
||||
{% endfor %}
|
||||
--dns dns_nsupdate \
|
||||
--keylength {{ coturn_acme_keylength }} \
|
||||
--dnssleep {{ coturn_acme_dnssleep }}
|
||||
rc=$$?
|
||||
set -e
|
||||
if [ "$$rc" -eq 0 ]; then
|
||||
echo "Issue: success"
|
||||
elif [ "$$rc" -eq 2 ]; then
|
||||
echo "Issue: not due, continuing"
|
||||
else
|
||||
echo "Issue: failed with rc=$$rc"
|
||||
exit "$$rc"
|
||||
fi
|
||||
acme.sh --install-cert -d {{ coturn_realm }} --ecc \
|
||||
--fullchain-file /certs/{{ coturn_cert_file }} \
|
||||
--key-file /certs/{{ coturn_key_file }} \
|
||||
--reloadcmd 'curl --fail --silent --show-error --unix-socket /var/run/docker.sock -X POST http://localhost/v1.41/containers/{{ coturn_service_name }}/restart' || true
|
||||
exec crond -f
|
||||
{% endif %}
|
||||
2
roles/coturn/tests/inventory
Normal file
2
roles/coturn/tests/inventory
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
localhost
|
||||
6
roles/coturn/tests/tests.yml
Normal file
6
roles/coturn/tests/tests.yml
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
- hosts: localhost
|
||||
remote_user: root
|
||||
roles:
|
||||
- coturn
|
||||
3
roles/coturn/vars/main.yml
Normal file
3
roles/coturn/vars/main.yml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# vars file for coturn
|
||||
|
|
@ -1,38 +1,60 @@
|
|||
Role Name
|
||||
=========
|
||||
# Drawio
|
||||
|
||||
A brief description of the role goes here.
|
||||
Ansible role to deploy [draw.io](https://www.drawio.com/) (the
|
||||
self-hosted `jgraph/drawio` container) via Docker Compose behind
|
||||
Traefik, with optional authentik ForwardAuth gating.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
## Requirements
|
||||
|
||||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
||||
- Docker and Docker Compose installed on the target host
|
||||
- Ansible collection: `community.docker`
|
||||
- Traefik with a shared `drawio_traefik_network` (default `proxy`)
|
||||
- For ForwardAuth: a reachable authentik embedded outpost endpoint
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
## Role variables
|
||||
|
||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
|
||||
Full spec with types and defaults: `meta/argument_specs.yml`. The most
|
||||
common overrides:
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
### Service
|
||||
|
||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
||||
- `drawio_domain`: canonical hostname used in the traefik Host rule
|
||||
(default `drawio.local.test`).
|
||||
- `drawio_extra_domains`: additional hostnames the same container
|
||||
should answer on (e.g. an internal `*.int.*` FQDN so a DMZ proxy
|
||||
can reach drawio via a backend hostname).
|
||||
- `drawio_image`, `drawio_port`, `drawio_use_ssl`.
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
### Authentik ForwardAuth
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
- `drawio_authentik_forward_auth`: set to `true` to gate the editor
|
||||
behind authentik.
|
||||
- `drawio_authentik_forward_auth_url`: full URL of the embedded
|
||||
outpost ForwardAuth endpoint, e.g.
|
||||
`https://auth.example.com/outpost.goauthentik.io/auth/traefik`.
|
||||
|
||||
- hosts: servers
|
||||
roles:
|
||||
- { role: username.rolename, x: 42 }
|
||||
When enabled, traefik redirects unauthenticated requests to authentik
|
||||
for login and forwards the resulting `X-Authentik-*` identity headers
|
||||
downstream.
|
||||
|
||||
License
|
||||
-------
|
||||
## Dependencies
|
||||
|
||||
BSD
|
||||
- Traefik network (`drawio_traefik_network`, default `proxy`)
|
||||
- Optional: authentik with a Proxy/ForwardAuth provider for drawio
|
||||
(see the `authentik` role's `authentik_proxy_apps`).
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
## Example playbook
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
||||
```yaml
|
||||
- hosts: app_servers
|
||||
roles:
|
||||
- role: digitalboard.core.drawio
|
||||
vars:
|
||||
drawio_domain: "drawio.example.com"
|
||||
drawio_authentik_forward_auth: true
|
||||
drawio_authentik_forward_auth_url: "https://auth.example.com/outpost.goauthentik.io/auth/traefik"
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -11,10 +11,21 @@ drawio_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ drawio_service_name
|
|||
|
||||
# Service configuration
|
||||
drawio_domain: "drawio.local.test"
|
||||
# Additional hostnames the same drawio container should answer on
|
||||
# (e.g. an internal *.int.* FQDN so a DMZ reverseproxy can reach
|
||||
# drawio via a backend hostname covered by the local traefik cert).
|
||||
drawio_extra_domains: []
|
||||
drawio_image: "jgraph/drawio:latest"
|
||||
drawio_port: 8080
|
||||
drawio_extra_hosts: []
|
||||
|
||||
# Traefik configuration
|
||||
drawio_traefik_network: "proxy"
|
||||
drawio_use_ssl: true
|
||||
drawio_use_ssl: true
|
||||
|
||||
# Optional Authentik ForwardAuth (set to true and provide the URL to gate
|
||||
# drawio behind an authentik proxy provider). Expects the authentik
|
||||
# embedded outpost to expose the /outpost.goauthentik.io/auth/traefik
|
||||
# endpoint on the configured URL (typically the public auth.* FQDN).
|
||||
drawio_authentik_forward_auth: false
|
||||
drawio_authentik_forward_auth_url: ""
|
||||
|
|
@ -5,4 +5,4 @@
|
|||
- name: restart drawio
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ drawio_docker_compose_dir }}"
|
||||
state: restarted
|
||||
state: present
|
||||
64
roles/drawio/meta/argument_specs.yml
Normal file
64
roles/drawio/meta/argument_specs.yml
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
---
|
||||
argument_specs:
|
||||
main:
|
||||
short_description: Deploy draw.io diagram editor via Docker Compose behind Traefik.
|
||||
description:
|
||||
- Renders a Compose stack for jgraph/drawio with traefik labels, optional
|
||||
TLS and optional authentik ForwardAuth gating.
|
||||
options:
|
||||
docker_compose_base_dir:
|
||||
type: path
|
||||
default: /etc/docker/compose
|
||||
drawio_service_name:
|
||||
type: str
|
||||
default: drawio
|
||||
drawio_docker_compose_dir:
|
||||
type: path
|
||||
description: Defaults to C({{ docker_compose_base_dir }}/{{ drawio_service_name }}).
|
||||
|
||||
drawio_domain:
|
||||
type: str
|
||||
default: drawio.local.test
|
||||
description: Canonical hostname used in the traefik Host rule.
|
||||
drawio_extra_domains:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
description:
|
||||
- Additional hostnames the same drawio container should answer on,
|
||||
e.g. an internal C(*.int.*) FQDN so a DMZ reverse-proxy can reach
|
||||
drawio via a backend hostname covered by the local traefik cert.
|
||||
drawio_image:
|
||||
type: str
|
||||
default: jgraph/drawio:latest
|
||||
drawio_port:
|
||||
type: int
|
||||
default: 8080
|
||||
drawio_extra_hosts:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
description: C(extra_hosts) entries injected into the container (Docker C(host:ip) syntax).
|
||||
|
||||
drawio_traefik_network:
|
||||
type: str
|
||||
default: proxy
|
||||
drawio_use_ssl:
|
||||
type: bool
|
||||
default: true
|
||||
|
||||
drawio_authentik_forward_auth:
|
||||
type: bool
|
||||
default: false
|
||||
description:
|
||||
- When true, traefik attaches a ForwardAuth middleware pointing at
|
||||
the authentik embedded outpost. Unauthenticated requests are
|
||||
redirected to authentik for login and the resulting
|
||||
C(X-Authentik-*) identity headers are forwarded downstream.
|
||||
drawio_authentik_forward_auth_url:
|
||||
type: str
|
||||
default: ''
|
||||
description:
|
||||
- URL of the authentik ForwardAuth endpoint, typically
|
||||
C(https://auth.example.com/outpost.goauthentik.io/auth/traefik).
|
||||
Required when C(drawio_authentik_forward_auth=true).
|
||||
|
|
@ -1,35 +1,26 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy the draw.io diagram editor via Docker Compose behind Traefik, with optional authentik ForwardAuth
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.2
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- drawio
|
||||
- diagrams
|
||||
- docker
|
||||
- traefik
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
|
|
@ -14,14 +14,26 @@ services:
|
|||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network={{ drawio_traefik_network }}
|
||||
- traefik.http.routers.{{ drawio_service_name }}.rule=Host(`{{ drawio_domain }}`)
|
||||
- traefik.http.routers.{{ drawio_service_name }}.rule={% set _all_domains = [drawio_domain] + (drawio_extra_domains | default([])) %}{% for d in _all_domains %}Host(`{{ d }}`){% if not loop.last %} || {% endif %}{% endfor +%}
|
||||
- traefik.http.services.{{ drawio_service_name }}.loadbalancer.server.port={{ drawio_port }}
|
||||
{% if drawio_use_ssl %}
|
||||
- traefik.http.routers.{{ drawio_service_name }}.entrypoints=websecure
|
||||
- traefik.http.routers.{{ drawio_service_name }}.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.{{ drawio_service_name }}.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.{{ drawio_service_name }}.entrypoints=web
|
||||
{% endif %}
|
||||
{% if drawio_authentik_forward_auth | default(false) %}
|
||||
# ForwardAuth via the authentik embedded outpost. Unauthenticated
|
||||
# requests get redirected to authentik to log in; authentik then
|
||||
# sets X-Authentik-* headers traefik forwards downstream.
|
||||
- traefik.http.middlewares.{{ drawio_service_name }}-authentik.forwardauth.address={{ drawio_authentik_forward_auth_url }}
|
||||
- traefik.http.middlewares.{{ drawio_service_name }}-authentik.forwardauth.trustForwardHeader=true
|
||||
- traefik.http.middlewares.{{ drawio_service_name }}-authentik.forwardauth.authResponseHeaders=X-authentik-username,X-authentik-groups,X-authentik-entitlements,X-authentik-email,X-authentik-name,X-authentik-uid,X-authentik-jwt,X-authentik-meta-jwks,X-authentik-meta-outpost,X-authentik-meta-provider,X-authentik-meta-app,X-authentik-meta-version
|
||||
- traefik.http.routers.{{ drawio_service_name }}.middlewares={{ drawio_service_name }}-authentik
|
||||
{% endif %}
|
||||
|
||||
networks:
|
||||
{{ drawio_traefik_network }}:
|
||||
|
|
|
|||
|
|
@ -1,113 +1,118 @@
|
|||
Garage
|
||||
======
|
||||
# Garage
|
||||
|
||||
Ansible role to deploy Garage S3-compatible object storage using Docker Compose.
|
||||
Ansible role to deploy [Garage](https://garagehq.deuxfleurs.fr/) S3-compatible
|
||||
object storage via Docker Compose, with declarative key/bucket
|
||||
provisioning and an optional WebUI behind htpasswd or authentik
|
||||
ForwardAuth.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
## Requirements
|
||||
|
||||
- Docker and Docker Compose installed on the target host
|
||||
- Ansible collection: `community.docker`
|
||||
- Traefik reverse proxy (for external access)
|
||||
- `htpasswd` (from `apache2-utils` / `httpd-tools`) when the WebUI is
|
||||
enabled and authentik ForwardAuth is *not* used
|
||||
- Traefik with a shared `garage_traefik_network` (default `proxy`)
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
## Role variables
|
||||
|
||||
Key variables defined in `defaults/main.yml`:
|
||||
Full spec with types and defaults: `meta/argument_specs.yml`. The most
|
||||
common overrides:
|
||||
|
||||
**Base Configuration:**
|
||||
- `docker_compose_base_dir`: Base directory for Docker Compose files (default: `/etc/docker/compose`)
|
||||
- `docker_volume_base_dir`: Base directory for Docker volumes (default: `/srv/data`)
|
||||
### Service
|
||||
|
||||
**Garage Configuration:**
|
||||
- `garage_service_name`: Service name (default: `garage`)
|
||||
- `garage_image`: Garage Docker image (default: `dxflrs/garage:v2.1.0`)
|
||||
- `garage_s3_domain`: Domain for S3 API endpoint (default: `storage.local.test`)
|
||||
- `garage_web_domain`: Domain for S3 web endpoint (default: `web.storage.local.test`)
|
||||
- `garage_webui_domain`: Domain for web console (default: `console.storage.local.test`)
|
||||
- `garage_s3_domains`: FQDNs the S3 router accepts. The first entry is the
|
||||
canonical hostname; `garage.toml` derives the virtual-hosted-style S3
|
||||
`root_domain` from it as `.s3.<first-entry>` (so buckets resolve under
|
||||
`<bucket>.s3.<first-entry>`).
|
||||
- `garage_web_domain`, `garage_webui_domain`: separate hostnames for
|
||||
the S3-website endpoint and the console.
|
||||
- `garage_image`, `garage_replication_factor`, `garage_db_engine`,
|
||||
`garage_s3_region`.
|
||||
|
||||
**Garage Storage Configuration:**
|
||||
- `garage_replication_factor`: Replication factor (default: `1`)
|
||||
- `garage_compression_level`: Compression level (default: `1`)
|
||||
- `garage_db_engine`: Database engine (default: `lmdb`)
|
||||
- `garage_s3_region`: S3 region (default: `us-east-1`)
|
||||
### Required secrets
|
||||
|
||||
**Garage Ports:**
|
||||
- `garage_s3_api_port`: S3 API port (default: `3900`)
|
||||
- `garage_s3_web_port`: S3 web port (default: `3902`)
|
||||
- `garage_admin_port`: Admin API port (default: `3903`)
|
||||
- `garage_rpc_port`: RPC port (default: `3901`)
|
||||
Generate with `openssl rand -hex 32` (32 bytes / 64 hex chars):
|
||||
|
||||
**Garage Security:**
|
||||
- `garage_rpc_secret`: RPC secret for node communication
|
||||
- `garage_admin_token`: Admin API token
|
||||
- `garage_metrics_token`: Metrics API token
|
||||
- `garage_rpc_secret`: node-to-node RPC secret
|
||||
- `garage_admin_token`: admin API token
|
||||
- `garage_metrics_token`: metrics endpoint token
|
||||
|
||||
**Garage WebUI Configuration:**
|
||||
- `garage_webui_enabled`: Enable web UI (default: `true`)
|
||||
- `garage_webui_image`: WebUI Docker image (default: `khairul169/garage-webui:latest`)
|
||||
- `garage_webui_port`: WebUI port (default: `3909`)
|
||||
- `garage_webui_username`: WebUI username (default: `admin`)
|
||||
- `garage_webui_password`: WebUI password in plaintext (default: `admin`)
|
||||
### WebUI authentication
|
||||
|
||||
**Traefik Configuration:**
|
||||
- `garage_traefik_network`: Traefik network name (default: `proxy`)
|
||||
- `garage_internal_network`: Internal network name (default: `internal`)
|
||||
- `garage_use_ssl`: Enable SSL (default: `true`)
|
||||
Three modes:
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
1. **htpasswd** (default): `garage_webui_username` / `garage_webui_password`
|
||||
in plaintext. The role hashes the password with
|
||||
`htpasswd -nbBC 10`, persists the hash on disk, and re-verifies with
|
||||
`htpasswd -vbB` so unchanged passwords don't churn the play.
|
||||
2. **authentik ForwardAuth**: set
|
||||
`garage_webui_authentik_forward_auth: true` and
|
||||
`garage_webui_authentik_forward_auth_url:
|
||||
"https://auth.example.com/outpost.goauthentik.io/auth/traefik"`.
|
||||
`AUTH_USER_PASS` is dropped from the container env so authentik is
|
||||
the only gate.
|
||||
3. **Disabled**: `garage_webui_enabled: false`.
|
||||
|
||||
This role requires:
|
||||
- Traefik reverse proxy to be configured and the `proxy` network to be created
|
||||
- `htpasswd` utility (from `apache2-utils` package) for generating bcrypt password hashes
|
||||
### Layout bootstrap
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
Setting `garage_bootstrap_enabled: true` runs the bootstrap task, which
|
||||
joins the local node to the layout (`zone: garage_bootstrap_zone`,
|
||||
capacity: `garage_bootstrap_capacity`) on the first run. The check
|
||||
tolerates the 16-char truncation that `garage layout show` performs.
|
||||
|
||||
### Declarative S3 keys and buckets
|
||||
|
||||
```yaml
|
||||
garage_s3_keys:
|
||||
- name: nextcloud
|
||||
buckets:
|
||||
- name: nextcloud-data
|
||||
permissions: [read, write]
|
||||
- name: backup
|
||||
buckets:
|
||||
- name: restic-prod
|
||||
permissions: [read, write, owner]
|
||||
```
|
||||
|
||||
The role:
|
||||
|
||||
- Lists existing keys (`garage key list`), creates missing ones
|
||||
- Lists existing buckets (`garage bucket list`), creates missing ones
|
||||
- Reads current permissions via `garage bucket info` and runs
|
||||
`garage bucket allow` only when the current RWO flags for the key
|
||||
don't already match the desired permissions
|
||||
|
||||
`stdout` parsing is hardened against ANSI escapes and interleaved INFO
|
||||
log lines, so probe noise no longer produces spurious changes.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Traefik network (`garage_traefik_network`, default `proxy`)
|
||||
- Internal network (`garage_internal_network`, default `internal`)
|
||||
|
||||
## Example playbook
|
||||
|
||||
```yaml
|
||||
- hosts: storage_servers
|
||||
roles:
|
||||
- role: garage
|
||||
- role: digitalboard.core.garage
|
||||
vars:
|
||||
garage_s3_domain: "storage.example.com"
|
||||
garage_rpc_secret: "your-secure-rpc-secret"
|
||||
garage_admin_token: "your-admin-token"
|
||||
garage_webui_enabled: true
|
||||
garage_webui_username: "admin"
|
||||
garage_webui_password: "secure-password"
|
||||
garage_s3_domains:
|
||||
- "storage.example.com"
|
||||
- "storage.int.example.com"
|
||||
garage_rpc_secret: "{{ vault_garage_rpc_secret }}"
|
||||
garage_admin_token: "{{ vault_garage_admin_token }}"
|
||||
garage_metrics_token: "{{ vault_garage_metrics_token }}"
|
||||
garage_bootstrap_enabled: true
|
||||
garage_webui_authentik_forward_auth: true
|
||||
garage_webui_authentik_forward_auth_url: "https://auth.example.com/outpost.goauthentik.io/auth/traefik"
|
||||
garage_s3_keys:
|
||||
- name: nextcloud
|
||||
buckets:
|
||||
- name: nextcloud-data
|
||||
permissions: [read, write]
|
||||
```
|
||||
|
||||
**Note:** The WebUI password is specified in plaintext and will be automatically hashed using bcrypt during deployment. The role uses `htpasswd` to generate a secure bcrypt hash that is then properly escaped for use in Docker Compose.
|
||||
## License
|
||||
|
||||
Post-Installation
|
||||
-----------------
|
||||
|
||||
After deployment, you need to configure the Garage cluster:
|
||||
|
||||
1. Connect to the node and get the node ID:
|
||||
```bash
|
||||
docker exec -ti garage /garage node id
|
||||
```
|
||||
|
||||
2. Configure the node layout:
|
||||
```bash
|
||||
docker exec -ti garage /garage layout assign -z dc1 -c 1G <node-id>
|
||||
docker exec -ti garage /garage layout apply --version 1
|
||||
```
|
||||
|
||||
3. Create a key for S3 access:
|
||||
```bash
|
||||
docker exec -ti garage /garage key create my-key
|
||||
```
|
||||
|
||||
4. Create a bucket:
|
||||
```bash
|
||||
docker exec -ti garage /garage bucket create my-bucket
|
||||
docker exec -ti garage /garage bucket allow my-bucket --read --write --key my-key
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
MIT-0
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -13,7 +13,12 @@ garage_docker_volume_dir: "{{ docker_volume_base_dir }}/{{ garage_service_name }
|
|||
|
||||
# Garage service configuration
|
||||
garage_image: "dxflrs/garage:v2.1.0"
|
||||
garage_s3_domain: "storage.local.test"
|
||||
# FQDNs the garage S3 router accepts. The first entry is the canonical
|
||||
# domain; garage.toml derives the virtual-hosted-style S3 root_domain
|
||||
# from it as ".s3.<first-entry>"; further entries cover internal
|
||||
# *.int.* names.
|
||||
garage_s3_domains:
|
||||
- "storage.local.test"
|
||||
garage_web_domain: "web.storage.local.test"
|
||||
garage_webui_domain: "console.storage.local.test"
|
||||
|
||||
|
|
@ -21,10 +26,20 @@ garage_webui_domain: "console.storage.local.test"
|
|||
garage_webui_enabled: true
|
||||
garage_webui_image: "khairul169/garage-webui:latest"
|
||||
garage_webui_port: 3909
|
||||
# WebUI basic auth credentials (plaintext, will be hashed automatically)
|
||||
# WebUI basic auth credentials (plaintext, will be hashed automatically).
|
||||
# Ignored when garage_webui_authentik_forward_auth is true — in that case
|
||||
# authentik handles authentication via the ForwardAuth middleware below.
|
||||
garage_webui_username: "admin"
|
||||
garage_webui_password: "admin"
|
||||
|
||||
# Optional Authentik ForwardAuth in front of the WebUI. When true:
|
||||
# - the AUTH_USER_PASS env-var is dropped from the container so htpasswd
|
||||
# isn't enforced; authentik is the only gate.
|
||||
# - traefik attaches a ForwardAuth middleware pointing at the URL below.
|
||||
# Leave false to keep classic htpasswd protection.
|
||||
garage_webui_authentik_forward_auth: false
|
||||
garage_webui_authentik_forward_auth_url: ""
|
||||
|
||||
# Garage ports
|
||||
garage_s3_api_port: 3900
|
||||
garage_s3_web_port: 3902
|
||||
|
|
|
|||
169
roles/garage/meta/argument_specs.yml
Normal file
169
roles/garage/meta/argument_specs.yml
Normal file
|
|
@ -0,0 +1,169 @@
|
|||
---
|
||||
argument_specs:
|
||||
main:
|
||||
short_description: Deploy Garage S3-compatible object storage via Docker Compose.
|
||||
description:
|
||||
- Renders a Compose stack for Garage with traefik labels, configures the
|
||||
node layout on first run, and (optionally) provisions S3 keys, buckets
|
||||
and per-key permissions declaratively.
|
||||
- The optional WebUI can be protected by classic htpasswd or by
|
||||
authentik ForwardAuth.
|
||||
options:
|
||||
docker_compose_base_dir:
|
||||
type: path
|
||||
default: /etc/docker/compose
|
||||
docker_volume_base_dir:
|
||||
type: path
|
||||
default: /srv/data
|
||||
garage_service_name:
|
||||
type: str
|
||||
default: garage
|
||||
garage_docker_compose_dir:
|
||||
type: path
|
||||
description: Defaults to C({{ docker_compose_base_dir }}/{{ garage_service_name }}).
|
||||
garage_docker_volume_dir:
|
||||
type: path
|
||||
description: Defaults to C({{ docker_volume_base_dir }}/{{ garage_service_name }}).
|
||||
|
||||
garage_image:
|
||||
type: str
|
||||
default: dxflrs/garage:v2.1.0
|
||||
|
||||
garage_s3_domains:
|
||||
type: list
|
||||
elements: str
|
||||
default: ['storage.local.test']
|
||||
description:
|
||||
- FQDNs the garage S3 router accepts. The first entry is the
|
||||
canonical domain; C(garage.toml) derives the virtual-hosted-style
|
||||
S3 C(root_domain) from it as C(.s3.<first-entry>). Further entries
|
||||
cover internal C(*.int.*) names.
|
||||
garage_web_domain:
|
||||
type: str
|
||||
default: web.storage.local.test
|
||||
description: Hostname serving the S3-website endpoint.
|
||||
garage_webui_domain:
|
||||
type: str
|
||||
default: console.storage.local.test
|
||||
description: Hostname serving the WebUI console.
|
||||
|
||||
garage_webui_enabled:
|
||||
type: bool
|
||||
default: true
|
||||
garage_webui_image:
|
||||
type: str
|
||||
default: khairul169/garage-webui:latest
|
||||
garage_webui_port:
|
||||
type: int
|
||||
default: 3909
|
||||
garage_webui_username:
|
||||
type: str
|
||||
default: admin
|
||||
description: htpasswd username. Ignored when C(garage_webui_authentik_forward_auth=true).
|
||||
garage_webui_password:
|
||||
type: str
|
||||
default: admin
|
||||
description:
|
||||
- Plaintext password; hashed with C(htpasswd -nbBC 10) and persisted
|
||||
on disk so re-runs don't churn. Ignored when authentik ForwardAuth
|
||||
is enabled.
|
||||
garage_webui_authentik_forward_auth:
|
||||
type: bool
|
||||
default: false
|
||||
description:
|
||||
- When true the C(AUTH_USER_PASS) env-var is dropped from the WebUI
|
||||
container and traefik attaches a ForwardAuth middleware pointing
|
||||
at the URL below. authentik is then the only gate; htpasswd is
|
||||
disabled.
|
||||
garage_webui_authentik_forward_auth_url:
|
||||
type: str
|
||||
default: ''
|
||||
description:
|
||||
- Required when C(garage_webui_authentik_forward_auth=true).
|
||||
Typically C(https://auth.example.com/outpost.goauthentik.io/auth/traefik).
|
||||
|
||||
garage_s3_api_port:
|
||||
type: int
|
||||
default: 3900
|
||||
garage_s3_web_port:
|
||||
type: int
|
||||
default: 3902
|
||||
garage_admin_port:
|
||||
type: int
|
||||
default: 3903
|
||||
garage_rpc_port:
|
||||
type: int
|
||||
default: 3901
|
||||
|
||||
garage_replication_factor:
|
||||
type: int
|
||||
default: 1
|
||||
garage_compression_level:
|
||||
type: int
|
||||
default: 1
|
||||
garage_db_engine:
|
||||
type: str
|
||||
choices: [lmdb, sqlite, sled]
|
||||
default: lmdb
|
||||
garage_s3_region:
|
||||
type: str
|
||||
default: us-east-1
|
||||
garage_rpc_secret:
|
||||
type: str
|
||||
required: true
|
||||
description: Hex secret for node-to-node RPC. Generate with C(openssl rand -hex 32).
|
||||
garage_admin_token:
|
||||
type: str
|
||||
required: true
|
||||
garage_metrics_token:
|
||||
type: str
|
||||
required: true
|
||||
|
||||
garage_traefik_network:
|
||||
type: str
|
||||
default: proxy
|
||||
garage_internal_network:
|
||||
type: str
|
||||
default: internal
|
||||
garage_use_ssl:
|
||||
type: bool
|
||||
default: true
|
||||
|
||||
garage_bootstrap_enabled:
|
||||
type: bool
|
||||
default: false
|
||||
description: When true the bootstrap task ensures the node is in the layout.
|
||||
garage_bootstrap_zone:
|
||||
type: str
|
||||
default: dc1
|
||||
description: Zone label assigned during layout bootstrap.
|
||||
garage_bootstrap_capacity:
|
||||
type: str
|
||||
default: 1G
|
||||
description: Capacity string passed to C(garage layout assign -c).
|
||||
|
||||
garage_s3_keys:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
description:
|
||||
- Declarative key + bucket + permission provisioning. The role
|
||||
creates missing keys, missing buckets, and runs C(bucket allow)
|
||||
only when the current RWO flags for a given key don't match.
|
||||
options:
|
||||
name:
|
||||
type: str
|
||||
required: true
|
||||
buckets:
|
||||
type: list
|
||||
elements: dict
|
||||
description: Buckets this key gets access to.
|
||||
options:
|
||||
name:
|
||||
type: str
|
||||
required: true
|
||||
permissions:
|
||||
type: list
|
||||
elements: str
|
||||
choices: [read, write, owner]
|
||||
required: true
|
||||
|
|
@ -1,35 +1,27 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy Garage S3-compatible object storage via Docker Compose, with declarative key/bucket provisioning
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.1
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- garage
|
||||
- s3
|
||||
- storage
|
||||
- object-storage
|
||||
- docker
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
|
|
@ -7,21 +7,27 @@
|
|||
container: "{{ garage_service_name }}"
|
||||
command: /garage node id -q
|
||||
register: _garage_node_id
|
||||
changed_when: false
|
||||
|
||||
- name: Extract short node ID
|
||||
ansible.builtin.set_fact:
|
||||
_garage_node_id_short: "{{ _garage_node_id.stdout.split('@')[0] }}"
|
||||
|
||||
- name: Extract truncated node ID (first 16 chars, matches `garage layout show` output)
|
||||
ansible.builtin.set_fact:
|
||||
_garage_node_id_truncated: "{{ _garage_node_id_short[:16] }}"
|
||||
|
||||
- name: Check if node layout is configured
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ garage_service_name }}"
|
||||
command: /garage layout show
|
||||
register: _garage_layout_show
|
||||
failed_when: false
|
||||
changed_when: false
|
||||
|
||||
- name: Check if node is in layout
|
||||
ansible.builtin.set_fact:
|
||||
_node_in_layout: "{{ _garage_node_id_short in _garage_layout_show.stdout }}"
|
||||
_node_in_layout: "{{ (_garage_node_id_truncated in _garage_layout_show.stdout) or (_garage_node_id_short in _garage_layout_show.stdout) }}"
|
||||
|
||||
- name: Configure garage node layout
|
||||
community.docker.docker_container_exec:
|
||||
|
|
|
|||
|
|
@ -26,12 +26,77 @@
|
|||
dest: "{{ garage_docker_compose_dir }}/garage.toml"
|
||||
mode: '0644'
|
||||
|
||||
- name: Generate bcrypt hash for webui password using htpasswd
|
||||
ansible.builtin.shell: |
|
||||
htpasswd -nbBC 10 "{{ garage_webui_username }}" "{{ garage_webui_password }}"
|
||||
register: _garage_webui_password_hash
|
||||
- name: Set webui htpasswd activation fact
|
||||
ansible.builtin.set_fact:
|
||||
# htpasswd only runs when the WebUI is enabled AND authentik ForwardAuth
|
||||
# is not handling authentication. When authentik is in front, the
|
||||
# compose template drops AUTH_USER_PASS so no hash is needed.
|
||||
_garage_webui_htpasswd_active: >-
|
||||
{{
|
||||
garage_webui_enabled
|
||||
and not (garage_webui_authentik_forward_auth | default(false))
|
||||
}}
|
||||
|
||||
- name: Read cached webui htpasswd hash
|
||||
ansible.builtin.slurp:
|
||||
src: "{{ garage_docker_compose_dir }}/webui.htpasswd"
|
||||
register: _garage_webui_htpasswd_cached
|
||||
failed_when: false
|
||||
changed_when: false
|
||||
when: garage_webui_enabled
|
||||
when: _garage_webui_htpasswd_active
|
||||
|
||||
- name: Verify cached webui htpasswd hash still matches password
|
||||
ansible.builtin.command:
|
||||
argv:
|
||||
- htpasswd
|
||||
- -vbB
|
||||
- "{{ garage_docker_compose_dir }}/webui.htpasswd"
|
||||
- "{{ garage_webui_username }}"
|
||||
- "{{ garage_webui_password }}"
|
||||
register: _garage_webui_htpasswd_verify
|
||||
failed_when: false
|
||||
changed_when: false
|
||||
no_log: true
|
||||
when:
|
||||
- _garage_webui_htpasswd_active
|
||||
- _garage_webui_htpasswd_cached.content is defined
|
||||
|
||||
- name: Generate bcrypt hash for webui password using htpasswd
|
||||
ansible.builtin.command:
|
||||
argv:
|
||||
- htpasswd
|
||||
- -nbBC
|
||||
- "10"
|
||||
- "{{ garage_webui_username }}"
|
||||
- "{{ garage_webui_password }}"
|
||||
register: _garage_webui_password_hash_new
|
||||
changed_when: true
|
||||
when:
|
||||
- _garage_webui_htpasswd_active
|
||||
- (_garage_webui_htpasswd_cached.content is not defined)
|
||||
or (_garage_webui_htpasswd_verify.rc | default(1) != 0)
|
||||
|
||||
- name: Persist webui htpasswd hash on disk
|
||||
ansible.builtin.copy:
|
||||
content: "{{ _garage_webui_password_hash_new.stdout }}\n"
|
||||
dest: "{{ garage_docker_compose_dir }}/webui.htpasswd"
|
||||
mode: '0600'
|
||||
when:
|
||||
- _garage_webui_htpasswd_active
|
||||
- _garage_webui_password_hash_new is changed
|
||||
|
||||
- name: Load current webui htpasswd hash
|
||||
ansible.builtin.slurp:
|
||||
src: "{{ garage_docker_compose_dir }}/webui.htpasswd"
|
||||
register: _garage_webui_htpasswd_current
|
||||
changed_when: false
|
||||
when: _garage_webui_htpasswd_active
|
||||
|
||||
- name: Expose current webui htpasswd hash to template
|
||||
ansible.builtin.set_fact:
|
||||
_garage_webui_password_hash:
|
||||
stdout: "{{ (_garage_webui_htpasswd_current.content | b64decode).strip() }}"
|
||||
when: _garage_webui_htpasswd_active
|
||||
|
||||
- name: Create docker-compose file for garage
|
||||
template:
|
||||
|
|
|
|||
|
|
@ -4,11 +4,17 @@
|
|||
container: "{{ garage_service_name }}"
|
||||
command: /garage key list
|
||||
register: _existing_keys_output
|
||||
changed_when: false
|
||||
when: garage_s3_keys | length > 0
|
||||
|
||||
- name: Parse existing key names
|
||||
ansible.builtin.set_fact:
|
||||
_existing_keys: "{{ _existing_keys_output.stdout_lines[1:] | select('match', '^GK') | map('regex_replace', '^\\S+\\s+\\S+\\s+(\\S+)\\s+.*$', '\\1') | list }}"
|
||||
# `garage key list` columns: ID Created Name Expiration.
|
||||
# Data rows begin with a GK<hex> key ID; header is "ID Created ..."
|
||||
# and INFO log lines may interleave on stderr (kept separate by
|
||||
# docker_container_exec). Strip ANSI escapes defensively, filter to
|
||||
# GK-prefixed rows, then take the 3rd whitespace-separated field.
|
||||
_existing_keys: "{{ _existing_keys_output.stdout_lines | map('regex_replace', '\\x1b\\[[0-9;]*m', '') | select('match', '^GK[0-9a-fA-F]+') | map('regex_replace', '^\\S+\\s+\\S+\\s+(\\S+).*$', '\\1') | list }}"
|
||||
when: garage_s3_keys | length > 0
|
||||
|
||||
- name: Create S3 keys
|
||||
|
|
@ -27,6 +33,7 @@
|
|||
command: /garage key info {{ item.name }}
|
||||
loop: "{{ garage_s3_keys }}"
|
||||
register: _key_info_results
|
||||
changed_when: false
|
||||
when: garage_s3_keys | length > 0
|
||||
|
||||
- name: Extract key IDs from info
|
||||
|
|
@ -42,11 +49,21 @@
|
|||
container: "{{ garage_service_name }}"
|
||||
command: /garage bucket list
|
||||
register: _existing_buckets_output
|
||||
changed_when: false
|
||||
when: garage_s3_keys | length > 0
|
||||
|
||||
- name: Parse existing bucket names
|
||||
ansible.builtin.set_fact:
|
||||
_existing_buckets: "{{ _existing_buckets_output.stdout_lines[2:] | map('split') | map('first') | list }}"
|
||||
# `garage bucket list` columns: ID Created Global aliases Local aliases
|
||||
# Data rows start with a hex bucket ID; filter to those and take the
|
||||
# third whitespace-separated field (the global alias = bucket name).
|
||||
_existing_buckets: >-
|
||||
{{
|
||||
_existing_buckets_output.stdout_lines
|
||||
| select('match', '^[0-9a-f]{16}\\s')
|
||||
| map('regex_replace', '^\\S+\\s+\\S+\\s+(\\S+).*$', '\\1')
|
||||
| list
|
||||
}}
|
||||
when: garage_s3_keys | length > 0
|
||||
|
||||
- name: Get unique bucket names
|
||||
|
|
@ -64,12 +81,37 @@
|
|||
- item not in _existing_buckets
|
||||
failed_when: false
|
||||
|
||||
- name: Get current bucket permissions
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ garage_service_name }}"
|
||||
command: /garage bucket info {{ item.1.name }}
|
||||
loop: "{{ garage_s3_keys | subelements('buckets', skip_missing=True) }}"
|
||||
loop_control:
|
||||
label: "{{ item.1.name }}"
|
||||
register: _bucket_info_results
|
||||
changed_when: false
|
||||
when: garage_s3_keys | length > 0
|
||||
|
||||
- name: Set bucket permissions using key IDs
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ garage_service_name }}"
|
||||
command: /garage bucket allow {{ item.1.name }} {% for perm in item.1.permissions %}--{{ perm }} {% endfor %}--key {{ _key_id_map[item.0.name] }}
|
||||
loop: "{{ garage_s3_keys | subelements('buckets', skip_missing=True) }}"
|
||||
when: garage_s3_keys | length > 0
|
||||
command: /garage bucket allow {{ item.item.1.name }} {% for perm in item.item.1.permissions %}--{{ perm }} {% endfor %}--key {{ _key_id_map[item.item.0.name] }}
|
||||
loop: "{{ _bucket_info_results.results }}"
|
||||
loop_control:
|
||||
label: "{{ item.item.1.name }} -> {{ item.item.0.name }}"
|
||||
when:
|
||||
- garage_s3_keys | length > 0
|
||||
- >-
|
||||
(item.stdout | regex_search(
|
||||
'(?m)^\s*' ~ _wanted_flags ~ '\s+' ~ _key_id_map[item.item.0.name]
|
||||
)) is none
|
||||
vars:
|
||||
_wanted_flags: >-
|
||||
{{
|
||||
('R' if 'read' in item.item.1.permissions else '-')
|
||||
~ ('W' if 'write' in item.item.1.permissions else '-')
|
||||
~ ('O' if 'owner' in item.item.1.permissions else '-')
|
||||
}}
|
||||
|
||||
# Export key credentials for use by other roles
|
||||
- name: Get detailed key information for all keys
|
||||
|
|
@ -78,6 +120,7 @@
|
|||
command: /garage key info {{ item.name }} --show-secret
|
||||
loop: "{{ garage_s3_keys }}"
|
||||
register: _key_details_results
|
||||
changed_when: false
|
||||
when: garage_s3_keys | length > 0
|
||||
|
||||
- name: Build garage S3 credentials map
|
||||
|
|
|
|||
|
|
@ -14,10 +14,13 @@ services:
|
|||
- traefik.enable=true
|
||||
- traefik.docker.network={{ garage_traefik_network }}
|
||||
# S3 API endpoint
|
||||
- traefik.http.routers.{{ garage_service_name }}.rule=Host(`{{ garage_s3_domain }}`)
|
||||
- traefik.http.routers.{{ garage_service_name }}.rule={% for d in garage_s3_domains %}Host(`{{ d }}`){% if not loop.last %} || {% endif %}{% endfor +%}
|
||||
{% if garage_use_ssl %}
|
||||
- traefik.http.routers.{{ garage_service_name }}.entrypoints=websecure
|
||||
- traefik.http.routers.{{ garage_service_name }}.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.{{ garage_service_name }}.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.{{ garage_service_name }}.entrypoints=web
|
||||
{% endif %}
|
||||
|
|
@ -35,7 +38,9 @@ services:
|
|||
environment:
|
||||
API_BASE_URL: "http://{{ garage_service_name }}:{{ garage_admin_port }}"
|
||||
S3_ENDPOINT_URL: "http://{{ garage_service_name }}:{{ garage_s3_api_port }}"
|
||||
{% if not (garage_webui_authentik_forward_auth | default(false)) %}
|
||||
AUTH_USER_PASS: '{{ _garage_webui_password_hash.stdout | replace("$", "$$") }}'
|
||||
{% endif %}
|
||||
volumes:
|
||||
- {{ garage_docker_compose_dir }}/garage.toml:/etc/garage.toml:ro
|
||||
networks:
|
||||
|
|
@ -48,12 +53,25 @@ services:
|
|||
{% if garage_use_ssl %}
|
||||
- traefik.http.routers.{{ garage_service_name }}-console.entrypoints=websecure
|
||||
- traefik.http.routers.{{ garage_service_name }}-console.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.{{ garage_service_name }}-console.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.{{ garage_service_name }}-console.entrypoints=web
|
||||
{% endif %}
|
||||
- traefik.http.routers.{{ garage_service_name }}-console.service={{ garage_service_name }}-console
|
||||
- traefik.http.routers.{{ garage_service_name }}-console.priority=10
|
||||
- traefik.http.services.{{ garage_service_name }}-console.loadbalancer.server.port={{ garage_webui_port }}
|
||||
{% if garage_webui_authentik_forward_auth | default(false) %}
|
||||
# ForwardAuth via the authentik embedded outpost. Unauthenticated
|
||||
# requests are redirected to authentik; authentik then forwards
|
||||
# X-Authentik-* identity headers downstream. htpasswd is disabled
|
||||
# in the env block above so authentik is the only gate.
|
||||
- traefik.http.middlewares.{{ garage_service_name }}-console-authentik.forwardauth.address={{ garage_webui_authentik_forward_auth_url }}
|
||||
- traefik.http.middlewares.{{ garage_service_name }}-console-authentik.forwardauth.trustForwardHeader=true
|
||||
- traefik.http.middlewares.{{ garage_service_name }}-console-authentik.forwardauth.authResponseHeaders=X-authentik-username,X-authentik-groups,X-authentik-entitlements,X-authentik-email,X-authentik-name,X-authentik-uid,X-authentik-jwt,X-authentik-meta-jwks,X-authentik-meta-outpost,X-authentik-meta-provider,X-authentik-meta-app,X-authentik-meta-version
|
||||
- traefik.http.routers.{{ garage_service_name }}-console.middlewares={{ garage_service_name }}-console-authentik
|
||||
{% endif %}
|
||||
{% endif %}
|
||||
|
||||
networks:
|
||||
|
|
|
|||
|
|
@ -14,7 +14,7 @@ rpc_secret = "{{ garage_rpc_secret }}"
|
|||
[s3_api]
|
||||
s3_region = "{{ garage_s3_region }}"
|
||||
api_bind_addr = "[::]:{{ garage_s3_api_port }}"
|
||||
root_domain = ".s3.{{ garage_s3_domain }}"
|
||||
root_domain = ".s3.{{ garage_s3_domains[0] }}"
|
||||
|
||||
[s3_web]
|
||||
bind_addr = "[::]:{{ garage_s3_web_port }}"
|
||||
|
|
|
|||
|
|
@ -36,8 +36,10 @@ secrets to version control.**
|
|||
| `homarr_admin_password` | strong password | `openssl rand -base64 24` |
|
||||
| `homarr_oidc_client_secret` | from your identity provider | — |
|
||||
|
||||
The `assert` task at the top of the role will fail fast if the encryption
|
||||
key is missing or malformed.
|
||||
`homarr_oidc_client_secret` is only required when `oidc` is in
|
||||
`homarr_auth_providers`; the role asserts it then. The encryption key is
|
||||
always required — the `assert` task at the top of the role fails fast if it
|
||||
is missing or malformed.
|
||||
|
||||
## Configurable variables
|
||||
|
||||
|
|
@ -46,6 +48,7 @@ See `defaults/main.yml` for the full list. Most useful overrides:
|
|||
| Variable | Default | Purpose |
|
||||
|---|---|---|
|
||||
| `homarr_domain` | `homarr.local.test` | Traefik Host rule |
|
||||
| `homarr_extra_domains` | `[]` | Extra Host-rule hostnames (OR-combined), e.g. internal `*.int.*` FQDN |
|
||||
| `homarr_base_url` | `https://home.local.test` | NEXTAUTH_URL / BASE_URL |
|
||||
| `homarr_auth_providers` | `credentials` | `credentials`, `oidc`, or both |
|
||||
| `homarr_oidc_issuer` | empty | Identity provider issuer URL |
|
||||
|
|
@ -112,7 +115,7 @@ The filter is invoked once from `tasks/main.yml`:
|
|||
```yaml
|
||||
- name: Compute Homarr app layouts
|
||||
ansible.builtin.set_fact:
|
||||
homarr_layout: "{{ homarr_apps | homarr_compute_layouts }}"
|
||||
homarr_layout: "{{ homarr_apps | digitalboard.core.homarr_compute_layouts }}"
|
||||
```
|
||||
|
||||
This produces a `homarr_layout` fact with two keys, both consumed by
|
||||
|
|
@ -120,14 +123,14 @@ This produces a `homarr_layout` fact with two keys, both consumed by
|
|||
|
||||
| Key | Shape | Purpose |
|
||||
|---|---|---|
|
||||
| `apps` | list, same order as `homarr_apps` | each entry enriched with `desktop`, `tablet`, `mobile` sub-dicts of `{x, y, w, h}` |
|
||||
| `apps` | list, same order as `homarr_apps` | each entry gains `desktop`/`tablet`/`mobile` dicts of `{x, y, w, h}` |
|
||||
| `section_height` | dict with `desktop`, `tablet`, `mobile` | minimum height of the parent section so all tiles fit |
|
||||
|
||||
The filter signature accepts custom column counts if Homarr ever
|
||||
changes the breakpoint widths:
|
||||
|
||||
```jinja
|
||||
{{ homarr_apps | homarr_compute_layouts(desktop_cols=12, tablet_cols=8, mobile_cols=4) }}
|
||||
{{ homarr_apps | digitalboard.core.homarr_compute_layouts(desktop_cols=12, tablet_cols=8, mobile_cols=4) }}
|
||||
```
|
||||
|
||||
To debug a layout without running the full deploy, run the play with
|
||||
|
|
@ -240,4 +243,8 @@ and lowercase are accepted.
|
|||
|
||||
**App tiles overlap.** Check `homarr_apps` for duplicate `id` values.
|
||||
The role validates this, but if you bypass the check, the seed will
|
||||
still run and Homarr will display only one of the duplicates.
|
||||
still run and Homarr will display only one of the duplicates.
|
||||
|
||||
## License
|
||||
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -15,6 +15,10 @@ homarr_db: "{{ homarr_appdata_dir }}/db/db.sqlite"
|
|||
|
||||
# Service configuration
|
||||
homarr_domain: "homarr.local.test"
|
||||
# Additional hostnames the homarr router answers on (e.g. an internal
|
||||
# *.int.* FQDN so a DMZ reverseproxy can hit a backend hostname covered
|
||||
# by the cert).
|
||||
homarr_extra_domains: []
|
||||
homarr_image: "ghcr.io/homarr-labs/homarr:latest"
|
||||
homarr_port: 7575
|
||||
homarr_use_docker: false
|
||||
|
|
|
|||
|
|
@ -15,7 +15,11 @@ import sys
|
|||
|
||||
# Make the filter importable without having Ansible auto-discovery in
|
||||
# the way (it would only run during a real `ansible-playbook` invocation).
|
||||
sys.path.insert(0, os.path.join(os.path.dirname(__file__), '..'))
|
||||
sys.path.insert(
|
||||
0,
|
||||
os.path.join(os.path.dirname(__file__), '..', '..', '..', '..',
|
||||
'plugins', 'filter')
|
||||
)
|
||||
|
||||
import pytest # noqa: E402
|
||||
|
||||
|
|
|
|||
|
|
@ -5,4 +5,4 @@
|
|||
- name: restart homarr
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ homarr_docker_compose_dir }}"
|
||||
state: restarted
|
||||
state: present
|
||||
|
|
@ -1,35 +1,27 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy the Homarr dashboard via Docker Compose behind Traefik, with seeded admin user and OIDC group
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.2
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- homarr
|
||||
- dashboard
|
||||
- oidc
|
||||
- docker
|
||||
- traefik
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
@ -112,19 +112,17 @@
|
|||
# =====================================================================
|
||||
|
||||
- name: Generate bcrypt hash for admin password
|
||||
ansible.builtin.shell:
|
||||
cmd: python3 -c "import bcrypt, sys; print(bcrypt.hashpw(sys.stdin.read().encode(), bcrypt.gensalt(rounds=10)).decode())"
|
||||
stdin: "{{ homarr_admin_password }}"
|
||||
stdin_add_newline: false
|
||||
delegate_to: localhost
|
||||
become: false
|
||||
register: bcrypt_result
|
||||
changed_when: false
|
||||
no_log: true
|
||||
|
||||
- name: Set bcrypt hash fact
|
||||
ansible.builtin.set_fact:
|
||||
homarr_bcrypt_hash: "{{ bcrypt_result.stdout }}"
|
||||
# Deterministic salt derived from the password's SHA-256 digest so the
|
||||
# hash stays stable across runs (idempotent — no spurious template
|
||||
# changes / container restarts when the password is unchanged). The
|
||||
# bcrypt salt alphabet is [./A-Za-z0-9]; the digest's hex chars are
|
||||
# a strict subset, so we just take the first 22.
|
||||
homarr_bcrypt_hash: >-
|
||||
{{ homarr_admin_password
|
||||
| password_hash('bcrypt', rounds=10,
|
||||
salt=(homarr_admin_password
|
||||
| hash('sha256'))[:22]) }}
|
||||
no_log: true
|
||||
|
||||
# =====================================================================
|
||||
|
|
@ -136,7 +134,7 @@
|
|||
|
||||
- name: Compute Homarr app layouts
|
||||
ansible.builtin.set_fact:
|
||||
homarr_layout: "{{ homarr_apps | homarr_compute_layouts }}"
|
||||
homarr_layout: "{{ homarr_apps | digitalboard.core.homarr_compute_layouts }}"
|
||||
|
||||
- name: Show computed app layouts
|
||||
ansible.builtin.debug:
|
||||
|
|
@ -161,4 +159,4 @@
|
|||
register: seed_result
|
||||
changed_when: seed_result.rc == 0
|
||||
when: admin_exists.stdout == ""
|
||||
notify: restart homarr
|
||||
notify: restart homarr
|
||||
|
|
|
|||
|
|
@ -29,10 +29,13 @@ services:
|
|||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network={{ homarr_traefik_network }}
|
||||
- traefik.http.routers.homarr.rule=Host(`{{ homarr_domain }}`)
|
||||
- traefik.http.routers.homarr.rule={% set _all_domains = [homarr_domain] + (homarr_extra_domains | default([])) %}{% for d in _all_domains %}Host(`{{ d }}`){% if not loop.last %} || {% endif %}{% endfor +%}
|
||||
{% if homarr_use_ssl %}
|
||||
- traefik.http.routers.homarr.entrypoints=websecure
|
||||
- traefik.http.routers.homarr.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.homarr.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.homarr.entrypoints=web
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -1,38 +1,30 @@
|
|||
Role Name
|
||||
=========
|
||||
# httpbin
|
||||
|
||||
A brief description of the role goes here.
|
||||
Deploys [httpbin](https://httpbin.org/) (`kennethreitz/httpbin`) via
|
||||
Docker Compose behind Traefik. Useful as a throwaway endpoint to verify
|
||||
that the Traefik ingress path, TLS and routing work end to end.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
## Role variables
|
||||
|
||||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `httpbin_domain` | `httpbin.local.test` | FQDN the Traefik router matches. |
|
||||
| `httpbin_image` | `kennethreitz/httpbin` | Container image. |
|
||||
| `httpbin_port` | `80` | Container port Traefik forwards to. |
|
||||
| `httpbin_traefik_network` | `proxy` | Docker network shared with Traefik. |
|
||||
| `httpbin_use_ssl` | `true` | Route via the `websecure` entrypoint with `tls=true` (otherwise `web`). |
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
## Example
|
||||
|
||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
|
||||
```yaml
|
||||
- hosts: services
|
||||
become: true
|
||||
roles:
|
||||
- role: digitalboard.core.httpbin
|
||||
vars:
|
||||
httpbin_domain: "httpbin.example.com"
|
||||
```
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
## License
|
||||
|
||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
|
||||
- hosts: servers
|
||||
roles:
|
||||
- { role: username.rolename, x: 42 }
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
BSD
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -1,35 +1,27 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy httpbin HTTP request/response testing service via Docker Compose behind Traefik
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.1
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- httpbin
|
||||
- testing
|
||||
- debug
|
||||
- docker
|
||||
- traefik
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
|
|
@ -1,65 +1,119 @@
|
|||
Keycloak
|
||||
=========
|
||||
# Keycloak
|
||||
|
||||
Ansible role to deploy Keycloak with PostgreSQL database using Docker Compose.
|
||||
Ansible role to deploy Keycloak with a PostgreSQL backend via Docker
|
||||
Compose, published behind Traefik. Optionally provisions realm resources
|
||||
(groups, users, OIDC clients, identity providers, LDAP user federations)
|
||||
through the `community.general` Keycloak modules.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
## Requirements
|
||||
|
||||
- Docker and Docker Compose installed on the target host
|
||||
- Ansible collection: `community.docker`
|
||||
- Traefik reverse proxy (for external access)
|
||||
- Docker and Docker Compose on the target host (e.g. via
|
||||
`digitalboard.core.base`)
|
||||
- Ansible collections: `community.docker`, and `community.general` when
|
||||
`keycloak_provisioning_enabled` is true
|
||||
- Traefik reverse proxy with the `proxy` network already created (for
|
||||
external access)
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
## Role variables
|
||||
|
||||
Key variables defined in `defaults/main.yml`:
|
||||
Key variables from `defaults/main.yml`:
|
||||
|
||||
**Base Configuration:**
|
||||
- `docker_compose_base_dir`: Base directory for Docker Compose files (default: `/etc/docker/compose`)
|
||||
- `docker_volume_base_dir`: Base directory for Docker volumes (default: `/srv/data`)
|
||||
### Base configuration
|
||||
|
||||
**Keycloak Configuration:**
|
||||
- `keycloak_service_name`: Service name (default: `keycloak`)
|
||||
- `keycloak_domain`: Domain name for Keycloak (default: `auth.digitalboard.ch`)
|
||||
- `keycloak_image`: Keycloak Docker image (default: `quay.io/keycloak/keycloak:24.0.1`)
|
||||
- `keycloak_port`: Internal Keycloak port (default: `8080`)
|
||||
- `keycloak_admin_user`: Admin username (default: `admin`)
|
||||
- `keycloak_admin_password`: Admin password (default: `changeme`)
|
||||
- `keycloak_log_level`: Log level (default: `INFO`)
|
||||
- `keycloak_proxy_mode`: Proxy mode (default: `edge`)
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `docker_compose_base_dir` | `/etc/docker/compose` | Base dir for Compose projects. |
|
||||
| `docker_volume_base_dir` | `/srv/data` | Base dir for persistent volumes. |
|
||||
| `keycloak_service_name` | `keycloak` | Compose/service name; builds the per-service paths. |
|
||||
|
||||
**PostgreSQL Configuration:**
|
||||
- `keycloak_postgres_image`: PostgreSQL Docker image (default: `postgres:15`)
|
||||
- `keycloak_postgres_db`: Database name (default: `keycloak`)
|
||||
- `keycloak_postgres_user`: Database user (default: `keycloak`)
|
||||
- `keycloak_postgres_password`: Database password (default: `changeme`)
|
||||
### Keycloak
|
||||
|
||||
**Traefik Configuration:**
|
||||
- `keycloak_traefik_network`: Traefik network name (default: `proxy`)
|
||||
- `keycloak_backend_network`: Backend network name (default: `backend`)
|
||||
- `keycloak_use_ssl`: Enable SSL (default: `true`)
|
||||
- `keycloak_cert_resolver`: Certificate resolver name (default: `dns`)
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `keycloak_domain` | `keycloak.local.test` | Host rule and `KC_HOSTNAME`. |
|
||||
| `keycloak_image` | `quay.io/keycloak/keycloak:24.0.1` | Keycloak image. |
|
||||
| `keycloak_port` | `8080` | Internal HTTP port advertised to Traefik. |
|
||||
| `keycloak_admin_user` | `admin` | Bootstrap admin user. |
|
||||
| `keycloak_admin_password` | `changeme` | Admin password — **override this**. |
|
||||
| `keycloak_log_level` | `INFO` | `KC_LOG_LEVEL`. |
|
||||
| `keycloak_proxy_mode` | `edge` | `KC_PROXY` mode. |
|
||||
| `keycloak_gzip_enabled` | `false` | Toggle Keycloak GZIP response encoding. |
|
||||
| `keycloak_truststore_certificates` | `[]` | Host PEM paths mounted into the truststore (`KC_TRUSTSTORE_PATHS`). |
|
||||
| `keycloak_extra_hosts` | `[]` | Extra `host:ip` entries for the container. |
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
### PostgreSQL
|
||||
|
||||
This role requires the Traefik reverse proxy to be configured and the `proxy` network to be created.
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `keycloak_postgres_image` | `postgres:15` | PostgreSQL image. |
|
||||
| `keycloak_postgres_db` | `keycloak` | Database name. |
|
||||
| `keycloak_postgres_user` | `keycloak` | Database user. |
|
||||
| `keycloak_postgres_password` | `changeme` | Database password — **override this**. |
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
### Traefik
|
||||
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `keycloak_traefik_network` | `proxy` | External Traefik network. |
|
||||
| `keycloak_backend_network` | `backend` | Internal network to PostgreSQL. |
|
||||
| `keycloak_use_ssl` | `true` | Route on `websecure` with `tls=true` instead of `web`. |
|
||||
|
||||
TLS is requested from Traefik via `tls=true`; the role does not set a
|
||||
certificate resolver, so Traefik issues/serves the certificate according
|
||||
to its own configuration.
|
||||
|
||||
### Provisioning (optional)
|
||||
|
||||
Provisioning runs only when `keycloak_provisioning_enabled` is true. The
|
||||
tasks wait for the `/health/ready` endpoint and then call the
|
||||
`community.general.keycloak_*` modules, delegated to `localhost` against
|
||||
`keycloak_auth_url` (derived from `keycloak_use_ssl` + `keycloak_domain`).
|
||||
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `keycloak_provisioning_enabled` | `false` | Enable realm provisioning. |
|
||||
| `keycloak_realm` | `default` | Target realm; created unless `master`. |
|
||||
| `keycloak_realm_display_name` | `Default Realm` | Realm display name. |
|
||||
| `keycloak_auth_url` | derived | API base URL for provisioning. |
|
||||
| `keycloak_groups` | `[]` | Groups to create. |
|
||||
| `keycloak_local_users` | `[]` | Local users to create. |
|
||||
| `keycloak_oidc_clients` | `[]` | OIDC clients to create. |
|
||||
| `keycloak_identity_providers` | `[]` | Identity providers (e.g. Entra ID). |
|
||||
| `keycloak_user_federations` | `[]` | LDAP user federations. |
|
||||
| `keycloak_removed_users` | `[]` | Usernames to delete. |
|
||||
| `keycloak_removed_groups` | `[]` | Group names to delete. |
|
||||
| `keycloak_removed_clients` | `[]` | Client IDs to delete. |
|
||||
| `keycloak_removed_identity_providers` | `[]` | IdP aliases to delete. |
|
||||
| `keycloak_removed_user_federations` | `[]` | Federation names to delete. |
|
||||
|
||||
See `defaults/main.yml` for the full entry shape of each list.
|
||||
|
||||
## Dependencies
|
||||
|
||||
This role requires the Traefik reverse proxy to be configured and the
|
||||
`proxy` network to be created beforehand (it is referenced as an external
|
||||
network in the Compose file). The `backend` network is created by the
|
||||
Compose project itself.
|
||||
|
||||
## Example playbook
|
||||
|
||||
```yaml
|
||||
- hosts: backend_servers
|
||||
roles:
|
||||
- role: keycloak
|
||||
- role: digitalboard.core.keycloak
|
||||
vars:
|
||||
keycloak_domain: "auth.example.com"
|
||||
keycloak_admin_password: "secure_password"
|
||||
keycloak_postgres_password: "secure_db_password"
|
||||
keycloak_admin_password: "{{ vault_keycloak_admin_password }}"
|
||||
keycloak_postgres_password: "{{ vault_keycloak_pg_password }}"
|
||||
keycloak_provisioning_enabled: true
|
||||
keycloak_oidc_clients:
|
||||
- client_id: nextcloud
|
||||
name: "Nextcloud"
|
||||
client_secret: "{{ vault_nextcloud_client_secret }}"
|
||||
redirect_uris:
|
||||
- "https://nextcloud.example.com/apps/user_oidc/code"
|
||||
```
|
||||
|
||||
License
|
||||
-------
|
||||
## License
|
||||
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -1,35 +1,27 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy Keycloak with a PostgreSQL backend via Docker Compose behind Traefik
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.1
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- keycloak
|
||||
- oidc
|
||||
- sso
|
||||
- docker
|
||||
- traefik
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
124
roles/nextcloud/README.md
Normal file
124
roles/nextcloud/README.md
Normal file
|
|
@ -0,0 +1,124 @@
|
|||
# Nextcloud
|
||||
|
||||
Ansible role to deploy [Nextcloud](https://nextcloud.com/) (fpm) with
|
||||
Postgres and Redis via Docker Compose, optional Collabora WOPI
|
||||
integration, optional draw.io integration, optional notify_push
|
||||
companion, optional S3 primary storage, plus OIDC and LDAP user
|
||||
backends.
|
||||
|
||||
## What this role does
|
||||
|
||||
- Renders the Compose stack with traefik labels and TLS
|
||||
- Installs and enables a configurable list of Nextcloud apps idempotently
|
||||
- Configures Collabora (richdocuments), draw.io, OIDC providers and
|
||||
LDAP via `occ` — every setting is read first and only written when
|
||||
the stored value differs, so re-runs don't churn
|
||||
- Sets up notify_push (when enabled)
|
||||
- Applies an in-container PHP source workaround for the upstream
|
||||
`UserConfig::getValueBool` TypeError (nextcloud/server#59629, fixed in
|
||||
master via PR #59646 with no stable33 backport before 33.0.4).
|
||||
Idempotent via grep guard; remove the patch task once
|
||||
`nextcloud_image` is >= 33.0.4.
|
||||
|
||||
## Requirements
|
||||
|
||||
- Docker and Docker Compose installed on the target host
|
||||
- Ansible collection: `community.docker`
|
||||
- Traefik with a shared `nextcloud_traefik_network` (default `proxy`)
|
||||
|
||||
## Role variables
|
||||
|
||||
Full spec with types and defaults: `meta/argument_specs.yml`. The most
|
||||
common overrides:
|
||||
|
||||
### Service
|
||||
|
||||
- `nextcloud_domains`: FQDNs the router accepts. First entry is the
|
||||
canonical hostname (used for `OVERWRITEHOST` and notify_push setup).
|
||||
Further entries cover internal `*.int.*` names so Collabora's WOPI
|
||||
callback hits the instance on a name with a valid cert.
|
||||
- `nextcloud_admin_password`, `nextcloud_postgres_password` (required).
|
||||
- `nextcloud_memory_limit_mb`, `nextcloud_upload_limit_mb`.
|
||||
|
||||
### Collabora
|
||||
|
||||
- `nextcloud_enable_collabora`: toggle integration with a separately
|
||||
deployed Collabora server (see the `collabora` role).
|
||||
- `nextcloud_collabora_domain`: server-to-server hostname.
|
||||
- `nextcloud_collabora_public_domain` (optional): browser-facing
|
||||
hostname when split-horizon uses different names.
|
||||
|
||||
### Draw.io
|
||||
|
||||
- `nextcloud_enable_drawio`: enable the `integration_drawio` app.
|
||||
- `nextcloud_drawio_url`: public draw.io URL.
|
||||
- `nextcloud_drawio_theme`, `nextcloud_drawio_offline`.
|
||||
|
||||
### Notify push
|
||||
|
||||
- `nextcloud_enable_notify_push`: deploy the notify_push companion.
|
||||
- `nextcloud_notify_push_domain` (optional): override the hostname
|
||||
used by `occ notify_push:setup` to avoid hairpinning through the DMZ.
|
||||
|
||||
### S3 primary storage
|
||||
|
||||
Set `nextcloud_use_s3_storage: true` plus the `nextcloud_s3_*` block to
|
||||
point Nextcloud at an external S3-compatible store (e.g. Garage, MinIO).
|
||||
|
||||
### OIDC
|
||||
|
||||
`nextcloud_oidc_providers` is a list of OIDC providers registered with
|
||||
`user_oidc`. Required fields per entry: `identifier`, `display_name`,
|
||||
`client_id`, `client_secret`, `discovery_url`.
|
||||
|
||||
### LDAP
|
||||
|
||||
Set `nextcloud_ldap_enabled: true` and provide `nextcloud_ldap_config`
|
||||
as a dict of `occ ldap:set-config s01 KEY VALUE` pairs. The role reads
|
||||
the current LDAP config via `occ ldap:show-config s01 --output=json`
|
||||
and only calls `ldap:set-config` for keys whose stored value differs.
|
||||
|
||||
## Dependencies
|
||||
|
||||
- Traefik network (`nextcloud_traefik_network`, default `proxy`)
|
||||
- Optional: `collabora`, `drawio`, `garage` roles for the corresponding
|
||||
integrations
|
||||
- Optional: an OIDC provider (Keycloak, authentik) reachable from
|
||||
Nextcloud and a 389ds LDAP server when using `user_ldap`
|
||||
|
||||
## Example playbook
|
||||
|
||||
```yaml
|
||||
- hosts: app_servers
|
||||
roles:
|
||||
- role: digitalboard.core.nextcloud
|
||||
vars:
|
||||
nextcloud_domains:
|
||||
- "cloud.example.com"
|
||||
- "cloud.int.example.com"
|
||||
nextcloud_admin_password: "{{ vault_nextcloud_admin_password }}"
|
||||
nextcloud_postgres_password: "{{ vault_nextcloud_pg_password }}"
|
||||
|
||||
nextcloud_enable_collabora: true
|
||||
nextcloud_collabora_domain: "office.int.example.com"
|
||||
nextcloud_collabora_public_domain: "office.example.com"
|
||||
|
||||
nextcloud_enable_notify_push: true
|
||||
nextcloud_notify_push_domain: "cloud.int.example.com"
|
||||
|
||||
nextcloud_oidc_providers:
|
||||
- identifier: authentik
|
||||
display_name: "Login with Authentik"
|
||||
client_id: nextcloud
|
||||
client_secret: "{{ vault_nextcloud_oidc_secret }}"
|
||||
discovery_url: "https://auth.example.com/application/o/nextcloud/.well-known/openid-configuration"
|
||||
mapping:
|
||||
uid: preferred_username
|
||||
display_name: name
|
||||
email: email
|
||||
groups: groups
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT-0
|
||||
|
|
@ -9,7 +9,12 @@ nextcloud_service_name: nextcloud
|
|||
nextcloud_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ nextcloud_service_name }}"
|
||||
nextcloud_docker_volume_dir: "{{ docker_volume_base_dir }}/{{ nextcloud_service_name }}"
|
||||
|
||||
nextcloud_domain: "nextcloud.local.test"
|
||||
# FQDNs the nextcloud router accepts. The first entry is the canonical
|
||||
# domain (used for OVERWRITEHOST and the notify_push setup); further
|
||||
# entries cover internal *.int.* names so collabora's WOPI callback
|
||||
# hits us on a name with a valid cert.
|
||||
nextcloud_domains:
|
||||
- "nextcloud.local.test"
|
||||
nextcloud_image: "nextcloud:fpm"
|
||||
nextcloud_redis_image: "redis:latest"
|
||||
nextcloud_port: 80
|
||||
|
|
@ -60,6 +65,32 @@ nextcloud_trusted_proxies: "172.16.0.0/12"
|
|||
# File locking and real-time push notifications
|
||||
nextcloud_enable_notify_push: false
|
||||
nextcloud_notify_push_image: "icewind1991/notify_push:1.3.1"
|
||||
# Domain used when calling `occ notify_push:setup`. Defaults to the
|
||||
# first nextcloud_domains entry (the canonical public name). Override
|
||||
# with an internal FQDN to avoid hairpinning the setup check through
|
||||
# the DMZ; the FQDN must also be in nextcloud_domains so the push
|
||||
# router matches it.
|
||||
# nextcloud_notify_push_domain: "cloud.int.example.com"
|
||||
|
||||
# Nextcloud Talk: register external HPB signaling + TURN + STUN
|
||||
# Set to true to run tasks/talk.yml after Nextcloud is up.
|
||||
nextcloud_enable_talk: false
|
||||
|
||||
# HPB signaling servers to register.
|
||||
# Each item: { server: "https://signaling.example.test", secret: "<hpb_shared_secret>", verify: true }
|
||||
nextcloud_talk_signaling_servers: []
|
||||
# Hostnames/URLs to remove via `talk:signaling:delete` before adding the new set.
|
||||
nextcloud_talk_signaling_servers_removed: []
|
||||
|
||||
# TURN servers to register.
|
||||
# Each item: { server: "stun.example.test:443", secret: "<turn_shared_secret>", schemes: "turn,turns", protocols: "udp,tcp" }
|
||||
nextcloud_talk_turn_servers: []
|
||||
# Clear the spreed.turn_servers config key before re-adding (single source of truth)
|
||||
nextcloud_talk_turn_reset_before_add: true
|
||||
|
||||
# Plain STUN endpoints (host:port). Optional; usually not needed if TURN servers handle STUN too.
|
||||
nextcloud_talk_stun_servers: []
|
||||
nextcloud_talk_stun_servers_removed: []
|
||||
|
||||
# Non-default apps to install and enable
|
||||
nextcloud_apps_to_install:
|
||||
|
|
|
|||
253
roles/nextcloud/meta/argument_specs.yml
Normal file
253
roles/nextcloud/meta/argument_specs.yml
Normal file
|
|
@ -0,0 +1,253 @@
|
|||
---
|
||||
argument_specs:
|
||||
main:
|
||||
short_description: Deploy Nextcloud (fpm) + Redis + Postgres via Docker Compose.
|
||||
description:
|
||||
- Renders a Compose stack for Nextcloud with traefik labels, optional
|
||||
Collabora WOPI integration, optional draw.io integration, optional
|
||||
notify_push companion, optional S3 primary storage, OIDC providers
|
||||
and LDAP user backend.
|
||||
- "All C(occ)-driven configuration tasks are idempotent: each setting
|
||||
is read with C(config:app:get) (or C(ldap:show-config)) first and
|
||||
only written when the stored value differs."
|
||||
options:
|
||||
docker_compose_base_dir:
|
||||
type: path
|
||||
default: /etc/docker/compose
|
||||
docker_volume_base_dir:
|
||||
type: path
|
||||
default: /srv/data
|
||||
nextcloud_service_name:
|
||||
type: str
|
||||
default: nextcloud
|
||||
nextcloud_docker_compose_dir:
|
||||
type: path
|
||||
nextcloud_docker_volume_dir:
|
||||
type: path
|
||||
|
||||
nextcloud_domains:
|
||||
type: list
|
||||
elements: str
|
||||
default: ['nextcloud.local.test']
|
||||
description:
|
||||
- FQDNs the nextcloud router accepts. The first entry is the
|
||||
canonical domain (used for C(OVERWRITEHOST) and the
|
||||
C(notify_push) setup). Further entries cover internal C(*.int.*)
|
||||
names so Collabora's WOPI callback hits the instance on a name
|
||||
with a valid certificate.
|
||||
nextcloud_image:
|
||||
type: str
|
||||
default: nextcloud:fpm
|
||||
nextcloud_redis_image:
|
||||
type: str
|
||||
default: redis:latest
|
||||
nextcloud_port:
|
||||
type: int
|
||||
default: 80
|
||||
nextcloud_extra_hosts:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
nextcloud_extra_networks:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
nextcloud_allow_local_remote_servers:
|
||||
type: bool
|
||||
default: false
|
||||
description: Allow requests to local network from Nextcloud (dev only).
|
||||
|
||||
nextcloud_postgres_image:
|
||||
type: str
|
||||
default: postgres:15
|
||||
nextcloud_postgres_db:
|
||||
type: str
|
||||
default: nextcloud
|
||||
nextcloud_postgres_user:
|
||||
type: str
|
||||
default: nextcloud
|
||||
nextcloud_postgres_password:
|
||||
type: str
|
||||
required: true
|
||||
|
||||
nextcloud_backend_network:
|
||||
type: str
|
||||
default: nextcloud-internal
|
||||
nextcloud_traefik_network:
|
||||
type: str
|
||||
default: proxy
|
||||
nextcloud_use_ssl:
|
||||
type: bool
|
||||
default: true
|
||||
|
||||
nextcloud_enable_collabora:
|
||||
type: bool
|
||||
default: true
|
||||
nextcloud_collabora_domain:
|
||||
type: str
|
||||
default: office.local.test
|
||||
description: Hostname Nextcloud uses to talk to Collabora server-to-server.
|
||||
nextcloud_collabora_public_domain:
|
||||
type: str
|
||||
description:
|
||||
- Optional browser-facing hostname for Collabora; defaults to
|
||||
C(nextcloud_collabora_domain) when unset. Set when split-horizon
|
||||
uses different names for browser and server traffic.
|
||||
nextcloud_collabora_disable_cert_verification:
|
||||
type: bool
|
||||
default: false
|
||||
|
||||
nextcloud_enable_drawio:
|
||||
type: bool
|
||||
default: false
|
||||
description: Enable the integration_drawio Nextcloud app and configure the URL/theme.
|
||||
nextcloud_drawio_url:
|
||||
type: str
|
||||
default: ''
|
||||
description: Public draw.io URL used by the integration_drawio app.
|
||||
nextcloud_drawio_theme:
|
||||
type: str
|
||||
choices: [kennedy, atlas, dark, sketch, min]
|
||||
default: kennedy
|
||||
nextcloud_drawio_offline:
|
||||
type: str
|
||||
choices: ['yes', 'no']
|
||||
default: 'yes'
|
||||
|
||||
nextcloud_use_s3_storage:
|
||||
type: bool
|
||||
default: false
|
||||
description: Use S3 primary object storage instead of the local data dir.
|
||||
nextcloud_s3_key:
|
||||
type: str
|
||||
default: changeme
|
||||
nextcloud_s3_secret:
|
||||
type: str
|
||||
default: changeme
|
||||
nextcloud_s3_region:
|
||||
type: str
|
||||
default: us-east-1
|
||||
nextcloud_s3_bucket:
|
||||
type: str
|
||||
default: nextcloud
|
||||
nextcloud_s3_host:
|
||||
type: str
|
||||
default: s3.example.com
|
||||
nextcloud_s3_port:
|
||||
type: int
|
||||
default: 443
|
||||
nextcloud_s3_ssl:
|
||||
type: bool
|
||||
default: true
|
||||
nextcloud_s3_usepath_style:
|
||||
type: bool
|
||||
default: true
|
||||
nextcloud_s3_autocreate:
|
||||
type: bool
|
||||
default: false
|
||||
|
||||
nextcloud_admin_user:
|
||||
type: str
|
||||
default: admin
|
||||
nextcloud_admin_password:
|
||||
type: str
|
||||
required: true
|
||||
nextcloud_memory_limit_mb:
|
||||
type: int
|
||||
default: 1024
|
||||
nextcloud_upload_limit_mb:
|
||||
type: int
|
||||
default: 2048
|
||||
nextcloud_scale_factor:
|
||||
type: int
|
||||
default: 2
|
||||
|
||||
nextcloud_trusted_proxies:
|
||||
type: str
|
||||
default: '172.16.0.0/12'
|
||||
description: Trusted proxy CIDR(s) — by default the Docker internal range.
|
||||
|
||||
nextcloud_enable_notify_push:
|
||||
type: bool
|
||||
default: false
|
||||
nextcloud_notify_push_image:
|
||||
type: str
|
||||
default: icewind1991/notify_push:1.3.1
|
||||
nextcloud_notify_push_domain:
|
||||
type: str
|
||||
description:
|
||||
- Hostname used when calling C(occ notify_push:setup). Defaults to
|
||||
the first C(nextcloud_domains) entry. Override with an internal
|
||||
FQDN to avoid hairpinning the setup check through the DMZ; the
|
||||
FQDN must also be in C(nextcloud_domains).
|
||||
|
||||
nextcloud_apps_to_install:
|
||||
type: list
|
||||
elements: str
|
||||
default:
|
||||
- groupfolders
|
||||
- richdocuments
|
||||
- spreed
|
||||
- user_ldap
|
||||
- user_oidc
|
||||
- whiteboard
|
||||
- files_lock
|
||||
- notify_push
|
||||
description:
|
||||
- Non-default Nextcloud apps to install + enable.
|
||||
Install/enable detection is idempotent — re-runs report C(ok)
|
||||
when the app is already present and enabled.
|
||||
|
||||
nextcloud_oidc_allow_selfsigned:
|
||||
type: bool
|
||||
default: false
|
||||
nextcloud_oidc_providers:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
description: OIDC providers registered with the user_oidc app.
|
||||
options:
|
||||
identifier:
|
||||
type: str
|
||||
required: true
|
||||
display_name:
|
||||
type: str
|
||||
required: true
|
||||
client_id:
|
||||
type: str
|
||||
required: true
|
||||
client_secret:
|
||||
type: str
|
||||
required: true
|
||||
discovery_url:
|
||||
type: str
|
||||
required: true
|
||||
scope:
|
||||
type: str
|
||||
default: openid email profile
|
||||
unique_uid:
|
||||
type: bool
|
||||
default: true
|
||||
check_bearer:
|
||||
type: bool
|
||||
default: false
|
||||
send_id_token_hint:
|
||||
type: bool
|
||||
default: true
|
||||
mapping:
|
||||
type: dict
|
||||
nextcloud_oidc_providers_removed:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
|
||||
nextcloud_ldap_enabled:
|
||||
type: bool
|
||||
default: false
|
||||
nextcloud_ldap_config:
|
||||
type: dict
|
||||
default: {}
|
||||
description:
|
||||
- Key/value pairs passed to C(occ ldap:set-config s01 KEY VALUE).
|
||||
The role reads the current config first and only invokes
|
||||
C(set-config) when a stored value differs.
|
||||
28
roles/nextcloud/meta/main.yml
Normal file
28
roles/nextcloud/meta/main.yml
Normal file
|
|
@ -0,0 +1,28 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: digitalboard
|
||||
description: Deploy Nextcloud (fpm) + Redis + Postgres via Docker Compose behind Traefik
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
galaxy_tags:
|
||||
- nextcloud
|
||||
- files
|
||||
- collabora
|
||||
- oidc
|
||||
- docker
|
||||
- traefik
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
|
|
@ -1,22 +1,55 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# tasks file for configuring Collabora in Nextcloud
|
||||
- name: Configure Collabora WOPI URL
|
||||
- name: Read current richdocuments config values
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:get richdocuments {{ item }}
|
||||
loop:
|
||||
- wopi_url
|
||||
- public_wopi_url
|
||||
- disable_certificate_verification
|
||||
- wopi_allowlist
|
||||
register: _richdocuments_current
|
||||
changed_when: false
|
||||
failed_when: false
|
||||
|
||||
- name: Build map of current richdocuments config
|
||||
ansible.builtin.set_fact:
|
||||
_richdocuments_cfg: "{{ _richdocuments_cfg | default({}) | combine({item.item: (item.stdout | default('')).strip()}) }}"
|
||||
loop: "{{ _richdocuments_current.results }}"
|
||||
loop_control:
|
||||
label: "{{ item.item }}"
|
||||
|
||||
- name: Configure Collabora WOPI URL (server-to-server)
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:set richdocuments wopi_url --value=https://{{ nextcloud_collabora_domain }}
|
||||
when: _richdocuments_cfg.wopi_url != ('https://' ~ nextcloud_collabora_domain)
|
||||
|
||||
- name: Configure Collabora public WOPI URL (browser-facing)
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:set richdocuments public_wopi_url --value=https://{{ nextcloud_collabora_public_domain }}
|
||||
when:
|
||||
- nextcloud_collabora_public_domain is defined
|
||||
- nextcloud_collabora_public_domain != nextcloud_collabora_domain
|
||||
- _richdocuments_cfg.public_wopi_url != ('https://' ~ nextcloud_collabora_public_domain)
|
||||
|
||||
- name: Configure certificate verification for Collabora
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:set richdocuments disable_certificate_verification --value={{ nextcloud_collabora_disable_cert_verification | ternary('yes', 'no') }}
|
||||
when: _richdocuments_cfg.disable_certificate_verification != (nextcloud_collabora_disable_cert_verification | ternary('yes', 'no'))
|
||||
|
||||
- name: Set Collabora WOPI allowlist
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:set richdocuments wopi_allowlist --value=''
|
||||
when: _richdocuments_cfg.wopi_allowlist | default('') != ''
|
||||
|
||||
- name: Activate richdocuments configuration (fetch discovery from Collabora)
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ richdocuments:activate-config
|
||||
command: php /var/www/html/occ richdocuments:activate-config
|
||||
changed_when: false
|
||||
|
|
@ -2,18 +2,41 @@
|
|||
---
|
||||
# tasks file for configuring draw.io in Nextcloud
|
||||
|
||||
- name: Read current drawio config values
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:get drawio {{ item }}
|
||||
loop:
|
||||
- DrawioUrl
|
||||
- DrawioTheme
|
||||
- DrawioOffline
|
||||
register: _drawio_current
|
||||
changed_when: false
|
||||
failed_when: false
|
||||
|
||||
- name: Build map of current drawio config
|
||||
ansible.builtin.set_fact:
|
||||
_drawio_cfg: "{{ _drawio_cfg | default({}) | combine({item.item: (item.stdout | default('')).strip()}) }}"
|
||||
loop: "{{ _drawio_current.results }}"
|
||||
loop_control:
|
||||
label: "{{ item.item }}"
|
||||
|
||||
- name: Configure draw.io URL
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:set drawio DrawioUrl --value={{ nextcloud_drawio_url }}
|
||||
when: nextcloud_drawio_url | length > 0
|
||||
when:
|
||||
- nextcloud_drawio_url | length > 0
|
||||
- _drawio_cfg.DrawioUrl != nextcloud_drawio_url
|
||||
|
||||
- name: Configure draw.io theme
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:set drawio DrawioTheme --value={{ nextcloud_drawio_theme }}
|
||||
when: _drawio_cfg.DrawioTheme != (nextcloud_drawio_theme | string)
|
||||
|
||||
- name: Configure draw.io offline mode
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:set drawio DrawioOffline --value={{ nextcloud_drawio_offline }}
|
||||
command: php /var/www/html/occ config:app:set drawio DrawioOffline --value={{ nextcloud_drawio_offline }}
|
||||
when: _drawio_cfg.DrawioOffline != (nextcloud_drawio_offline | string)
|
||||
|
|
@ -15,6 +15,24 @@
|
|||
command: php /var/www/html/occ ldap:create-empty-config
|
||||
when: "'s01' not in ldap_show_config.stdout"
|
||||
|
||||
- name: Read current LDAP config for s01
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_service_name }}-nextcloud-1"
|
||||
command: php /var/www/html/occ ldap:show-config s01 --output=json
|
||||
register: _ldap_show_s01
|
||||
changed_when: false
|
||||
failed_when: false
|
||||
|
||||
- name: Parse current LDAP config
|
||||
ansible.builtin.set_fact:
|
||||
_ldap_current: >-
|
||||
{{
|
||||
(_ldap_show_s01.stdout | from_json) if (
|
||||
(_ldap_show_s01.stdout | default('') | trim) is match('^[\\[{]')
|
||||
) else {}
|
||||
}}
|
||||
when: _ldap_show_s01.rc | default(1) == 0
|
||||
|
||||
- name: Configure LDAP settings
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_service_name }}-nextcloud-1"
|
||||
|
|
@ -29,6 +47,7 @@
|
|||
loop_control:
|
||||
label: "{{ item.key }}"
|
||||
no_log: true
|
||||
when: ((_ldap_current | default({})).get(item.key) | default(none) | string) != (item.value | string)
|
||||
|
||||
- name: Test LDAP configuration
|
||||
community.docker.docker_container_exec:
|
||||
|
|
|
|||
|
|
@ -49,6 +49,42 @@
|
|||
project_src: "{{ nextcloud_docker_compose_dir }}"
|
||||
state: present
|
||||
|
||||
# nextcloud/server#59629: UserConfig::getValueBool() passes a non-string from
|
||||
# getTypedValue() into strtolower() under PHP 8.x + OPcache, throwing a
|
||||
# TypeError on every authenticated request once user_ldap is involved. Fix
|
||||
# is in master (PR #59646) but no stable33 backport landed before 33.0.4.
|
||||
# Apply the (string) cast in-container; idempotent via grep guard. Remove
|
||||
# this block once nextcloud_image >= 33.0.4.
|
||||
- name: Discover nextcloud php containers needing the UserConfig patch
|
||||
ansible.builtin.shell:
|
||||
cmd: >-
|
||||
docker ps --filter "label=com.docker.compose.project={{ nextcloud_docker_compose_dir | basename }}"
|
||||
--filter "label=com.docker.compose.service=nextcloud"
|
||||
--format '{% raw %}{{.Names}}{% endraw %}'
|
||||
register: _nextcloud_php_containers
|
||||
changed_when: false
|
||||
|
||||
- name: Check UserConfig.php patch status per container
|
||||
ansible.builtin.shell:
|
||||
cmd: >-
|
||||
docker exec {{ item }} grep -q "strtolower((string)" /var/www/html/lib/private/Config/UserConfig.php
|
||||
loop: "{{ _nextcloud_php_containers.stdout_lines }}"
|
||||
register: _nextcloud_userconfig_check
|
||||
changed_when: false
|
||||
failed_when: false
|
||||
|
||||
- name: Apply UserConfig::getValueBool string-cast workaround
|
||||
ansible.builtin.shell:
|
||||
cmd: >-
|
||||
docker exec {{ item.item }}
|
||||
sed -i 's|$b = strtolower($this->getTypedValue|$b = strtolower((string)$this->getTypedValue|'
|
||||
/var/www/html/lib/private/Config/UserConfig.php
|
||||
loop: "{{ _nextcloud_userconfig_check.results }}"
|
||||
loop_control:
|
||||
label: "{{ item.item }}"
|
||||
when:
|
||||
- item.rc | default(1) != 0
|
||||
|
||||
- name: Wait for Nextcloud to be ready
|
||||
ansible.builtin.shell:
|
||||
cmd: docker compose exec -T nextcloud php /var/www/html/occ status --output=json
|
||||
|
|
@ -91,3 +127,7 @@
|
|||
- name: Configure OIDC providers
|
||||
ansible.builtin.include_tasks: oidc.yml
|
||||
when: nextcloud_oidc_providers | length > 0 or nextcloud_oidc_providers_removed | length > 0
|
||||
|
||||
- name: Configure Nextcloud Talk (HPB + TURN + STUN)
|
||||
ansible.builtin.include_tasks: talk.yml
|
||||
when: nextcloud_enable_talk
|
||||
|
|
|
|||
|
|
@ -2,7 +2,16 @@
|
|||
---
|
||||
# tasks file for configuring notify_push in Nextcloud
|
||||
|
||||
- name: Read current notify_push base endpoint
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:get notify_push base_endpoint
|
||||
register: _notify_push_current
|
||||
changed_when: false
|
||||
failed_when: false
|
||||
|
||||
- name: Configure notify_push base endpoint
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ notify_push:setup https://{{ nextcloud_domain }}/push
|
||||
command: php /var/www/html/occ notify_push:setup https://{{ nextcloud_notify_push_domain | default(nextcloud_domains[0]) }}/push
|
||||
when: (_notify_push_current.stdout | default('') | trim) != ('https://' ~ (nextcloud_notify_push_domain | default(nextcloud_domains[0])) ~ '/push')
|
||||
|
|
@ -8,7 +8,9 @@
|
|||
chdir: "{{ nextcloud_docker_compose_dir }}"
|
||||
loop: "{{ nextcloud_apps_to_install }}"
|
||||
register: app_install_result
|
||||
changed_when: "'installed' in app_install_result.stdout"
|
||||
changed_when:
|
||||
- "'already installed' not in app_install_result.stdout"
|
||||
- "'installed' in app_install_result.stdout"
|
||||
failed_when:
|
||||
- app_install_result.rc != 0
|
||||
- "'already installed' not in app_install_result.stdout"
|
||||
|
|
@ -19,7 +21,9 @@
|
|||
chdir: "{{ nextcloud_docker_compose_dir }}"
|
||||
loop: "{{ nextcloud_apps_to_install }}"
|
||||
register: app_enable_result
|
||||
changed_when: "'enabled' in app_enable_result.stdout"
|
||||
changed_when:
|
||||
- "'already enabled' not in app_enable_result.stdout"
|
||||
- "'enabled' in app_enable_result.stdout"
|
||||
failed_when:
|
||||
- app_enable_result.rc != 0
|
||||
- "'already enabled' not in app_enable_result.stdout"
|
||||
|
|
|
|||
70
roles/nextcloud/tasks/talk.yml
Normal file
70
roles/nextcloud/tasks/talk.yml
Normal file
|
|
@ -0,0 +1,70 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# tasks file for configuring Nextcloud Talk HPB + TURN + STUN registration
|
||||
|
||||
# --- HPB / signaling -----------------------------------------------------------
|
||||
|
||||
- name: Remove HPB signaling servers no longer in use
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ talk:signaling:delete {{ item }}
|
||||
loop: "{{ nextcloud_talk_signaling_servers_removed }}"
|
||||
register: _talk_sig_removed
|
||||
changed_when: "'deleted' in (_talk_sig_removed.stdout | default(''))"
|
||||
failed_when:
|
||||
- _talk_sig_removed.rc != 0
|
||||
- "'is not configured' not in (_talk_sig_removed.stderr | default(''))"
|
||||
|
||||
- name: Register HPB signaling servers
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: >
|
||||
php /var/www/html/occ talk:signaling:add
|
||||
{{ item.server }}
|
||||
{{ item.secret }}
|
||||
{% if item.verify | default(true) %}--verify{% endif %}
|
||||
loop: "{{ nextcloud_talk_signaling_servers }}"
|
||||
no_log: true
|
||||
|
||||
# --- TURN ----------------------------------------------------------------------
|
||||
# `talk:turn:add` appends without deduplication, so on each run we first clear
|
||||
# the list via the underlying app config key (turn_servers, JSON array) and
|
||||
# then re-add the declared set. This keeps the host_vars list as the single
|
||||
# source of truth.
|
||||
|
||||
- name: Reset TURN server list before re-applying
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ config:app:set spreed turn_servers --value='[]'
|
||||
when: nextcloud_talk_turn_reset_before_add | bool
|
||||
|
||||
- name: Register TURN servers
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: >
|
||||
php /var/www/html/occ talk:turn:add
|
||||
{{ item.schemes | default('turn,turns') }}
|
||||
{{ item.server }}
|
||||
{{ item.protocols | default('udp,tcp') }}
|
||||
--secret={{ item.secret }}
|
||||
loop: "{{ nextcloud_talk_turn_servers }}"
|
||||
no_log: true
|
||||
|
||||
# --- STUN ----------------------------------------------------------------------
|
||||
|
||||
- name: Remove STUN servers no longer in use
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ talk:stun:delete {{ item }}
|
||||
loop: "{{ nextcloud_talk_stun_servers_removed }}"
|
||||
register: _talk_stun_removed
|
||||
changed_when: "'deleted' in (_talk_stun_removed.stdout | default(''))"
|
||||
failed_when:
|
||||
- _talk_stun_removed.rc != 0
|
||||
- "'is not configured' not in (_talk_stun_removed.stderr | default(''))"
|
||||
|
||||
- name: Register STUN servers
|
||||
community.docker.docker_container_exec:
|
||||
container: "{{ nextcloud_docker_compose_dir | basename }}-nextcloud-1"
|
||||
command: php /var/www/html/occ talk:stun:add {{ item }}
|
||||
loop: "{{ nextcloud_talk_stun_servers }}"
|
||||
|
|
@ -35,10 +35,13 @@ services:
|
|||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network={{ nextcloud_traefik_network }}
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}.rule=Host(`{{ nextcloud_domain }}`)
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}.rule={% for d in nextcloud_domains %}Host(`{{ d }}`){% if not loop.last %} || {% endif %}{% endfor +%}
|
||||
{% if nextcloud_use_ssl %}
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}.entrypoints=websecure
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}.entrypoints=web
|
||||
{% endif %}
|
||||
|
|
@ -60,7 +63,7 @@ services:
|
|||
PHP_MEMORY_LIMIT: {{ nextcloud_memory_limit_mb }}M
|
||||
PHP_UPLOAD_LIMIT: {{ nextcloud_upload_limit_mb }}M
|
||||
OVERWRITEPROTOCOL: https
|
||||
OVERWRITEHOST: {{ nextcloud_domain }}
|
||||
OVERWRITEHOST: {{ nextcloud_domains[0] }}
|
||||
TRUSTED_PROXIES: "{{ nextcloud_trusted_proxies }}"
|
||||
volumes:
|
||||
- {{ nextcloud_docker_volume_dir }}/nextcloud/:/var/www/html
|
||||
|
|
@ -69,6 +72,12 @@ services:
|
|||
{% for net in nextcloud_extra_networks %}
|
||||
- {{ net }}
|
||||
{% endfor %}
|
||||
{% if nextcloud_extra_hosts is defined and nextcloud_extra_hosts | length > 0 %}
|
||||
extra_hosts:
|
||||
{% for host in nextcloud_extra_hosts %}
|
||||
- "{{ host }}"
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
|
||||
nextcloud:
|
||||
image: {{ nextcloud_image }}
|
||||
|
|
@ -88,7 +97,7 @@ services:
|
|||
PHP_MEMORY_LIMIT: {{ nextcloud_memory_limit_mb }}M
|
||||
PHP_UPLOAD_LIMIT: {{ nextcloud_upload_limit_mb }}M
|
||||
OVERWRITEPROTOCOL: https
|
||||
OVERWRITEHOST: {{ nextcloud_domain }}
|
||||
OVERWRITEHOST: {{ nextcloud_domains[0] }}
|
||||
TRUSTED_PROXIES: "{{ nextcloud_trusted_proxies }}"
|
||||
{% if nextcloud_use_s3_storage %}
|
||||
OBJECTSTORE_S3_KEY: {{ nextcloud_s3_key }}
|
||||
|
|
@ -127,7 +136,7 @@ services:
|
|||
environment:
|
||||
PORT: "7867"
|
||||
REDIS_URL: "redis://redis:6379"
|
||||
DATABASE_URL: "postgres://{{ nextcloud_postgres_user }}:{{ nextcloud_postgres_password }}@db:5432/{{ nextcloud_postgres_db }}"
|
||||
DATABASE_URL: "postgres://{{ nextcloud_postgres_user | urlencode | replace('/', '%2F') }}:{{ nextcloud_postgres_password | urlencode | replace('/', '%2F') }}@db:5432/{{ nextcloud_postgres_db }}"
|
||||
DATABASE_PREFIX: "oc_"
|
||||
NEXTCLOUD_URL: "http://nginx"
|
||||
networks:
|
||||
|
|
@ -136,11 +145,14 @@ services:
|
|||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network={{ nextcloud_traefik_network }}
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}-push.rule=Host(`{{ nextcloud_domain }}`) && PathPrefix(`/push`)
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}-push.rule=({% for d in nextcloud_domains %}Host(`{{ d }}`){% if not loop.last %} || {% endif %}{% endfor %}) && PathPrefix(`/push`)
|
||||
- traefik.http.services.{{ nextcloud_service_name }}-push.loadbalancer.server.port=7867
|
||||
{% if nextcloud_use_ssl %}
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}-push.entrypoints=websecure
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}-push.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}-push.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.{{ nextcloud_service_name }}-push.entrypoints=web
|
||||
{% endif %}
|
||||
|
|
|
|||
|
|
@ -1,38 +1,43 @@
|
|||
Role Name
|
||||
=========
|
||||
# opencloud
|
||||
|
||||
A brief description of the role goes here.
|
||||
Deploys [OpenCloud](https://opencloud.eu/) (`opencloudeu/opencloud`) as a
|
||||
self-contained file platform via Docker Compose behind Traefik. Supports
|
||||
the built-in IdP or external OIDC, optional S3 storage, external LDAP,
|
||||
Collabora and draw.io integration, and OIDC-claim-based role assignment.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
## Role variables
|
||||
|
||||
Any pre-requisites that may not be covered by Ansible itself or the role should be mentioned here. For instance, if the role uses the EC2 module, it may be a good idea to mention in this section that the boto package is required.
|
||||
A selection of the most relevant variables — see
|
||||
[defaults/main.yml](defaults/main.yml) for the full set.
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
| Variable | Default | Description |
|
||||
| --- | --- | --- |
|
||||
| `opencloud_domain` | `opencloud.local.test` | FQDN the Traefik router matches. |
|
||||
| `opencloud_image` | `opencloudeu/opencloud:latest` | Container image. |
|
||||
| `opencloud_port` | `9200` | Container port Traefik forwards to. |
|
||||
| `opencloud_admin_password` | `admin` | Initial admin password — **override this**. |
|
||||
| `opencloud_traefik_network` | `proxy` | Docker network shared with Traefik. |
|
||||
| `opencloud_use_ssl` | `true` | Enable the TLS resolver on the router. |
|
||||
| `opencloud_oidc_issuer` | `""` | External OIDC issuer; empty uses the built-in IdP. |
|
||||
| `opencloud_use_s3_storage` | `false` | Use S3 storage instead of local disk. |
|
||||
| `opencloud_ldap_uri` | `""` | External LDAP URI; empty uses the built-in directory. |
|
||||
| `opencloud_collabora_domain` | `""` | Collabora server domain; set with `opencloud_wopi_domain` to enable editing. |
|
||||
| `opencloud_wopi_domain` | `""` | WOPI server FQDN; required alongside `opencloud_collabora_domain`. |
|
||||
| `opencloud_drawio_url` | `""` | draw.io URL; set to enable diagram editing. |
|
||||
| `opencloud_role_assignment_driver` | `default` | Set to `oidc` to map OIDC claims to roles. |
|
||||
|
||||
A description of the settable variables for this role should go here, including any variables that are in defaults/main.yml, vars/main.yml, and any variables that can/should be set via parameters to the role. Any variables that are read from other roles and/or the global scope (ie. hostvars, group vars, etc.) should be mentioned here as well.
|
||||
## Example
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
```yaml
|
||||
- hosts: services
|
||||
become: true
|
||||
roles:
|
||||
- role: digitalboard.core.opencloud
|
||||
vars:
|
||||
opencloud_domain: "opencloud.example.com"
|
||||
opencloud_admin_password: "{{ vault_opencloud_admin_password }}"
|
||||
```
|
||||
|
||||
A list of other roles hosted on Galaxy should go here, plus any details in regards to parameters that may need to be set for other roles, or variables that are used from other roles.
|
||||
## License
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
Including an example of how to use your role (for instance, with variables passed in as parameters) is always nice for users too:
|
||||
|
||||
- hosts: servers
|
||||
roles:
|
||||
- { role: username.rolename, x: 42 }
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
BSD
|
||||
|
||||
Author Information
|
||||
------------------
|
||||
|
||||
An optional section for the role authors to include contact information, or a website (HTML is not allowed).
|
||||
MIT-0
|
||||
|
|
|
|||
|
|
@ -5,4 +5,4 @@
|
|||
- name: restart opencloud
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ opencloud_docker_compose_dir }}"
|
||||
state: restarted
|
||||
state: present
|
||||
|
|
@ -1,35 +1,27 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: your name
|
||||
description: your role description
|
||||
company: your company (optional)
|
||||
author: digitalboard
|
||||
description: Deploy OpenCloud file platform via Docker Compose behind Traefik
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
|
||||
# If the issue tracker for your role is not on github, uncomment the
|
||||
# next line and provide a value
|
||||
# issue_tracker_url: http://example.com/issue/tracker
|
||||
min_ansible_version: "2.14"
|
||||
|
||||
# Choose a valid license ID from https://spdx.org - some suggested licenses:
|
||||
# - BSD-3-Clause (default)
|
||||
# - MIT
|
||||
# - GPL-2.0-or-later
|
||||
# - GPL-3.0-only
|
||||
# - Apache-2.0
|
||||
# - CC-BY-4.0
|
||||
license: license (GPL-2.0-or-later, MIT, etc)
|
||||
platforms:
|
||||
- name: Debian
|
||||
versions:
|
||||
- bookworm
|
||||
- name: Ubuntu
|
||||
versions:
|
||||
- jammy
|
||||
- noble
|
||||
|
||||
min_ansible_version: 2.2
|
||||
|
||||
# If this a Container Enabled role, provide the minimum Ansible Container version.
|
||||
# min_ansible_container_version:
|
||||
|
||||
galaxy_tags: []
|
||||
# List tags for your role here, one per line. A tag is a keyword that describes
|
||||
# and categorizes the role. Users find roles by searching for tags. Be sure to
|
||||
# remove the '[]' above, if you add tags to this list.
|
||||
#
|
||||
# NOTE: A tag is limited to a single word comprised of alphanumeric characters.
|
||||
# Maximum 20 tags per role.
|
||||
galaxy_tags:
|
||||
- opencloud
|
||||
- files
|
||||
- storage
|
||||
- docker
|
||||
- traefik
|
||||
- digitalboard
|
||||
|
||||
dependencies: []
|
||||
# List your role dependencies here, one per line. Be sure to remove the '[]' above,
|
||||
# if you add dependencies to this list.
|
||||
|
|
|
|||
219
roles/opnform/README.md
Normal file
219
roles/opnform/README.md
Normal file
|
|
@ -0,0 +1,219 @@
|
|||
# opnform
|
||||
|
||||
Deploy [OpnForm](https://github.com/OpnForm/OpnForm) as a self-contained
|
||||
Docker Compose stack behind Traefik.
|
||||
|
||||
## What this role does
|
||||
|
||||
- Deploys the full official OpnForm stack: `api`, `api-worker`, `api-scheduler`,
|
||||
`ui`, `db` (Postgres), `redis`, and `ingress` (nginx)
|
||||
- Configures all environment variables for self-hosted production use
|
||||
- Integrates the ingress container with an existing Traefik proxy network
|
||||
- Waits for the API container to become healthy before returning
|
||||
|
||||
## What this role does NOT do
|
||||
|
||||
- Does not migrate existing OpnForm databases — only bootstraps fresh
|
||||
installs (admin registration + OIDC connection are idempotent)
|
||||
|
||||
## Architecture note: why two reverse proxies?
|
||||
|
||||
```
|
||||
Browser → Traefik (TLS, host routing) → ingress-nginx → api (PHP-FPM) / ui (Nuxt)
|
||||
```
|
||||
|
||||
The `ingress` container looks like a redundant proxy next to Traefik but
|
||||
does a different job. OpnForm's `api` image is **PHP-FPM only** — it
|
||||
speaks the FastCGI protocol on port 9000, not HTTP. Traefik cannot
|
||||
translate FastCGI, so the ingress nginx is required to:
|
||||
|
||||
- Translate HTTP `/api/*` requests into FastCGI calls to `api:9000`
|
||||
- Rewrite request URIs via the `$api_uri` map
|
||||
- Set Laravel-specific FastCGI params (`SCRIPT_FILENAME`, `REQUEST_URI`)
|
||||
- Reverse-proxy `/` to the Nuxt UI container on port 3000
|
||||
|
||||
Both containers run on the same Docker network on the same host, so the
|
||||
performance overhead of the extra hop is negligible (in-kernel memory
|
||||
copy, not a real network round-trip). Removing the ingress would require
|
||||
a custom OpnForm image with a built-in HTTP server, which is out of
|
||||
scope for this role.
|
||||
|
||||
## Required variables
|
||||
|
||||
Provide via OpenBao, Ansible Vault, or extra-vars. **Never commit real
|
||||
secrets to version control.**
|
||||
|
||||
| Variable | Format | Generate with |
|
||||
|---|---|---|
|
||||
| `opnform_app_key` | `base64:<32 bytes base64>` | `echo "base64:$(openssl rand -base64 32)"` |
|
||||
| `opnform_jwt_secret` | 32-byte hex string | `openssl rand -hex 32` |
|
||||
| `opnform_front_api_secret` | 32-byte hex string | `openssl rand -hex 32` |
|
||||
| `opnform_db_password` | strong password | `openssl rand -base64 24` |
|
||||
|
||||
`opnform_app_key` MUST keep the `base64:` prefix — the validation task
|
||||
asserts it. `opnform_jwt_secret` and `opnform_front_api_secret` have no
|
||||
enforced format; any sufficiently random value works.
|
||||
|
||||
When `opnform_oidc_enabled` is `true`:
|
||||
|
||||
| Variable | Source |
|
||||
|---|---|
|
||||
| `opnform_oidc_client_secret` | from your Keycloak/Authentik client |
|
||||
|
||||
The `assert` task at the top of the role will fail fast if any secret is
|
||||
missing or malformed.
|
||||
|
||||
## First login
|
||||
|
||||
OpnForm in self-hosted mode does **not** ship a pre-seeded admin user.
|
||||
The first user to register becomes the owner of the default workspace,
|
||||
and further public registration is disabled afterwards (additional
|
||||
users must be invited via the Admin UI).
|
||||
|
||||
This role supports two ways to create that first user:
|
||||
|
||||
### Option A — automated bootstrap (recommended)
|
||||
|
||||
Set `opnform_admin_email` and `opnform_admin_password` (ideally from
|
||||
Vault / OpenBao). The role then POSTs to `/api/register` after the
|
||||
API container is healthy, skipping the setup page entirely. The task
|
||||
is idempotent: it does a login check first and only registers if the
|
||||
user does not already exist.
|
||||
|
||||
```yaml
|
||||
opnform_admin_name: "Administrator" # default
|
||||
opnform_admin_email: "admin@example.com"
|
||||
opnform_admin_password: "{{ vault_opnform_admin_password }}"
|
||||
```
|
||||
|
||||
Password rules enforced by OpnForm: minimum 8 characters, at least one
|
||||
letter, one digit, and one of `@$!%*#?&-_+=.,:;<>^()[]{}|~`.
|
||||
|
||||
### Option B — manual setup page
|
||||
|
||||
Leave `opnform_admin_email` / `opnform_admin_password` empty. Visit
|
||||
`opnform_base_url` and complete the setup page in the browser.
|
||||
|
||||
## OIDC setup
|
||||
|
||||
Set `opnform_oidc_enabled: true` and the role provisions an
|
||||
IdentityConnection on the admin's default workspace via
|
||||
`POST /api/open/workspaces/{id}/oidc-connections`. OpnForm enforces a
|
||||
single OIDC connection per workspace, so the task is idempotent: it GETs
|
||||
existing connections first, then either POSTs a new one or PATCHes the
|
||||
existing one to the desired state. PATCHing (rather than skipping when
|
||||
one exists) keeps inventory changes — e.g. a corrected issuer — applied
|
||||
on re-runs instead of leaving stale values in the DB.
|
||||
|
||||
**Prerequisite**: the admin bootstrap must be configured
|
||||
(`opnform_admin_email` + `opnform_admin_password`). The OIDC API
|
||||
requires an authenticated admin token; the role logs in with those
|
||||
credentials to make the call. The validation block fails fast if OIDC
|
||||
is enabled without admin credentials.
|
||||
|
||||
### Required when `opnform_oidc_enabled: true`
|
||||
|
||||
| Variable | Notes |
|
||||
|---|---|
|
||||
| `opnform_oidc_client_secret` | from your IdP, never commit |
|
||||
| `opnform_oidc_domain` | email domain that triggers OIDC (e.g. `example.com`) |
|
||||
|
||||
### Tunables (defaults shown)
|
||||
|
||||
```yaml
|
||||
opnform_oidc_issuer: "https://auth.digitalboard.ch/realms/Digitalboard"
|
||||
opnform_oidc_client_id: "opnform-digitalboard"
|
||||
opnform_oidc_client_name: "Digitalboard" # display name in UI
|
||||
opnform_oidc_slug: "oidc" # used in /auth/{slug}/callback
|
||||
opnform_oidc_scopes: [openid, profile, email, groups]
|
||||
```
|
||||
|
||||
### Group → role mapping
|
||||
|
||||
Two ways, the list takes precedence:
|
||||
|
||||
```yaml
|
||||
# Option 1: full list (any number of mappings)
|
||||
opnform_oidc_group_role_mappings:
|
||||
- idp_group: "opnform-admins"
|
||||
role: admin
|
||||
- idp_group: "opnform-editors"
|
||||
role: editor
|
||||
|
||||
# Option 2: convenience — single admin group
|
||||
opnform_oidc_admin_group: "opnform-admins" # mapped to role=admin
|
||||
```
|
||||
|
||||
Valid roles: `owner`, `admin`, `editor`, `member`.
|
||||
|
||||
### Force OIDC-only login
|
||||
|
||||
```yaml
|
||||
opnform_oidc_force_login: true # default false
|
||||
```
|
||||
|
||||
Sets `OIDC_FORCE_LOGIN=true` on the API: password login is disabled and
|
||||
every user must authenticate via OIDC. The role keeps force-login **off**
|
||||
during the first deploy (the admin/OIDC bootstrap is password-based) and
|
||||
switches it on only after the OIDC connection is provisioned, recreating
|
||||
the API containers. Ensure all real users have addresses under
|
||||
`opnform_oidc_domain` before enabling — there is no password fallback.
|
||||
|
||||
### Direct-SSO entrypoint
|
||||
|
||||
OpnForm has no native way to skip the email login form and jump straight
|
||||
to the IdP. When enabled, the ingress serves a tiny redirect page that
|
||||
calls `/api/auth/{slug}/redirect` (no domain check) and forwards the
|
||||
browser to the IdP authorize URL.
|
||||
|
||||
```yaml
|
||||
opnform_oidc_sso_entrypoint: true # default false
|
||||
opnform_oidc_sso_path: "/sso" # link users to https://<domain>/sso
|
||||
```
|
||||
|
||||
## Networking / split-horizon
|
||||
|
||||
```yaml
|
||||
opnform_extra_domains: [] # extra Host-rule hostnames (OR-combined)
|
||||
opnform_extra_hosts: [] # API container /etc/hosts overrides ("host:ip")
|
||||
```
|
||||
|
||||
`opnform_extra_domains` adds internal `*.int.*` FQDNs so a DMZ
|
||||
reverseproxy can reach a backend hostname covered by the cert.
|
||||
`opnform_extra_hosts` lets the API containers reach the IdP's public FQDN
|
||||
(used in the OIDC `iss` claim) over the LAN when the DMZ has no NAT
|
||||
loopback.
|
||||
|
||||
## Example playbook
|
||||
|
||||
```yaml
|
||||
- name: Deploy OpnForm service
|
||||
hosts: opnform_servers
|
||||
become: true
|
||||
roles:
|
||||
- digitalboard.core.opnform
|
||||
```
|
||||
|
||||
With inventory variables:
|
||||
|
||||
```yaml
|
||||
# group_vars/opnform_servers.yml
|
||||
opnform_domain: forms.digitalboard.ch
|
||||
opnform_base_url: "https://forms.digitalboard.ch"
|
||||
opnform_app_key: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/opnform',
|
||||
mount_point='kv').data.data.app_key }}"
|
||||
opnform_jwt_secret: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/opnform',
|
||||
mount_point='kv').data.data.jwt_secret }}"
|
||||
opnform_front_api_secret: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/opnform',
|
||||
mount_point='kv').data.data.front_api_secret }}"
|
||||
opnform_db_password: "{{ lookup('community.hashi_vault.vault_kv2_get',
|
||||
'digitalboard/opnform',
|
||||
mount_point='kv').data.data.db_password }}"
|
||||
```
|
||||
|
||||
## License
|
||||
|
||||
MIT-0
|
||||
135
roles/opnform/defaults/main.yml
Normal file
135
roles/opnform/defaults/main.yml
Normal file
|
|
@ -0,0 +1,135 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# defaults file for opnform
|
||||
|
||||
# Base directory configuration (inherited from base role or defined here)
|
||||
docker_compose_base_dir: /etc/docker/compose
|
||||
docker_volume_base_dir: /srv/data
|
||||
|
||||
# opnform-specific configuration
|
||||
opnform_service_name: opnform
|
||||
opnform_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ opnform_service_name }}"
|
||||
opnform_docker_volume_dir: "{{ docker_volume_base_dir }}/{{ opnform_service_name }}"
|
||||
opnform_storage_dir: "{{ opnform_docker_volume_dir }}/storage"
|
||||
opnform_db_data_dir: "{{ opnform_docker_volume_dir }}/db"
|
||||
opnform_redis_data_dir: "{{ opnform_docker_volume_dir }}/redis"
|
||||
|
||||
# Service configuration
|
||||
opnform_domain: "forms.local.test"
|
||||
# Additional hostnames the opnform router answers on (e.g. an internal
|
||||
# *.int.* FQDN so a DMZ reverseproxy can hit a backend hostname covered
|
||||
# by the cert).
|
||||
opnform_extra_domains: []
|
||||
# Container-level /etc/hosts overrides for the API containers — needed in
|
||||
# split-horizon setups where the OpnForm API must reach the IdP's public
|
||||
# FQDN (used in the OIDC discovery/iss claim) over the LAN rather than
|
||||
# hairpinning through a DMZ that has no NAT loopback to its own public IP.
|
||||
opnform_extra_hosts: []
|
||||
opnform_base_url: "https://forms.local.test"
|
||||
|
||||
# Images
|
||||
opnform_api_image: "jhumanj/opnform-api:latest"
|
||||
opnform_client_image: "jhumanj/opnform-client:latest"
|
||||
opnform_redis_image: "redis:7"
|
||||
opnform_db_image: "postgres:16"
|
||||
opnform_ingress_image: "nginx:1"
|
||||
|
||||
# REQUIRED SECRETS — must be overridden per-inventory.
|
||||
# Provide via OpenBao lookup, Ansible Vault or extra-vars.
|
||||
# Never commit real keys to version control.
|
||||
#
|
||||
# Generate with:
|
||||
# opnform_app_key: echo "base64:$(openssl rand -base64 32)"
|
||||
# opnform_jwt_secret: openssl rand -hex 32
|
||||
# opnform_front_api_secret: openssl rand -hex 32
|
||||
#
|
||||
# opnform_app_key MUST start with the prefix "base64:" — the validate
|
||||
# task at the top of tasks/main.yml enforces this.
|
||||
opnform_app_key: ""
|
||||
opnform_jwt_secret: ""
|
||||
opnform_front_api_secret: ""
|
||||
|
||||
# Database credentials. opnform_db_password must be overridden; the
|
||||
# validate task fails fast on an empty value.
|
||||
opnform_db_name: "opnform"
|
||||
opnform_db_user: "opnform"
|
||||
opnform_db_password: ""
|
||||
|
||||
# Admin bootstrap — when email+password are set, the role creates the
|
||||
# first user via OpnForm's /api/register endpoint, skipping the
|
||||
# self-hosted setup page. Leave both empty to keep the manual setup flow.
|
||||
# Password must satisfy OpnForm's rules: min 8 chars, contain a letter,
|
||||
# a digit and one of @$!%*#?&-_+=.,:;<>^()[]{}|~
|
||||
# Provide via OpenBao, Ansible Vault or extra-vars.
|
||||
opnform_admin_name: "Administrator"
|
||||
opnform_admin_email: ""
|
||||
opnform_admin_password: ""
|
||||
opnform_admin_hear_about_us: "ansible"
|
||||
|
||||
# PHP configuration
|
||||
opnform_php_memory_limit: "1G"
|
||||
opnform_php_max_execution_time: "600"
|
||||
opnform_php_upload_max_filesize: "64M"
|
||||
opnform_php_post_max_size: "64M"
|
||||
|
||||
# Nginx ingress
|
||||
opnform_nginx_max_body_size: "64m"
|
||||
|
||||
# Mail configuration (optional — defaults to log driver)
|
||||
opnform_mail_mailer: "log"
|
||||
opnform_mail_host: ""
|
||||
opnform_mail_port: ""
|
||||
opnform_mail_username: ""
|
||||
opnform_mail_password: ""
|
||||
opnform_mail_encryption: ""
|
||||
opnform_mail_from_address: "noreply@digitalboard.ch"
|
||||
opnform_mail_from_name: "OpnForm"
|
||||
|
||||
# OIDC configuration — when enabled, the role auto-creates an
|
||||
# IdentityConnection in the first workspace via OpnForm's API after the
|
||||
# admin bootstrap. Requires opnform_admin_email/_password to be set
|
||||
# (the API call needs an authenticated admin token).
|
||||
opnform_oidc_enabled: false
|
||||
opnform_oidc_issuer: "https://auth.digitalboard.ch/realms/Digitalboard"
|
||||
opnform_oidc_client_id: "opnform-digitalboard"
|
||||
opnform_oidc_client_secret: ""
|
||||
opnform_oidc_client_name: "Digitalboard"
|
||||
# OpnForm-side identifier used in /auth/{slug}/callback. Lowercase
|
||||
# alphanumeric + hyphens, unique across all identity_connections.
|
||||
opnform_oidc_slug: "oidc"
|
||||
# Email domain that triggers OIDC login for matching users (e.g. users
|
||||
# with @example.com emails are redirected to the IdP). Required when
|
||||
# opnform_oidc_enabled is true.
|
||||
opnform_oidc_domain: ""
|
||||
# When true, sets OIDC_FORCE_LOGIN on the api: password-based login is
|
||||
# disabled entirely and every user must authenticate via OIDC. Only
|
||||
# rendered when opnform_oidc_enabled is also true. Make sure all real
|
||||
# users have addresses under opnform_oidc_domain before enabling — there
|
||||
# is no password fallback once this is on.
|
||||
opnform_oidc_force_login: false
|
||||
opnform_oidc_scopes:
|
||||
- openid
|
||||
- profile
|
||||
- email
|
||||
- groups
|
||||
# Convenience: maps a single IdP group to the OpnForm "admin" role.
|
||||
# Ignored when opnform_oidc_group_role_mappings is non-empty.
|
||||
opnform_oidc_admin_group: "opnform-admins"
|
||||
# Full group-to-role mapping list. Takes precedence over the convenience
|
||||
# var. Each item: {idp_group: "<group name>", role: "owner|admin|editor|member"}
|
||||
opnform_oidc_group_role_mappings: []
|
||||
|
||||
# Direct-SSO entrypoint. OpnForm has no built-in way to skip the email
|
||||
# login form and jump straight to the IdP (verified: config/oidc.php only
|
||||
# exposes force_login; the login form always routes by email domain). When
|
||||
# this is enabled the ingress serves a tiny page at opnform_oidc_sso_path
|
||||
# that calls OpnForm's /api/auth/{slug}/redirect endpoint (which performs
|
||||
# no domain check) and forwards the browser to the returned authorize URL
|
||||
# — nonce/state included. Link users to https://<domain><sso_path> instead
|
||||
# of /login. Requires opnform_oidc_enabled.
|
||||
opnform_oidc_sso_entrypoint: false
|
||||
opnform_oidc_sso_path: "/sso"
|
||||
|
||||
# Traefik configuration
|
||||
opnform_traefik_network: "proxy"
|
||||
opnform_use_ssl: true
|
||||
8
roles/opnform/handlers/main.yml
Normal file
8
roles/opnform/handlers/main.yml
Normal file
|
|
@ -0,0 +1,8 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# handlers file for opnform
|
||||
|
||||
- name: restart opnform
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ opnform_docker_compose_dir }}"
|
||||
state: restarted
|
||||
265
roles/opnform/meta/argument_specs.yml
Normal file
265
roles/opnform/meta/argument_specs.yml
Normal file
|
|
@ -0,0 +1,265 @@
|
|||
---
|
||||
argument_specs:
|
||||
main:
|
||||
short_description: Deploy OpnForm (api + ui + db + redis + ingress) via Docker Compose.
|
||||
description:
|
||||
- Renders a Compose stack for the full OpnForm setup (PHP-FPM api,
|
||||
Nuxt ui, Postgres, Redis, nginx ingress) and exposes it through
|
||||
Traefik.
|
||||
- Optionally bootstraps the first admin user via the OpnForm
|
||||
C(/api/register) endpoint (skipping the self-hosted setup page)
|
||||
and provisions a single OIDC identity connection in the default
|
||||
workspace via the workspace API. Both bootstraps are idempotent.
|
||||
options:
|
||||
docker_compose_base_dir:
|
||||
type: path
|
||||
default: /etc/docker/compose
|
||||
docker_volume_base_dir:
|
||||
type: path
|
||||
default: /srv/data
|
||||
opnform_service_name:
|
||||
type: str
|
||||
default: opnform
|
||||
opnform_docker_compose_dir:
|
||||
type: path
|
||||
description: Defaults to C({{ docker_compose_base_dir }}/{{ opnform_service_name }}).
|
||||
opnform_docker_volume_dir:
|
||||
type: path
|
||||
description: Defaults to C({{ docker_volume_base_dir }}/{{ opnform_service_name }}).
|
||||
opnform_storage_dir:
|
||||
type: path
|
||||
description: OpnForm storage volume mounted into the api container.
|
||||
opnform_db_data_dir:
|
||||
type: path
|
||||
opnform_redis_data_dir:
|
||||
type: path
|
||||
|
||||
opnform_domain:
|
||||
type: str
|
||||
default: forms.local.test
|
||||
description: Hostname used in the traefik Host rule.
|
||||
opnform_extra_domains:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
description:
|
||||
- Additional hostnames the Traefik router answers on, OR-combined
|
||||
with C(opnform_domain). Useful for an internal C(*.int.*) FQDN so
|
||||
a DMZ reverseproxy can reach a backend hostname covered by the
|
||||
cert.
|
||||
opnform_extra_hosts:
|
||||
type: list
|
||||
elements: str
|
||||
default: []
|
||||
description:
|
||||
- Container-level C(/etc/hosts) overrides for the API containers
|
||||
(Compose C(extra_hosts) entries, C("host:ip")). Needed in
|
||||
split-horizon setups where the OpnForm API must reach the IdP's
|
||||
public FQDN (used in the OIDC discovery / C(iss) claim) over the
|
||||
LAN rather than hairpinning through a DMZ with no NAT loopback.
|
||||
opnform_base_url:
|
||||
type: str
|
||||
default: https://forms.local.test
|
||||
description: Public URL OpnForm uses for APP_URL and NUXT_PUBLIC_APP_URL.
|
||||
|
||||
opnform_api_image:
|
||||
type: str
|
||||
default: jhumanj/opnform-api:latest
|
||||
opnform_client_image:
|
||||
type: str
|
||||
default: jhumanj/opnform-client:latest
|
||||
opnform_redis_image:
|
||||
type: str
|
||||
default: "redis:7"
|
||||
opnform_db_image:
|
||||
type: str
|
||||
default: "postgres:16"
|
||||
opnform_ingress_image:
|
||||
type: str
|
||||
default: "nginx:1"
|
||||
|
||||
opnform_app_key:
|
||||
type: str
|
||||
required: true
|
||||
description:
|
||||
- Laravel application key. Must be prefixed with C(base64:).
|
||||
Generate with C(echo "base64:$(openssl rand -base64 32)").
|
||||
Provide via OpenBao, Ansible Vault or extra-vars.
|
||||
opnform_jwt_secret:
|
||||
type: str
|
||||
required: true
|
||||
description: JWT signing secret. Generate with C(openssl rand -hex 32).
|
||||
opnform_front_api_secret:
|
||||
type: str
|
||||
required: true
|
||||
description: Shared secret between ui and api. Generate with C(openssl rand -hex 32).
|
||||
|
||||
opnform_db_name:
|
||||
type: str
|
||||
default: opnform
|
||||
opnform_db_user:
|
||||
type: str
|
||||
default: opnform
|
||||
opnform_db_password:
|
||||
type: str
|
||||
required: true
|
||||
|
||||
opnform_admin_name:
|
||||
type: str
|
||||
default: Administrator
|
||||
opnform_admin_email:
|
||||
type: str
|
||||
default: ''
|
||||
description:
|
||||
- When non-empty (together with C(opnform_admin_password)) the role
|
||||
bootstraps the first user via C(/api/register), skipping the
|
||||
self-hosted setup page. Required when C(opnform_oidc_enabled=true).
|
||||
opnform_admin_password:
|
||||
type: str
|
||||
default: ''
|
||||
description:
|
||||
- "Must satisfy OpnForm's policy: min 8 chars, letter + digit +
|
||||
symbol from C(@$!%*#?&-_+=.,:;<>^()[]{}|~)."
|
||||
opnform_admin_hear_about_us:
|
||||
type: str
|
||||
default: ansible
|
||||
|
||||
opnform_php_memory_limit:
|
||||
type: str
|
||||
default: 1G
|
||||
opnform_php_max_execution_time:
|
||||
type: str
|
||||
default: "600"
|
||||
opnform_php_upload_max_filesize:
|
||||
type: str
|
||||
default: 64M
|
||||
opnform_php_post_max_size:
|
||||
type: str
|
||||
default: 64M
|
||||
opnform_nginx_max_body_size:
|
||||
type: str
|
||||
default: 64m
|
||||
|
||||
opnform_mail_mailer:
|
||||
type: str
|
||||
default: log
|
||||
choices: [log, smtp, ses, mailgun, postmark, sendmail]
|
||||
opnform_mail_host:
|
||||
type: str
|
||||
default: ''
|
||||
opnform_mail_port:
|
||||
type: str
|
||||
default: ''
|
||||
opnform_mail_username:
|
||||
type: str
|
||||
default: ''
|
||||
opnform_mail_password:
|
||||
type: str
|
||||
default: ''
|
||||
opnform_mail_encryption:
|
||||
type: str
|
||||
default: ''
|
||||
choices: ['', tls, ssl]
|
||||
opnform_mail_from_address:
|
||||
type: str
|
||||
default: noreply@digitalboard.ch
|
||||
opnform_mail_from_name:
|
||||
type: str
|
||||
default: OpnForm
|
||||
|
||||
opnform_oidc_enabled:
|
||||
type: bool
|
||||
default: false
|
||||
description:
|
||||
- "When true the role calls the workspace API to create a single
|
||||
OIDC C(identity_connection) on the default workspace after the
|
||||
admin bootstrap. Requires C(opnform_admin_email) +
|
||||
C(opnform_admin_password) so the role can authenticate.
|
||||
Idempotent: skipped when any connection already exists."
|
||||
opnform_oidc_issuer:
|
||||
type: str
|
||||
default: https://auth.digitalboard.ch/realms/Digitalboard
|
||||
description: OIDC issuer URL.
|
||||
opnform_oidc_client_id:
|
||||
type: str
|
||||
default: opnform-digitalboard
|
||||
opnform_oidc_client_secret:
|
||||
type: str
|
||||
default: ''
|
||||
description: Required when C(opnform_oidc_enabled=true).
|
||||
opnform_oidc_client_name:
|
||||
type: str
|
||||
default: Digitalboard
|
||||
description: Display name shown in the OpnForm UI.
|
||||
opnform_oidc_slug:
|
||||
type: str
|
||||
default: oidc
|
||||
description:
|
||||
- OpnForm-side identifier used in C(/auth/{slug}/callback). Lowercase
|
||||
alphanumeric + hyphens, unique across all C(identity_connections).
|
||||
opnform_oidc_domain:
|
||||
type: str
|
||||
default: ''
|
||||
description:
|
||||
- Email domain that triggers OIDC for matching users. Required
|
||||
when C(opnform_oidc_enabled=true).
|
||||
opnform_oidc_force_login:
|
||||
type: bool
|
||||
default: false
|
||||
description:
|
||||
- "When true, sets C(OIDC_FORCE_LOGIN=true) on the api container:
|
||||
password-based login is disabled and every user must authenticate
|
||||
via OIDC. Only takes effect when C(opnform_oidc_enabled=true).
|
||||
Ensure all real users have addresses under C(opnform_oidc_domain)
|
||||
before enabling — there is no password fallback."
|
||||
opnform_oidc_scopes:
|
||||
type: list
|
||||
elements: str
|
||||
default: [openid, profile, email, groups]
|
||||
opnform_oidc_admin_group:
|
||||
type: str
|
||||
default: opnform-admins
|
||||
description:
|
||||
- Convenience setting that maps a single IdP group to the OpnForm
|
||||
C(admin) role. Ignored when C(opnform_oidc_group_role_mappings)
|
||||
is non-empty.
|
||||
opnform_oidc_group_role_mappings:
|
||||
type: list
|
||||
elements: dict
|
||||
default: []
|
||||
description:
|
||||
- Full IdP-group -> OpnForm-role mapping. Takes precedence over
|
||||
C(opnform_oidc_admin_group).
|
||||
options:
|
||||
idp_group:
|
||||
type: str
|
||||
required: true
|
||||
description: Group name as it appears in the IdP groups claim.
|
||||
role:
|
||||
type: str
|
||||
required: true
|
||||
choices: [owner, admin, editor, member]
|
||||
opnform_oidc_sso_entrypoint:
|
||||
type: bool
|
||||
default: false
|
||||
description:
|
||||
- When true (and C(opnform_oidc_enabled=true)) the nginx ingress
|
||||
serves a small redirect page at C(opnform_oidc_sso_path) that
|
||||
calls OpnForm's C(/api/auth/{slug}/redirect) endpoint and
|
||||
forwards the browser to the returned IdP authorize URL. Lets
|
||||
you link users straight to the IdP, skipping OpnForm's
|
||||
email-based login form. OpnForm has no native option for this.
|
||||
opnform_oidc_sso_path:
|
||||
type: str
|
||||
default: /sso
|
||||
description:
|
||||
- Path (on C(opnform_domain)) where the direct-SSO redirect page
|
||||
is served when C(opnform_oidc_sso_entrypoint=true). Must start
|
||||
with C(/) and not collide with OpnForm's own routes.
|
||||
|
||||
opnform_traefik_network:
|
||||
type: str
|
||||
default: proxy
|
||||
opnform_use_ssl:
|
||||
type: bool
|
||||
default: true
|
||||
16
roles/opnform/meta/main.yml
Normal file
16
roles/opnform/meta/main.yml
Normal file
|
|
@ -0,0 +1,16 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
galaxy_info:
|
||||
author: Tobias Wüst
|
||||
description: Deploy OpnForm self-hosted form builder via Docker Compose behind Traefik
|
||||
company: Digitalboard
|
||||
license: MIT-0
|
||||
min_ansible_version: "2.15"
|
||||
|
||||
galaxy_tags:
|
||||
- opnform
|
||||
- forms
|
||||
- docker
|
||||
- traefik
|
||||
- oidc
|
||||
|
||||
dependencies: []
|
||||
343
roles/opnform/tasks/main.yml
Normal file
343
roles/opnform/tasks/main.yml
Normal file
|
|
@ -0,0 +1,343 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# tasks file for opnform
|
||||
|
||||
# =====================================================================
|
||||
# 0. VALIDATION
|
||||
# =====================================================================
|
||||
|
||||
- name: Validate required secrets
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- opnform_app_key | length > 0
|
||||
- opnform_app_key is match('^base64:[A-Za-z0-9+/=]+$')
|
||||
- opnform_jwt_secret | length > 0
|
||||
- opnform_front_api_secret | length > 0
|
||||
- opnform_db_password | length > 0
|
||||
fail_msg: >-
|
||||
OpnForm requires opnform_app_key, opnform_jwt_secret,
|
||||
opnform_front_api_secret and opnform_db_password.
|
||||
Generate with:
|
||||
opnform_app_key='base64:'$(openssl rand -base64 32) (the 'base64:' prefix is required);
|
||||
opnform_jwt_secret and opnform_front_api_secret via openssl rand -hex 32.
|
||||
Provide via OpenBao, Ansible Vault or extra-vars.
|
||||
success_msg: Secrets validation passed
|
||||
|
||||
- name: Validate OIDC configuration when enabled
|
||||
ansible.builtin.assert:
|
||||
that:
|
||||
- opnform_oidc_client_secret | length > 0
|
||||
- opnform_oidc_domain | length > 0
|
||||
- opnform_admin_email | length > 0
|
||||
- opnform_admin_password | length > 0
|
||||
fail_msg: >-
|
||||
When opnform_oidc_enabled is true, you must set:
|
||||
- opnform_oidc_client_secret
|
||||
- opnform_oidc_domain (email domain that triggers OIDC)
|
||||
- opnform_admin_email / opnform_admin_password
|
||||
(the OIDC API requires an authenticated admin; the role logs in
|
||||
with these credentials to POST the connection)
|
||||
when: opnform_oidc_enabled | bool
|
||||
|
||||
# =====================================================================
|
||||
# 1. PREPARATION
|
||||
# =====================================================================
|
||||
|
||||
- name: Ensure required packages are installed
|
||||
ansible.builtin.package:
|
||||
name:
|
||||
- python3-docker
|
||||
state: present
|
||||
|
||||
- name: Create docker compose directory
|
||||
ansible.builtin.file:
|
||||
path: "{{ opnform_docker_compose_dir }}"
|
||||
state: directory
|
||||
mode: '0755'
|
||||
|
||||
- name: Create OpnForm data directories
|
||||
ansible.builtin.file:
|
||||
path: "{{ item }}"
|
||||
state: directory
|
||||
mode: "0755"
|
||||
loop:
|
||||
- "{{ opnform_docker_volume_dir }}"
|
||||
- "{{ opnform_storage_dir }}"
|
||||
- "{{ opnform_db_data_dir }}"
|
||||
- "{{ opnform_redis_data_dir }}"
|
||||
|
||||
# =====================================================================
|
||||
# 2. CONFIGURATION FILES
|
||||
# =====================================================================
|
||||
|
||||
- name: Deploy nginx ingress configuration
|
||||
ansible.builtin.template:
|
||||
src: nginx.conf.j2
|
||||
dest: "{{ opnform_docker_compose_dir }}/nginx.conf"
|
||||
mode: '0644'
|
||||
notify: restart opnform
|
||||
|
||||
# OIDC_FORCE_LOGIN disables OpnForm's password login — including the
|
||||
# password-based admin/OIDC bootstrap this role performs below. So the
|
||||
# first compose render always keeps force-login OFF; it is switched on
|
||||
# only after the bootstrap completes (see step 7). This keeps a first
|
||||
# deploy on a fresh host working even when opnform_oidc_force_login=true.
|
||||
- name: Render compose with force-login disabled during bootstrap
|
||||
ansible.builtin.set_fact:
|
||||
_opnform_force_login_effective: false
|
||||
|
||||
- name: Deploy docker-compose file
|
||||
ansible.builtin.template:
|
||||
src: docker-compose.yml.j2
|
||||
dest: "{{ opnform_docker_compose_dir }}/docker-compose.yml"
|
||||
mode: '0644'
|
||||
notify: restart opnform
|
||||
|
||||
# =====================================================================
|
||||
# 3. CONTAINER STARTUP
|
||||
# =====================================================================
|
||||
|
||||
- name: Start opnform containers
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ opnform_docker_compose_dir }}"
|
||||
state: present
|
||||
wait: true
|
||||
wait_timeout: 180
|
||||
|
||||
# =====================================================================
|
||||
# 4. WAIT FOR API READINESS
|
||||
# =====================================================================
|
||||
|
||||
- name: Wait for API container to be healthy
|
||||
ansible.builtin.command:
|
||||
cmd: docker inspect --format='{% raw %}{{.State.Health.Status}}{% endraw %}' opnform-api
|
||||
register: api_health
|
||||
until: api_health.stdout == "healthy"
|
||||
retries: 30
|
||||
delay: 10
|
||||
changed_when: false
|
||||
|
||||
# =====================================================================
|
||||
# 5. ADMIN BOOTSTRAP (optional)
|
||||
# =====================================================================
|
||||
# Skips the self-hosted setup page by registering the first user via
|
||||
# OpnForm's /api/register endpoint. Idempotent: a successful login
|
||||
# attempt with the same credentials means the user already exists.
|
||||
|
||||
- name: Check if OpnForm admin user already exists
|
||||
ansible.builtin.uri:
|
||||
url: "https://127.0.0.1/api/login"
|
||||
method: POST
|
||||
headers:
|
||||
Host: "{{ opnform_domain }}"
|
||||
body_format: json
|
||||
body:
|
||||
email: "{{ opnform_admin_email }}"
|
||||
password: "{{ opnform_admin_password }}"
|
||||
status_code: [200, 401, 422]
|
||||
validate_certs: false
|
||||
register: opnform_admin_login
|
||||
when:
|
||||
- opnform_admin_email | length > 0
|
||||
- opnform_admin_password | length > 0
|
||||
|
||||
- name: Create OpnForm admin user via /api/register
|
||||
ansible.builtin.uri:
|
||||
url: "https://127.0.0.1/api/register"
|
||||
method: POST
|
||||
headers:
|
||||
Host: "{{ opnform_domain }}"
|
||||
body_format: json
|
||||
body:
|
||||
name: "{{ opnform_admin_name }}"
|
||||
email: "{{ opnform_admin_email }}"
|
||||
password: "{{ opnform_admin_password }}"
|
||||
password_confirmation: "{{ opnform_admin_password }}"
|
||||
hear_about_us: "{{ opnform_admin_hear_about_us }}"
|
||||
status_code: [200, 201]
|
||||
validate_certs: false
|
||||
no_log: true
|
||||
when:
|
||||
- opnform_admin_email | length > 0
|
||||
- opnform_admin_password | length > 0
|
||||
- opnform_admin_login.status != 200
|
||||
|
||||
# =====================================================================
|
||||
# 6. OIDC IDENTITY CONNECTION (optional)
|
||||
# =====================================================================
|
||||
# Provisions a single OIDC connection on the admin's default workspace.
|
||||
# OpnForm enforces one OIDC connection per workspace, so we GET the
|
||||
# existing connections first and then either POST a new one or PATCH the
|
||||
# existing one to the desired state. PATCHing (rather than skipping when
|
||||
# one exists) keeps inventory changes — e.g. a corrected issuer — applied
|
||||
# on re-runs instead of leaving stale values in the DB forever.
|
||||
|
||||
- name: Log in as admin to obtain OIDC API token
|
||||
ansible.builtin.uri:
|
||||
url: "https://127.0.0.1/api/login"
|
||||
method: POST
|
||||
headers:
|
||||
Host: "{{ opnform_domain }}"
|
||||
body_format: json
|
||||
body:
|
||||
email: "{{ opnform_admin_email }}"
|
||||
password: "{{ opnform_admin_password }}"
|
||||
status_code: 200
|
||||
validate_certs: false
|
||||
register: opnform_oidc_token
|
||||
no_log: true
|
||||
when: opnform_oidc_enabled | bool
|
||||
|
||||
- name: Fetch admin's workspaces
|
||||
ansible.builtin.uri:
|
||||
url: "https://127.0.0.1/api/open/workspaces"
|
||||
method: GET
|
||||
headers:
|
||||
Host: "{{ opnform_domain }}"
|
||||
Authorization: "Bearer {{ opnform_oidc_token.json.token }}"
|
||||
status_code: 200
|
||||
validate_certs: false
|
||||
register: opnform_workspaces
|
||||
no_log: true
|
||||
when: opnform_oidc_enabled | bool
|
||||
|
||||
- name: Fetch existing OIDC connections for the default workspace
|
||||
ansible.builtin.uri:
|
||||
url: "https://127.0.0.1/api/open/workspaces/{{ opnform_workspaces.json[0].id }}/oidc-connections"
|
||||
method: GET
|
||||
headers:
|
||||
Host: "{{ opnform_domain }}"
|
||||
Authorization: "Bearer {{ opnform_oidc_token.json.token }}"
|
||||
status_code: 200
|
||||
validate_certs: false
|
||||
register: opnform_existing_oidc
|
||||
no_log: true
|
||||
when: opnform_oidc_enabled | bool
|
||||
|
||||
- name: Resolve OIDC group-role mappings
|
||||
ansible.builtin.set_fact:
|
||||
_opnform_oidc_group_role_mappings: >-
|
||||
{{
|
||||
opnform_oidc_group_role_mappings
|
||||
if (opnform_oidc_group_role_mappings | length > 0)
|
||||
else
|
||||
([{'idp_group': opnform_oidc_admin_group, 'role': 'admin'}]
|
||||
if (opnform_oidc_admin_group | length > 0) else [])
|
||||
}}
|
||||
when: opnform_oidc_enabled | bool
|
||||
|
||||
# Desired connection state shared by both the create (POST) and update
|
||||
# (PATCH) calls below. client_secret is always sent: OpnForm's update
|
||||
# endpoint only persists it when present, and on create it is required.
|
||||
- name: Build desired OIDC connection body
|
||||
ansible.builtin.set_fact:
|
||||
_opnform_oidc_body:
|
||||
name: "{{ opnform_oidc_client_name }}"
|
||||
slug: "{{ opnform_oidc_slug }}"
|
||||
domain: "{{ opnform_oidc_domain }}"
|
||||
issuer: "{{ opnform_oidc_issuer }}"
|
||||
client_id: "{{ opnform_oidc_client_id }}"
|
||||
client_secret: "{{ opnform_oidc_client_secret }}"
|
||||
scopes: "{{ opnform_oidc_scopes }}"
|
||||
enabled: true
|
||||
options:
|
||||
require_state: true
|
||||
group_role_mappings: "{{ _opnform_oidc_group_role_mappings }}"
|
||||
no_log: true
|
||||
when: opnform_oidc_enabled | bool
|
||||
|
||||
- name: Create OIDC identity connection
|
||||
ansible.builtin.uri:
|
||||
url: "https://127.0.0.1/api/open/workspaces/{{ opnform_workspaces.json[0].id }}/oidc-connections"
|
||||
method: POST
|
||||
headers:
|
||||
Host: "{{ opnform_domain }}"
|
||||
Authorization: "Bearer {{ opnform_oidc_token.json.token }}"
|
||||
body_format: json
|
||||
body: "{{ _opnform_oidc_body }}"
|
||||
status_code: [201]
|
||||
validate_certs: false
|
||||
no_log: true
|
||||
when:
|
||||
- opnform_oidc_enabled | bool
|
||||
- opnform_existing_oidc.json | length == 0
|
||||
|
||||
# An OIDC connection already exists: PATCH it to the desired state so
|
||||
# inventory changes (e.g. a corrected issuer) are applied. OpnForm allows
|
||||
# exactly one connection per workspace, so the first entry is ours.
|
||||
- name: Update existing OIDC identity connection
|
||||
ansible.builtin.uri:
|
||||
url: >-
|
||||
https://127.0.0.1/api/open/workspaces/{{ opnform_workspaces.json[0].id }}/oidc-connections/{{ opnform_existing_oidc.json[0].id }}
|
||||
method: PATCH
|
||||
headers:
|
||||
Host: "{{ opnform_domain }}"
|
||||
Authorization: "Bearer {{ opnform_oidc_token.json.token }}"
|
||||
body_format: json
|
||||
body: "{{ _opnform_oidc_body }}"
|
||||
status_code: [200]
|
||||
validate_certs: false
|
||||
no_log: true
|
||||
when:
|
||||
- opnform_oidc_enabled | bool
|
||||
- opnform_existing_oidc.json | length > 0
|
||||
|
||||
# =====================================================================
|
||||
# 7. ENABLE FORCE LOGIN (optional, must run last)
|
||||
# =====================================================================
|
||||
# OIDC_FORCE_LOGIN disables password login — including the password-based
|
||||
# admin/OIDC bootstrap above — so it is switched on only now, after the
|
||||
# connection is provisioned. OpnForm itself only enforces force-login when
|
||||
# an enabled OIDC connection exists, so the order matters: connection
|
||||
# first, force-login second.
|
||||
- name: Enable force login now that the OIDC connection exists
|
||||
when:
|
||||
- opnform_oidc_enabled | bool
|
||||
- opnform_oidc_force_login | bool
|
||||
block:
|
||||
- name: Re-render compose with force-login enabled
|
||||
ansible.builtin.set_fact:
|
||||
_opnform_force_login_effective: true
|
||||
|
||||
- name: Deploy docker-compose file with force-login enabled
|
||||
ansible.builtin.template:
|
||||
src: docker-compose.yml.j2
|
||||
dest: "{{ opnform_docker_compose_dir }}/docker-compose.yml"
|
||||
mode: '0644'
|
||||
register: _opnform_force_login_compose
|
||||
|
||||
- name: Apply force-login by recreating the api containers
|
||||
community.docker.docker_compose_v2:
|
||||
project_src: "{{ opnform_docker_compose_dir }}"
|
||||
state: present
|
||||
wait: true
|
||||
wait_timeout: 180
|
||||
when: _opnform_force_login_compose is changed
|
||||
|
||||
- name: Display deployment info
|
||||
ansible.builtin.debug:
|
||||
msg: |-
|
||||
OpnForm deployed at {{ opnform_base_url }}
|
||||
|
||||
{% if opnform_admin_email | length > 0 %}
|
||||
Admin user bootstrapped:
|
||||
Email: {{ opnform_admin_email }}
|
||||
Password: (from opnform_admin_password)
|
||||
{% else %}
|
||||
No admin bootstrap configured — visit {{ opnform_base_url }} and
|
||||
complete the self-hosted setup page to create the first user.
|
||||
Set opnform_admin_email + opnform_admin_password to automate this.
|
||||
{% endif %}
|
||||
|
||||
{% if opnform_oidc_enabled %}
|
||||
OIDC: connection "{{ opnform_oidc_client_name }}" bootstrapped
|
||||
(slug: {{ opnform_oidc_slug }}, domain: {{ opnform_oidc_domain }})
|
||||
Users with @{{ opnform_oidc_domain }} addresses will be
|
||||
redirected to {{ opnform_oidc_issuer }} on login.
|
||||
{% if opnform_oidc_sso_entrypoint %}
|
||||
Direct-SSO entrypoint: {{ opnform_base_url }}{{ opnform_oidc_sso_path }}
|
||||
(link users here to skip the email login form)
|
||||
{% endif %}
|
||||
{% else %}
|
||||
OIDC: disabled (set opnform_oidc_enabled=true to auto-configure)
|
||||
{% endif %}
|
||||
201
roles/opnform/templates/docker-compose.yml.j2
Normal file
201
roles/opnform/templates/docker-compose.yml.j2
Normal file
|
|
@ -0,0 +1,201 @@
|
|||
#---------------------------------------------------------------------#
|
||||
# OpnForm — Beautiful open-source form builder #
|
||||
#---------------------------------------------------------------------#
|
||||
services:
|
||||
api: &api-service
|
||||
image: {{ opnform_api_image }}
|
||||
container_name: opnform-api
|
||||
restart: unless-stopped
|
||||
{% if opnform_extra_hosts | length > 0 %}
|
||||
extra_hosts:
|
||||
{% for host in opnform_extra_hosts %}
|
||||
- "{{ host }}"
|
||||
{% endfor %}
|
||||
{% endif %}
|
||||
volumes:
|
||||
- {{ opnform_storage_dir }}:/usr/share/nginx/html/storage:rw
|
||||
environment: &api-env
|
||||
APP_ENV: production
|
||||
APP_KEY: "{{ opnform_app_key }}"
|
||||
APP_URL: "{{ opnform_base_url }}"
|
||||
APP_DEBUG: "false"
|
||||
SELF_HOSTED: "true"
|
||||
{% if opnform_oidc_enabled and (_opnform_force_login_effective | default(false)) %}
|
||||
OIDC_FORCE_LOGIN: "true"
|
||||
{% endif %}
|
||||
|
||||
LOG_CHANNEL: errorlog
|
||||
LOG_LEVEL: info
|
||||
|
||||
DB_CONNECTION: pgsql
|
||||
DB_HOST: db
|
||||
DB_PORT: "5432"
|
||||
DB_DATABASE: "{{ opnform_db_name }}"
|
||||
DB_USERNAME: "{{ opnform_db_user }}"
|
||||
DB_PASSWORD: "{{ opnform_db_password }}"
|
||||
|
||||
REDIS_HOST: redis
|
||||
REDIS_PORT: "6379"
|
||||
|
||||
CACHE_STORE: redis
|
||||
CACHE_DRIVER: redis
|
||||
QUEUE_CONNECTION: redis
|
||||
SESSION_DRIVER: redis
|
||||
SESSION_LIFETIME: "120"
|
||||
BROADCAST_CONNECTION: log
|
||||
|
||||
FILESYSTEM_DISK: local
|
||||
FILESYSTEM_DRIVER: local
|
||||
LOCAL_FILESYSTEM_VISIBILITY: public
|
||||
|
||||
MAIL_MAILER: "{{ opnform_mail_mailer }}"
|
||||
MAIL_HOST: "{{ opnform_mail_host }}"
|
||||
MAIL_PORT: "{{ opnform_mail_port }}"
|
||||
MAIL_USERNAME: "{{ opnform_mail_username }}"
|
||||
MAIL_PASSWORD: "{{ opnform_mail_password }}"
|
||||
MAIL_ENCRYPTION: "{{ opnform_mail_encryption }}"
|
||||
MAIL_FROM_ADDRESS: "{{ opnform_mail_from_address }}"
|
||||
MAIL_FROM_NAME: "{{ opnform_mail_from_name }}"
|
||||
|
||||
JWT_TTL: "1440"
|
||||
JWT_SECRET: "{{ opnform_jwt_secret }}"
|
||||
|
||||
PHP_MEMORY_LIMIT: "{{ opnform_php_memory_limit }}"
|
||||
PHP_MAX_EXECUTION_TIME: "{{ opnform_php_max_execution_time }}"
|
||||
PHP_UPLOAD_MAX_FILESIZE: "{{ opnform_php_upload_max_filesize }}"
|
||||
PHP_POST_MAX_SIZE: "{{ opnform_php_post_max_size }}"
|
||||
depends_on:
|
||||
db:
|
||||
condition: service_healthy
|
||||
redis:
|
||||
condition: service_healthy
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "php /usr/share/nginx/html/artisan about || exit 1"]
|
||||
interval: 30s
|
||||
timeout: 15s
|
||||
retries: 3
|
||||
start_period: 60s
|
||||
networks:
|
||||
- opnform-internal
|
||||
|
||||
api-worker:
|
||||
<<: *api-service
|
||||
container_name: opnform-api-worker
|
||||
command: ["php", "artisan", "queue:work"]
|
||||
environment:
|
||||
<<: *api-env
|
||||
IS_API_WORKER: "true"
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pgrep -f 'php artisan queue:work' > /dev/null || exit 1"]
|
||||
interval: 60s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 30s
|
||||
|
||||
api-scheduler:
|
||||
<<: *api-service
|
||||
container_name: opnform-api-scheduler
|
||||
command: ["php", "artisan", "schedule:work"]
|
||||
healthcheck:
|
||||
test:
|
||||
- "CMD-SHELL"
|
||||
- "php /usr/share/nginx/html/artisan app:scheduler-status --mode=check --max-minutes=3 || exit 1"
|
||||
interval: 60s
|
||||
timeout: 30s
|
||||
retries: 3
|
||||
start_period: 70s
|
||||
|
||||
ui:
|
||||
image: {{ opnform_client_image }}
|
||||
container_name: opnform-ui
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
NUXT_PUBLIC_APP_URL: "{{ opnform_base_url }}"
|
||||
NUXT_PUBLIC_API_BASE: "/api"
|
||||
NUXT_PRIVATE_API_BASE: "http://ingress/api"
|
||||
NUXT_PUBLIC_ENV: production
|
||||
FRONT_API_SECRET: "{{ opnform_front_api_secret }}"
|
||||
depends_on:
|
||||
api:
|
||||
condition: service_healthy
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "wget --spider -q http://localhost:3000/login || exit 1"]
|
||||
interval: 30s
|
||||
timeout: 10s
|
||||
retries: 3
|
||||
start_period: 45s
|
||||
networks:
|
||||
- opnform-internal
|
||||
|
||||
redis:
|
||||
image: {{ opnform_redis_image }}
|
||||
container_name: opnform-redis
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- {{ opnform_redis_data_dir }}:/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "redis-cli ping | grep PONG"]
|
||||
interval: 30s
|
||||
timeout: 5s
|
||||
networks:
|
||||
- opnform-internal
|
||||
|
||||
db:
|
||||
image: {{ opnform_db_image }}
|
||||
container_name: opnform-db
|
||||
restart: unless-stopped
|
||||
environment:
|
||||
POSTGRES_DB: "{{ opnform_db_name }}"
|
||||
POSTGRES_USER: "{{ opnform_db_user }}"
|
||||
POSTGRES_PASSWORD: "{{ opnform_db_password }}"
|
||||
volumes:
|
||||
- {{ opnform_db_data_dir }}:/var/lib/postgresql/data
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "pg_isready -U {{ opnform_db_user }}"]
|
||||
interval: 30s
|
||||
timeout: 5s
|
||||
networks:
|
||||
- opnform-internal
|
||||
|
||||
ingress:
|
||||
image: {{ opnform_ingress_image }}
|
||||
container_name: opnform-ingress
|
||||
restart: unless-stopped
|
||||
volumes:
|
||||
- ./nginx.conf:/etc/nginx/templates/default.conf.template:ro
|
||||
environment:
|
||||
NGINX_MAX_BODY_SIZE: "{{ opnform_nginx_max_body_size }}"
|
||||
depends_on:
|
||||
api:
|
||||
condition: service_started
|
||||
ui:
|
||||
condition: service_started
|
||||
healthcheck:
|
||||
test: ["CMD-SHELL", "nginx -t && curl -f http://localhost/ || exit 1"]
|
||||
interval: 30s
|
||||
timeout: 5s
|
||||
retries: 3
|
||||
start_period: 10s
|
||||
networks:
|
||||
- opnform-internal
|
||||
- {{ opnform_traefik_network }}
|
||||
labels:
|
||||
- traefik.enable=true
|
||||
- traefik.docker.network={{ opnform_traefik_network }}
|
||||
- traefik.http.routers.{{ opnform_service_name }}.rule={% set _all_domains = [opnform_domain] + (opnform_extra_domains | default([])) %}{% for d in _all_domains %}Host(`{{ d }}`){% if not loop.last %} || {% endif %}{% endfor +%}
|
||||
{% if opnform_use_ssl %}
|
||||
- traefik.http.routers.{{ opnform_service_name }}.entrypoints=websecure
|
||||
- traefik.http.routers.{{ opnform_service_name }}.tls=true
|
||||
{% if traefik_cert_mode | default('selfsigned') == 'acme' %}
|
||||
- traefik.http.routers.{{ opnform_service_name }}.tls.certresolver={{ traefik_ssl_cert_resolver | default('dns') }}
|
||||
{% endif %}
|
||||
{% else %}
|
||||
- traefik.http.routers.{{ opnform_service_name }}.entrypoints=web
|
||||
{% endif %}
|
||||
- traefik.http.services.{{ opnform_service_name }}.loadbalancer.server.port=80
|
||||
|
||||
networks:
|
||||
opnform-internal:
|
||||
driver: bridge
|
||||
{{ opnform_traefik_network }}:
|
||||
external: true
|
||||
54
roles/opnform/templates/nginx.conf.j2
Normal file
54
roles/opnform/templates/nginx.conf.j2
Normal file
|
|
@ -0,0 +1,54 @@
|
|||
map $original_uri $api_uri {
|
||||
~^/api(/.*$) $1;
|
||||
default $original_uri;
|
||||
}
|
||||
|
||||
server {
|
||||
listen 80;
|
||||
server_name {{ opnform_domain }};
|
||||
root /app/public;
|
||||
|
||||
client_max_body_size {% raw %}${NGINX_MAX_BODY_SIZE}{% endraw %};
|
||||
|
||||
access_log /dev/stdout;
|
||||
error_log /dev/stderr error;
|
||||
|
||||
index index.html index.htm index.php;
|
||||
|
||||
{% if opnform_oidc_enabled and opnform_oidc_sso_entrypoint %}
|
||||
# Direct-SSO entrypoint: a tiny page that asks the API for the IdP
|
||||
# authorize URL (no email/domain check on this endpoint) and forwards
|
||||
# the browser there. Link users here instead of /login to skip the
|
||||
# email field entirely. Exact-match so it wins over the `/` prefix.
|
||||
location = {{ opnform_oidc_sso_path }} {
|
||||
default_type text/html;
|
||||
return 200 '<!doctype html><html lang="en"><head><meta charset="utf-8"><meta name="viewport" content="width=device-width,initial-scale=1"><title>Redirecting to sign-in…</title></head><body style="font-family:sans-serif;text-align:center;padding:3rem;color:#374151"><p id="m">Redirecting to sign-in…</p><script>fetch("/api/auth/{{ opnform_oidc_slug }}/redirect",{method:"POST",headers:{Accept:"application/json"}}).then(function(r){if(!r.ok)throw new Error("HTTP "+r.status);return r.json()}).then(function(d){if(d&&d.redirect_url){window.location.replace(d.redirect_url)}else{throw new Error("no redirect_url")}}).catch(function(e){document.getElementById("m").textContent="Sign-in redirect failed: "+e.message+". Go to the login page instead.";var a=document.createElement("a");a.href="/login";a.textContent="Open login page";a.style.display="block";a.style.marginTop="1rem";document.body.appendChild(a)});</script></body></html>';
|
||||
}
|
||||
|
||||
{% endif %}
|
||||
location / {
|
||||
proxy_http_version 1.1;
|
||||
proxy_pass http://ui:3000;
|
||||
proxy_set_header X-Real-IP $remote_addr;
|
||||
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
|
||||
proxy_set_header X-Forwarded-Proto $scheme;
|
||||
proxy_set_header X-Forwarded-Host $host;
|
||||
proxy_set_header X-Forwarded-Port $server_port;
|
||||
proxy_set_header Upgrade $http_upgrade;
|
||||
proxy_set_header Connection "Upgrade";
|
||||
}
|
||||
|
||||
location ~/(api|open|local\/temp|forms\/assets)/ {
|
||||
set $original_uri $uri;
|
||||
try_files $uri $uri/ /index.php$is_args$args;
|
||||
}
|
||||
|
||||
location ~ \.php$ {
|
||||
fastcgi_split_path_info ^(.+\.php)(/.+)$;
|
||||
fastcgi_pass api:9000;
|
||||
fastcgi_index index.php;
|
||||
include fastcgi_params;
|
||||
fastcgi_param SCRIPT_FILENAME /usr/share/nginx/html/public/index.php;
|
||||
fastcgi_param REQUEST_URI $api_uri;
|
||||
}
|
||||
}
|
||||
2
roles/opnform/tests/inventory
Normal file
2
roles/opnform/tests/inventory
Normal file
|
|
@ -0,0 +1,2 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
localhost
|
||||
6
roles/opnform/tests/test.yml
Normal file
6
roles/opnform/tests/test.yml
Normal file
|
|
@ -0,0 +1,6 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
- hosts: localhost
|
||||
remote_user: root
|
||||
roles:
|
||||
- opnform
|
||||
3
roles/opnform/vars/main.yml
Normal file
3
roles/opnform/vars/main.yml
Normal file
|
|
@ -0,0 +1,3 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# vars file for opnform
|
||||
64
roles/send/README.md
Normal file
64
roles/send/README.md
Normal file
|
|
@ -0,0 +1,64 @@
|
|||
Send
|
||||
====
|
||||
|
||||
Deploys a self-hosted [Send](https://github.com/timvisee/send) instance
|
||||
(timvisee fork of the discontinued Mozilla Send) with a Redis backend
|
||||
behind Traefik, using Docker Compose.
|
||||
|
||||
Requirements
|
||||
------------
|
||||
|
||||
- Docker + `docker compose` plugin on the target host
|
||||
- Traefik (role `digitalboard.core.traefik`) reachable via an external
|
||||
Docker network named `proxy` (default)
|
||||
- DNS for each entry in `send_domains` pointing at the reverse proxy
|
||||
- Optional: a Garage S3 bucket if `send_storage_backend: s3`
|
||||
|
||||
Role Variables
|
||||
--------------
|
||||
|
||||
Important defaults (see `defaults/main.yml` for the full list):
|
||||
|
||||
| Variable | Default | Description |
|
||||
|---|---|---|
|
||||
| `send_domains` | `["send.local.test"]` | FQDNs the router accepts; first entry is the canonical BASE_URL |
|
||||
| `send_image` | `registry.gitlab.com/timvisee/send:latest` | Send container image |
|
||||
| `send_max_file_size` | `1073741824` | Max upload size in bytes (1 GiB) |
|
||||
| `send_max_expire_seconds` | `604800` | Max share lifetime (7 d) |
|
||||
| `send_storage_backend` | `local` | `local` (volume) or `s3` |
|
||||
| `send_s3_*` | `""` | S3 endpoint/bucket/key/secret (when backend is `s3`) |
|
||||
| `send_use_ssl` | `true` | Issue Traefik labels for the `websecure` entrypoint |
|
||||
|
||||
Dependencies
|
||||
------------
|
||||
|
||||
None.
|
||||
|
||||
Example Playbook
|
||||
----------------
|
||||
|
||||
```yaml
|
||||
- hosts: send_servers
|
||||
become: true
|
||||
roles:
|
||||
- digitalboard.core.send
|
||||
```
|
||||
|
||||
With S3 (Garage) backend:
|
||||
|
||||
```yaml
|
||||
send_storage_backend: s3
|
||||
send_s3_endpoint: "http://{{ hostvars['backend']['garage_s3_domains'][0] }}"
|
||||
send_s3_bucket: "send"
|
||||
send_s3_access_key: "{{ lookup('digitalboard.core.garage_credentials', 'send', host='backend')['key_id'] }}"
|
||||
send_s3_secret_key: "{{ lookup('digitalboard.core.garage_credentials', 'send', host='backend')['secret_key'] }}"
|
||||
```
|
||||
|
||||
When `send_storage_backend: s3`, the role asserts that `send_s3_endpoint`,
|
||||
`send_s3_bucket`, `send_s3_access_key` and `send_s3_secret_key` are all set,
|
||||
and fails early otherwise.
|
||||
|
||||
License
|
||||
-------
|
||||
|
||||
MIT-0
|
||||
53
roles/send/defaults/main.yml
Normal file
53
roles/send/defaults/main.yml
Normal file
|
|
@ -0,0 +1,53 @@
|
|||
#SPDX-License-Identifier: MIT-0
|
||||
---
|
||||
# defaults file for send
|
||||
|
||||
# Base directory configuration (inherited from base role or defined here)
|
||||
docker_compose_base_dir: /etc/docker/compose
|
||||
docker_volume_base_dir: /srv/data
|
||||
|
||||
# Send-specific configuration
|
||||
send_service_name: send
|
||||
send_docker_compose_dir: "{{ docker_compose_base_dir }}/{{ send_service_name }}"
|
||||
send_docker_volume_dir: "{{ docker_volume_base_dir }}/{{ send_service_name }}"
|
||||
|
||||
# Service configuration
|
||||
# FQDNs the send router accepts. The first entry is the canonical
|
||||
# domain (used as BASE_URL); further entries cover internal *.int.*
|
||||
# names so backend uploads can hit us without hairpinning via DMZ.
|
||||
send_domains:
|
||||
- "send.local.test"
|
||||
send_image: "registry.gitlab.com/timvisee/send:latest"
|
||||
send_port: 1443
|
||||
send_extra_hosts: []
|
||||
|
||||
# Redis backend
|
||||
send_redis_image: "redis:7-alpine"
|
||||
send_redis_service_name: "send-redis"
|
||||
|
||||
# Send application configuration
|
||||
# https://github.com/timvisee/send/blob/master/server/config.js
|
||||
send_max_file_size: 1073741824 # 1 GiB in bytes
|
||||
send_default_downloads: 1
|
||||
send_max_downloads: 100
|
||||
send_default_expire_seconds: 86400 # 24h
|
||||
send_max_expire_seconds: 604800 # 7d
|
||||
send_max_files_per_archive: 64
|
||||
send_download_counts: "1,2,3,4,5,20,50,100"
|
||||
send_expire_times_seconds: "300,3600,86400,604800"
|
||||
|
||||
# Storage backend: "local" (volume) or "s3"
|
||||
send_storage_backend: "local"
|
||||
|
||||
# S3 backend (only used when send_storage_backend == "s3")
|
||||
send_s3_endpoint: ""
|
||||
send_s3_bucket: ""
|
||||
send_s3_region: "us-east-1"
|
||||
send_s3_access_key: ""
|
||||
send_s3_secret_key: ""
|
||||
send_s3_use_path_style: true
|
||||
|
||||
# Traefik configuration
|
||||
send_traefik_network: "proxy"
|
||||
send_internal_network: "send_internal"
|
||||
send_use_ssl: true
|
||||
Some files were not shown because too many files have changed in this diff Show more
Loading…
Add table
Add a link
Reference in a new issue