Ansible Role: serdigital64.application.app_keepassxc¶
Purpose¶
Manage provisioning of the KeePassXC application.
Supported features in the current version:
- Deploy application. Packages are defined in the variable
app_keepassxc_profiles. - Configure application:
- Deploy default user configuration
The app_keepassxc Ansible-Role is part of the A:Platform64 project and is available in the application Ansible-Collection.
Usage¶
The following example is an Ansible Playbook that includes all the supported features:
use this link if viewing the doc on github
---
- name: "Application / KeePassXC / Usage example"
hosts: "localhost"
gather_facts: true
tasks:
- name: "Example: Install KeePassXC"
vars:
app_keepassxc:
resolve_prereq: true
deploy: true
ansible.builtin.include_role:
name: "serdigital64.application.app_keepassxc"
...
The playbook can be run by executing:
# Set ANSIBLE_COLLECTIONS_PATHS to the default location. Change as needed.
ANSIBLE_COLLECTIONS_PATHS="${HOME}/.ansible/collections"
ansible-playbook "${ANSIBLE_COLLECTIONS_PATHS}/ansible_collections/serdigital64/application/playbooks/app_keepassxc.yml"
Role Parameters¶
Actions¶
- Use action-parameters to control what tasks are enabled for the role to execute.
- Parameters should be declared as task level vars as they are intented to be dynamic.
app_keepassxc:
resolve_prereq:
deploy:
setup:
| Parameter | Required? | Type | Default | Purpose / Value |
|---|---|---|---|---|
| app_keepassxc.resolve_prereq | no | boolean | false | Enable automatic resolution of prequisites |
| app_keepassxc.deploy | no | boolean | false | Enable installation of application packages |
| app_keepassxc.setup | no | boolean | false | Enable application configuration |
End State¶
- Use end-state parameters to define the target state after role execution.
- Parameters should be declared in host_vars or group_vars as they are intended to be permanent.
app_keepassxc_application:
name:
type:
version:
installed:
app_keepassxc_actions:
setup:
overwrite:
app_keepassxc_setup_users:
- name:
home:
| Parameter | Required? | Type | Default | Purpose / Value |
|---|---|---|---|---|
| app_keepassxc_application | no | dictionary | Set application package end state | |
| app_keepassxc_application.name | no | string | "keepassxc" | Select application package name |
| app_keepassxc_application.type | no | string | "distro" | Select application package type |
| app_keepassxc_application.version | no | string | "latest" | Select application package version |
| app_keepassxc_application.installed | no | boolean | true | Set application package end state |
| app_keepassxc_actions | no | dictionary | Set action options | |
| app_keepassxc_actions.setup | no | dictionary | Set setup action options | |
| app_keepassxc_actions.setup.overwrite | no | boolean | false | Overwrite user configurations? |
| app_keepassxc_setup_users | yes(setup) | list | List of users for the setup task | |
| app_keepassxc_setup_users.0.name | yes | string | User login name | |
| app_keepassxc_setup_users.0.home | yes | string | Home full path |
Deployment¶
OS Compatibility¶
- Ubuntu20
- Ubuntu21
- Fedora33
- Fedora35
- Debian10
- Debian11
Dependencies¶
- Ansible Collections:
- serdigital64.backup
- bkp_archive
- serdigital64.system
- sys_package
- sys_repository
- serdigital64.backup
Prerequisites¶
The Ansible engine must be already installed and configured for privileged access and remote execution.
In addition the following prerequisites can be automatically solved when running the playbook by setting the role action: resolve_prereq: true
- Package manager for the target application is installed and enabled.
Installation Procedure¶
Manually install Ansible Collections from the Ansible Galaxy repository:
ansible-galaxy collection install --upgrade serdigital64.application
Automatic installation is also available by deploying A:Platform64
Contributing¶
Help on implementing new features and maintaining the code base is welcomed.
Please see the guidelines for further details.