postgresql_server: add docs

1 files changed, 36 insertions, 0 deletions

diff --git a/roles/postgresql_server/README.md b/roles/postgresql_server/README.md
new file mode 100644
index 0000000..493bdb0
--- /dev/null
+++ b/roles/postgresql_server/README.md
@@ -0,0 +1,36 @@
+PostgreSQL Server
+=================
+
+Description
+-----------
+
+The `postgresql_server` role installs and configures the PostgreSQL database,
+and configures the server for client GSSAPI authentication.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable                         | Default          | Description
+---------------------------------|------------------|------------
+`postgresql_timezone`            | `{{ timezone }}` | Database timezone
+`postgresql_max_connections`     | 100              | Maximum number of concurrent connections
+`postgresql_shared_buffers_mb`   | 25% of host RAM  | Shared buffer size (MB)
+`postgresql_password_users`      | `[]`             | List of users that don't support GSSAPI authentication
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: configure postgresql
+  hosts: postgresql_servers
+  roles:
+    - role: postgresql
+      vars:
+        postgresql_password_users:
+          - invidious
+          - mydbuser
+````