From 6b54417bd5477fbc3148d1d756c173c049a145b4 Mon Sep 17 00:00:00 2001 From: Jinn Koriech Date: Thu, 5 Dec 2013 10:35:35 +0000 Subject: [PATCH 1/3] Add documentation for usage of encrypted postgresql passwords. --- library/database/postgresql_user | 1 + 1 file changed, 1 insertion(+) diff --git a/library/database/postgresql_user b/library/database/postgresql_user index 1bda98d18cb..01a37731e76 100644 --- a/library/database/postgresql_user +++ b/library/database/postgresql_user @@ -44,6 +44,7 @@ options: password: description: - set the user's password, before 1.4 this was required. + - "When passing an encrypted password it must be generated with the format C('str(\"md5\") + md5( password + username )'), resulting in a total of 35 characters. An easy way to do this is: C(echo \"md5$(echo -n \"verysecretpasswordJOE\" | md5)\")." required: false default: null db: From 6f2843724d525fbef76def906a834a778609d961 Mon Sep 17 00:00:00 2001 From: Jinn Koriech Date: Thu, 5 Dec 2013 16:57:56 +0000 Subject: [PATCH 2/3] Fix postgresql_user documentation render --- library/database/postgresql_user | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/library/database/postgresql_user b/library/database/postgresql_user index 01a37731e76..7897ecac72f 100644 --- a/library/database/postgresql_user +++ b/library/database/postgresql_user @@ -44,7 +44,7 @@ options: password: description: - set the user's password, before 1.4 this was required. - - "When passing an encrypted password it must be generated with the format C('str(\"md5\") + md5( password + username )'), resulting in a total of 35 characters. An easy way to do this is: C(echo \"md5$(echo -n \"verysecretpasswordJOE\" | md5)\")." + - "When passing an encrypted password it must be generated with the format C('str[\\"md5\\"] + md5[ password + username ]'), resulting in a total of 35 characters. An easy way to do this is: C(echo \\"md5`echo -n \\"verysecretpasswordJOE\\" | md5`\\")." required: false default: null db: From 80d6ca19af92a5543201d76a09a1de4e4e25aa55 Mon Sep 17 00:00:00 2001 From: Jinn Koriech Date: Thu, 5 Dec 2013 17:01:49 +0000 Subject: [PATCH 3/3] Add README info for building the module documentation. --- docsite/README.md | 5 ++++- 1 file changed, 4 insertions(+), 1 deletion(-) diff --git a/docsite/README.md b/docsite/README.md index 34d914bf099..c6017d7c197 100644 --- a/docsite/README.md +++ b/docsite/README.md @@ -7,7 +7,10 @@ Contributions to the documentation are welcome. To make changes, submit a pull that changes the reStructuredText files in the "rst/" directory only, and Michael can do a docs build and push the static files. If you wish to verify output from the markup such as link references, you may [install Sphinx] and build the documentation by running -`make viewdocs` from the `ansible/docsite` directory. +`make viewdocs` from the `ansible/docsite` directory. To include module documentation +you'll need to run `make webdocs` at the top level of the repository. The generated +html files are in docsite/htmlout/ and will require Wordpress to render correctly. + If you do not want to learn the reStructuredText format, you can also [file issues] about documentation problems on the Ansible GitHub project.