diff --git a/README.markdown b/README.markdown index 4970e1b68..47e395c0a 100644 --- a/README.markdown +++ b/README.markdown @@ -2,29 +2,22 @@ Manage SSH client and server via Puppet -## Client only -Collected host keys from servers will be written to known_hosts - -``` - include ssh::client -``` +### Gittip +[![Support via Gittip](https://rawgithub.com/twolfson/gittip-badge/0.2.0/dist/gittip.png)](https://www.gittip.com/saz/) -## Server only -Host keys will be collected for client distribution +## Requirements +* Exported resources for host keys management +* puppetlabs/stdlib -``` - include ssh::server -``` +## Usage -## Both client and server +### Both client and server Host keys will be collected and distributed ``` include ssh ``` -### Changing options - ``` class { 'ssh': server_options => { @@ -44,7 +37,47 @@ Host keys will be collected and distributed } ``` -# Requirements -* Exported resources for host keys management -* puppetlabs/stdlib +### Client only +Collected host keys from servers will be written to known_hosts +``` + include ssh::client +``` + +``` + class { 'ssh::client': + options => { + 'Host short' => { + 'User' => 'my-user', + 'HostName' => 'extreme.long.and.complicated.hostname.domain.tld', + }, + 'Host *' => { + 'User' => 'andromeda', + 'UserKnownHostsFile' => '/dev/null', + }, + }, + } +``` + +### Server only +Host keys will be collected for client distribution + +``` + include ssh::server +``` + +``` + class { 'ssh::server': + options => { + 'Match User www-data' => { + 'ChrootDirectory' => '%h', + 'ForceCommand' => 'internal-sftp', + 'PasswordAuthentication' => 'yes', + 'AllowTcpForwarding' => 'no', + 'X11Forwarding' => 'no', + }, + 'PasswordAuthentication' => 'no', + 'PermitRootLogin' => 'no', + }, + } +```