Skip to content

Commit e65f964

Browse files
authored
Update README for Extra Config Options
1 parent 71e661c commit e65f964

File tree

1 file changed

+18
-0
lines changed

1 file changed

+18
-0
lines changed

README.md

+18
Original file line numberDiff line numberDiff line change
@@ -124,6 +124,24 @@ Configure attributes:
124124

125125
This will enable the SFTP Server and chroot every user in the `sftpusers` group to the `/home/sftp/%u` directory.
126126

127+
## Extra Configuration Options
128+
Extra configuration options can be appended to the client or server configuration files. This can be used to override statically set values, or add configuration options not otherwise available via attributes.
129+
130+
The syntax is as follows:
131+
```
132+
# => Extra Server Configuration
133+
default['ssh-hardening']['ssh']['server']['extras'].tap do |extra|
134+
extra['#Some Comment'] = 'Heres the Comment'
135+
extra['AuthenticationMethods'] = 'publickey,keyboard-interactive'
136+
end
137+
138+
# => Extra Client Configuration
139+
default['ssh-hardening']['ssh']['client']['extras'].tap do |extra|
140+
extra['PermitLocalCommand'] = 'no'
141+
extra['Tunnel'] = 'no'
142+
end
143+
```
144+
127145
## Local Testing
128146

129147
For local testing you can use vagrant and Virtualbox of VMWare to run tests locally. You will have to install Virtualbox and Vagrant on your system. See [Vagrant Downloads](http://downloads.vagrantup.com/) for a vagrant package suitable for your system. For all our tests we use `test-kitchen`. If you are not familiar with `test-kitchen` please have a look at [their guide](http://kitchen.ci/docs/getting-started). We are writing our test with [InSpec](https://github.com/chef/inspec).

0 commit comments

Comments
 (0)