README.md in trocla-0.0.12 vs README.md in trocla-0.1.0
- old
+ new
@@ -55,10 +55,21 @@
trocla create user1 pgsql 'username: user1'
This will create a pgsql password hash using the username user1.
+Valid global options are:
+
+* length: int - Define any lenght that a newly created password should have. Default: 12 - or whatever you define in your global settings.
+* charset: (default|alphanumeric|shellsafe) - Which set of chars should be used for a random password? Default: default - or whatever you define in your global settings.
+
+Example:
+
+ trocla create some_shellsafe_password plain 'charset: shellsafe'
+ trocla create another_alphanumeric_20_char_password plain "charset: alphanumeric
+ length: 20"
+
### get
Get simply returns a stored password. It will not create a new password.
Assuming that we are still working with the same storage
@@ -123,12 +134,56 @@
## Installation
Simply build and install the gem.
+## Configuration
+
+Trocla can be configured in /etc/troclarc.yaml and in ~/.troclarc.yaml. A sample configuration file can be found in `lib/trocla/default_config.yaml`.
+
+### Storage backends
+
+Trocla can store your passwords in all backends supported by moneta. A simple YAML file configuration may look as follows:
+
+```YAML
+adapter: :YAML
+adapter_options:
+ :file: '/tmp/trocla.yaml'
+```
+
+In environments with multiple Puppet masters using an existing DB cluster might make sense. The configured user needs to be granted at least SELECT, INSERT, UPDATE, DELETE and CREATE permissions on your database:
+
+```YAML
+adapter: :Sequel
+adapter_options:
+ :db: 'mysql://db.server.name'
+ :user: 'trocla'
+ :password: '***'
+ :database: 'trocladb'
+ :table: 'trocla'
+```
+
+These examples are by no way complete, moneta has much more to offer.
+
+### SSL encryption
+
+You might want to let Trocla encrypt all your passwords
+
+```YAML
+encryption: :ssl
+ssl_options:
+ :private_key: '/var/lib/puppet/ssl/private_keys/trocla.pem'
+ :public_key: '/var/lib/puppet/ssl/public_keys/trocla.pem'
+```
+
## Update & Changes
+### to 0.1.0
+
+1. Supporting encryption of the backends. Many thanks to Thomas Gelf
+1. Adding a windows safe password charset
+
### to 0.0.12
1. change from sha1 signature for the x509 format to sha2
1. Fix an issue where shellsafe characters might have already been initialized with shell-unsafe characters. Plz review any shell-safe character passwords regarding this problem. See the [fix](https://github.com/duritong/trocla/pull/19) for more information. Thanks [asquelt](https://github.com/asquelt) for the fix.
@@ -150,8 +205,8 @@
* Make sure to add tests for it. This is important so I don't break it in a future version unintentionally.
* Please try not to mess with the Rakefile, version, or history. If you want to have your own version, or is otherwise necessary, that is fine, but please isolate to its own commit so I can cherry-pick around it.
## Copyright
-Copyright (c) 2014 mh. See LICENSE.txt for
+Copyright (c) 2015 mh. See LICENSE.txt for
further details.