diff --git a/README.md b/README.md index 5c38fc7..d24e584 100644 --- a/README.md +++ b/README.md @@ -1,6 +1,6 @@ -# SSH Key Rotation +# Ansible role for SSH Key Rotation -This is Ansible role that enables you to rotate ssh keys on your remote servers. Forked from [nyambati/ssh-key-rotation](https://github.com/nyambati/ssh-key-rotation/tree/master). By default, this role generates an ed25519 key pair with the Ansible group and the current date as its name. +An Ansible role that rotates SSH keys on remote servers. By default, the role generates an ed25519 key pair. The current date and Ansible group name are used as the name and comment of the key pair ## Example Playbook @@ -10,7 +10,7 @@ This is Ansible role that enables you to rotate ssh keys on your remote servers. hosts: all remote_user: user vars: - is_exclusive: no + is_exclusive: yes ssh_host_user: user vars_prompt: - name: passphrase @@ -23,6 +23,6 @@ This is Ansible role that enables you to rotate ssh keys on your remote servers. - ssh-key-rotation ``` -## Original Author +## Credits -Thomas Nyambati \ No newline at end of file +This role is forked from [nyambati/ssh-key-rotation](https://github.com/nyambati/ssh-key-rotation/tree/master) by Thomas Nyambati. \ No newline at end of file