cleanup readme

This commit is contained in:
Robert Kaussow 2020-01-30 22:58:49 +01:00
parent 1433cc8803
commit 89626d2920

163
README.md
View File

@ -1,167 +1,14 @@
# xoxys.cups
[![Build Status](https://drone.rknet.org/api/badges/ansible/xoxys.cups/status.svg)](https://drone.rknet.org/ansible/xoxys.cups)
[![Build Status](https://img.shields.io/drone/build/ansible/xoxys.cups?logo=drone&server=https%3A%2F%2Fdrone.rknet.org)](https://drone.rknet.org/ansible/xoxys.cups)
Setup cups printserver
## Table of content
### License
* [Default Variables](#default-variables)
* [cups_admin_group](#cups_admin_group)
* [cups_admin_users](#cups_admin_users)
* [cups_bind_url](#cups_bind_url)
* [cups_log_level](#cups_log_level)
* [cups_packages_extra](#cups_packages_extra)
* [cups_remote_admin_enabled](#cups_remote_admin_enabled)
* [cups_selinux_fcontext](#cups_selinux_fcontext)
* [cups_selinux_restorecon](#cups_selinux_restorecon)
* [cups_server_admin](#cups_server_admin)
* [cups_server_alias](#cups_server_alias)
* [cups_server_name](#cups_server_name)
* [cups_system_groups](#cups_system_groups)
* [cups_version](#cups_version)
* [Dependencies](#dependencies)
* [License](#license)
* [Author](#author)
This project is licensed under the MIT License - see the [LICENSE](LICENSE) file for details.
---
### Maintainers and Contributors
## Default Variables
### cups_admin_group
#### Default value
```YAML
cups_admin_group: printadmin
```
### cups_admin_users
#### Default value
```YAML
cups_admin_users:
- name: cupsadm
password: secure
```
### cups_bind_url
#### Default value
```YAML
cups_bind_url:
- localhost:631
```
### cups_log_level
#### Default value
```YAML
cups_log_level: warn
```
### cups_packages_extra
Install dependencies or custom driver packages
#### Default value
```YAML
cups_packages_extra: []
```
### cups_remote_admin_enabled
#### Default value
```YAML
cups_remote_admin_enabled: false
```
### cups_selinux_fcontext
#### Default value
```YAML
cups_selinux_fcontext: []
```
#### Example usage
```YAML
cups_selinux_fcontext:
- target: /opt/brother
setype: bin_t
```
### cups_selinux_restorecon
#### Default value
```YAML
cups_selinux_restorecon: []
```
#### Example usage
```YAML
["-R /opt/brother"]
```
### cups_server_admin
#### Default value
```YAML
cups_server_admin: admin@example.com
```
### cups_server_alias
#### Default value
```YAML
cups_server_alias: '{{ cups_server_name }}'
```
### cups_server_name
#### Default value
```YAML
cups_server_name: print.example.org
```
### cups_system_groups
#### Default value
```YAML
cups_system_groups:
- root
- '{{ cups_admin_group }}'
```
### cups_version
#### Default value
```YAML
cups_version: 2.2.10
```
## Dependencies
None.
## License
MIT
## Author
[xoxys](https://gitea.rknet.org/xoxys)
[Robert Kaussow](https://gitea.rknet.org/xoxys)