aboutsummaryrefslogtreecommitdiffstats
path: root/roles
diff options
context:
space:
mode:
Diffstat (limited to 'roles')
-rw-r--r--roles/cups_server/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/roles/cups_server/README.md b/roles/cups_server/README.md
new file mode 100644
index 0000000..d901613
--- /dev/null
+++ b/roles/cups_server/README.md
@@ -0,0 +1,35 @@
+CUPS Server
+===========
+
+Description
+-----------
+
+The `cups_server` role installs and configures the CUPS print server.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+----------------------|---------------------------|------------
+`cups_server_aliases` | `{{ cnames }}` | Aliases used for HTTP header validation
+`cups_server_admin` | `root@{{ email_domain }}` | Email address of the server administrator
+`cups_admin_group` | `role-cups-admin` | FreeIPA group for CUPS administrators (will be created)
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: configure CUPS servers
+ hosts: cups_servers
+ roles:
+ - role: cups_server
+ vars:
+ cups_server_admin: printer-admin@example.com
+ cups_admin_group: print-admins
+````