aboutsummaryrefslogtreecommitdiffstats
path: root/roles
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-19 20:53:29 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-19 20:53:29 -0500
commit65c5a6e081ce7174ecd36c89329aa77e7dd77a0b (patch)
tree416d62349adea553c887f6060cab7799ee69dc9d /roles
parent9c5d198012e8bad994003eefe1930a657ba80b98 (diff)
downloadselfhosted-65c5a6e081ce7174ecd36c89329aa77e7dd77a0b.tar.gz
selfhosted-65c5a6e081ce7174ecd36c89329aa77e7dd77a0b.zip
root_password: add docs
Diffstat (limited to 'roles')
-rw-r--r--roles/root_password/README.md34
-rw-r--r--roles/root_password/defaults/main.yml1
2 files changed, 34 insertions, 1 deletions
diff --git a/roles/root_password/README.md b/roles/root_password/README.md
new file mode 100644
index 0000000..cc18e77
--- /dev/null
+++ b/roles/root_password/README.md
@@ -0,0 +1,34 @@
+Root Password
+=============
+
+Description
+-----------
+
+The `root_password` role sets the password for the root user.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+---------------------|---------|------------
+`root_password` | &nbsp; | Root password
+`root_password_salt` | `''` | Salt for SHA-512 hash
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: set root password
+ hosts: all
+ roles:
+ - role: root_password
+ vars:
+ root_password: s3cret
+ root_password_salt: changeme
+````
diff --git a/roles/root_password/defaults/main.yml b/roles/root_password/defaults/main.yml
index 23f5768..ff1eb48 100644
--- a/roles/root_password/defaults/main.yml
+++ b/roles/root_password/defaults/main.yml
@@ -1,2 +1 @@
-root_password: changeme
root_password_salt: ''