ansible-collection-nextcloud/roles/nextcloud/meta/argument_specs.yml
s3lph 81576dc751
Some checks failed
Ansible Lint / build (push) Successful in 1m7s
Ansible Galaxy / deploy (push) Failing after 1m47s
fix: ansible-lint
2024-04-14 19:56:19 +02:00

121 lines
4.4 KiB
YAML

---
argument_specs:
main:
version_added: "0.0.1"
short_description: Install and configure Nextcloud.
description:
- Install and configure Nextcloud using the Debian packages from U(https://repo.s3lph.me).
- "Execution of this role can be limited using the following tags:"
- "C(role::nextcloud:install): Install packages and run C(occ maintenance:install) if not done."
- "C(role::nextcloud:config): Apply Nextcloud and app configuration options."
- "C(role::nextcloud): Apply all of the above."
author: s3lph
options:
nextcloud_major_version:
description: The version of Nextcloud to deploy.
type: str
default: "28"
nextcloud_trusted_domains:
description: The list of domains under which Nextcloud should be reachable.
type: list
elements: str
default:
- "cloud.example.org"
nextcloud_cli_baseurl:
description: The domain used when the C(occ) CLI tool is used to interact with Nextcloud.
type: str
default: "https://cloud.example.org"
nextcloud_redis_host:
description: Hostname of the Redis server, or path of the UNIX socket, if O(nextcloud_redis_port) is 0.
type: str
default: /run/keydb/keydb.sock
nextcloud_redis_port:
description: Port of the Redis server, or 0 if a UNIX socket is used.
type: int
default: 0
nextcloud_redis_dbindex:
description: Redis database index.
type: int
default: 0
nextcloud_redis_timeout:
description: Redis connection timeout.
type: float
default: 0.0
nextcloud_db_engine:
description: Database engine to use for Nextcloud.
type: str
default: mysql
nextcloud_db_host:
description: Hostname of the database server, or path of the UNIX socket, if O(nextcloud_db_port) is 0.
type: str
default: localhost
nextcloud_db_port:
description: Port of the database server, or 0 if a UNIX socket is used.
type: int
default: 3306
nextcloud_db_user:
description: Username to authenticate Nextcloud against the database server.
type: str
default: nextcloud
nextcloud_db_pass:
description: Password to authenticate Nextcloud against the database server.
type: str
required: true
nextcloud_db_name:
description: Name of the database that Nextcloud should use.
type: str
default: nextcloud
nextcloud_admin_user:
description: Username for the initial Nextcloud administrator account created on installation.
type: str
required: true
nextcloud_admin_pass:
description: Password for the initial Nextcloud administrator account created on installation.
type: str
required: true
nextcloud_admin_email:
description: E-Mail address for the initial Nextcloud administrator account created on installation.
type: str
required: true
nextcloud_enabled_apps:
description:
- List of nextcloud apps to be enabled.
- Apps that are not bundled with the Nextcloud installation are installed via O(nextcloud_app_packages).
type: list
elements: str
default: []
nextcloud_disabled_apps:
description:
- List of nextcloud apps to be disabled.
type: list
elements: str
default: []
nextcloud_app_packages:
description:
- The list of Nextcloud apps to install via Debian packages.
- By default, this is automatically compiled from the variable O(nextcloud_enabled_apps).
type: list
elements: str
default: []
nextcloud_system_configuration:
description:
- Nextcloud system config options and their values to apply.
- Options are set through C(occ config:set).
- Options must be provided as a dict of options as keys and their values as values.
type: dict
default: {}
nextcloud_apps_configuration:
description:
- Configuration options of individual apps and their values to apply.
- Options are set through C(occ config:app:set).
- Options must be provided as a nested dictionary.
- The outer dictionary maps app names to an inner dictionary of options and values.
type: dict
default: {}