ansible-collection-bareos/roles/bareos_webui/README.md
2024-03-03 05:37:23 +07:00

110 lines
4.5 KiB
Markdown

# [Ansible role bareos_webui](#bareos_webui)
Install and configure [Bareos](https://www.bareos.com/) WebUI on your system.
|GitHub|GitLab|Downloads|Version|
|------|------|---------|-------|
|[![github](https://github.com/anry/ansible-role-bareos_webui/workflows/Ansible%20Molecule/badge.svg)](https://github.com/anry/ansible-role-bareos_webui/actions)|[![gitlab](https://gitlab.com/anry-iac/ansible-role-bareos_webui/badges/master/pipeline.svg)](https://gitlab.com/anry-iac/ansible-role-bareos_webui)|[![downloads](https://img.shields.io/ansible/role/d/anry/bareos_webui)](https://galaxy.ansible.com/anry/bareos_webui)|[![Version](https://img.shields.io/github/release/anry/ansible-role-bareos_webui.svg)](https://github.com/anry/ansible-role-bareos_webui/releases/)|
## [Example Playbook](#example-playbook)
This example is taken from [`molecule/default/converge.yml`](https://github.com/anry/ansible-role-bareos_webui/blob/master/molecule/default/converge.yml) and is tested on each push, pull request and release.
```yaml
---
- name: Converge
hosts: all
become: yes
gather_facts: yes
roles:
- role: anry.roles.bareos_webui
bareos_webui_directors:
- name: localhost-dir
enabled: yes
diraddress: localhost
- name: disabled-dir
enabled: no
```
The machine needs to be prepared. In CI this is done using [`molecule/default/prepare.yml`](https://github.com/anry/ansible-role-bareos_webui/blob/master/molecule/default/prepare.yml):
```yaml
---
- name: Prepare
hosts: all
become: yes
gather_facts: no
roles:
- role: anry.roles.bootstrap
- role: anry.roles.bareos_repository
```
Also see a [full explanation and example](https://anry.nl/how-to-use-these-roles.html) on how to use these roles.
## [Role Variables](#role-variables)
The default values for the variables are set in [`defaults/main.yml`](https://github.com/anry/ansible-role-bareos_webui/blob/master/defaults/main.yml):
```yaml
---
# defaults file for bareos_webui
bareos_webui_configuration:
- section: session
option: timeout
value: 3600
bareos_webui_directors: []
```
## [Requirements](#requirements)
- pip packages listed in [requirements.txt](https://github.com/anry/ansible-role-bareos_webui/blob/master/requirements.txt).
## [State of used roles](#state-of-used-roles)
The following roles are used to prepare a system. You can prepare your system in another way.
| Requirement | GitHub | GitLab |
|-------------|--------|--------|
|[anry.bootstrap](https://galaxy.ansible.com/anry/bootstrap)|[![Build Status GitHub](https://github.com/anry/ansible-role-bootstrap/workflows/Ansible%20Molecule/badge.svg)](https://github.com/anry/ansible-role-bootstrap/actions)|[![Build Status GitLab](https://gitlab.com/anry-iac/ansible-role-bootstrap/badges/master/pipeline.svg)](https://gitlab.com/anry-iac/ansible-role-bootstrap)|
|[anry.bareos_repository](https://galaxy.ansible.com/anry/bareos_repository)|[![Build Status GitHub](https://github.com/anry/ansible-role-bareos_repository/workflows/Ansible%20Molecule/badge.svg)](https://github.com/anry/ansible-role-bareos_repository/actions)|[![Build Status GitLab](https://gitlab.com/anry-iac/ansible-role-bareos_repository/badges/master/pipeline.svg)](https://gitlab.com/anry-iac/ansible-role-bareos_repository)|
## [Context](#context)
This role is a part of many compatible roles. Have a look at [the documentation of these roles](https://anry.nl/) for further information.
Here is an overview of related roles:
![dependencies](https://raw.githubusercontent.com/anry/ansible-role-bareos_webui/png/requirements.png "Dependencies")
## [Compatibility](#compatibility)
This role has been tested on these [container images](https://hub.docker.com/u/anry):
|container|tags|
|---------|----|
|[Debian](https://hub.docker.com/r/anry/debian)|bookworm, bullseye, buster|
|[EL](https://hub.docker.com/r/anry/enterpriselinux)|8, 9|
|[Fedora](https://hub.docker.com/r/anry/fedora/)|38, 39|
|[Ubuntu](https://hub.docker.com/r/anry/ubuntu)|jammy, focal|
The minimum version of Ansible required is 2.12, tests have been done to:
- The previous version.
- The current version.
- The development version.
If you find issues, please register them in [GitHub](https://github.com/anry/ansible-role-bareos_webui/issues).
## [License](#license)
[Apache-2.0](https://github.com/anry/ansible-role-bareos_webui/blob/master/LICENSE).
## [Author Information](#author-information)
[anry](https://anry.nl/)
Please consider [sponsoring me](https://github.com/sponsors/anry).