aboutsummaryrefslogtreecommitdiffstats
path: root/roles/root_authorized_keys
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-19 20:48:32 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-19 20:48:32 -0500
commit30d7b5ca383cdef702c9b1add4ed464e6ff379c2 (patch)
treea5142e2087f1fdd1b4c918843df6aa8a26abbbb5 /roles/root_authorized_keys
parent16491198b3ba4723d94f959f101c138592af9f12 (diff)
downloadselfhosted-30d7b5ca383cdef702c9b1add4ed464e6ff379c2.tar.gz
selfhosted-30d7b5ca383cdef702c9b1add4ed464e6ff379c2.zip
root_authorized_keys: add docs
Diffstat (limited to 'roles/root_authorized_keys')
-rw-r--r--roles/root_authorized_keys/README.md35
1 files changed, 35 insertions, 0 deletions
diff --git a/roles/root_authorized_keys/README.md b/roles/root_authorized_keys/README.md
new file mode 100644
index 0000000..d92aa62
--- /dev/null
+++ b/roles/root_authorized_keys/README.md
@@ -0,0 +1,35 @@
+Root Authorized Keys
+====================
+
+Description
+-----------
+
+The `root_authorized_keys` role adds SSH public keys to the root user's
+`authorized_keys` file.
+
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+-----------------------|---------|------------
+`root_authorized_keys` | `[]` | List of SSH pubkeys
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- name: set root authorized_keys
+ hosts: all
+ roles:
+ - role: root_authorized_keys
+ vars:
+ root_authorized_keys:
+ - ssh-ed25519 AAAA...
+ - ssh-ed25519 AAAA...
+````