diff --git a/changelogs/fragments/490_doc_authorized_key_path.yml b/changelogs/fragments/490_doc_authorized_key_path.yml new file mode 100644 index 0000000..ba5311f --- /dev/null +++ b/changelogs/fragments/490_doc_authorized_key_path.yml @@ -0,0 +1,3 @@ +--- +bugfixes: + - "Bugfix in the documentation regarding the path option for authorised_key(https://github.com/ansible-collections/ansible.posix/issues/483)." diff --git a/plugins/modules/authorized_key.py b/plugins/modules/authorized_key.py index 424ee4a..26b5b0a 100644 --- a/plugins/modules/authorized_key.py +++ b/plugins/modules/authorized_key.py @@ -28,8 +28,10 @@ options: required: true path: description: - - Alternate path to the authorized_keys file. - - When unset, this value defaults to I(~/.ssh/authorized_keys). + - Alternative path to the authorized_keys file. + - The default value is the C(.ssh/authorized_keys) of the home of the user specified in the O(user) parameter. + - Most of the time, it's not necessary to set this key. + - Use the path to your target authorized_keys if you need to explicitly point on it. type: path manage_dir: description: