troyready
0fc5a7a249
correct small typo
2015-12-11 13:05:22 -08:00
Christoph Hartmann
1ce1f26d76
update docs for auditd_conf
2015-12-11 17:28:51 +01:00
Christoph Hartmann
82b63bbce2
update documentation for auditd_conf
and sshd_config
2015-12-11 17:10:17 +01:00
Stephan Renatus
1f1b035589
[resource/port] update documentation
2015-12-08 20:33:36 +01:00
Stephan Renatus
7a1cd660c3
[resources/processes] add users, states attribute; update docs
...
processes('bash').user does not actually make much sense for a resource
that is a list -- different entries can belong to different users.
Analogous for processes('bash').state.
The attributes 'users' and 'states' expose the unique values
corresponding to that property of entries in the process list.
Fixes #295 .
2015-12-08 13:06:27 +01:00
Stephan Renatus
ae4420a736
add --json-config=
and --diagnose
flags to inspect configurations
...
Because of the way per-command arguments are handled, this is a little
different from the way e.g. kitchen handles it: any inspec command can
take the flag `--diagnose` to have it dump configuration first.
This add support for a JSON configuration file, where both
inspec detect --json-config=config.json
and
inspec detect --json-config=- <config.json
allow for reading the JSON config. There is no validation of its keys
in place.
2015-12-07 16:10:15 +01:00
Christoph Hartmann
cca75c5e8c
align cli documentation with cli
2015-12-01 11:19:04 +01:00
Christoph Hartmann
5018e1e03e
remove json doc for windows_feature
2015-11-30 15:18:26 +01:00
alexmanly
c114d2bcd2
Add -p alias for --port like ssh
2015-11-25 14:55:06 +01:00
Jason Reed
79eba9b4fa
Add -i alias for --key_files like ssh
2015-11-25 07:10:11 -05:00
JJ Asghar
d1e35b37ec
Added links to the different sections.
...
- Reading the Doc probably want to use the list as an Table of Contents
to jump to another section. This does that.
- Group isn't considered Unique in the doc, so the link goes to the same
page.
2015-11-19 15:22:15 +01:00
Stuart Preston
3ddd8e8243
OS resource requires a Symbol not a String
2015-11-07 11:56:01 +00:00
Zach Malone
0d35ead5b4
Fix should contain / should match confusion
...
If attempting to use "contain" here, you get
[UNSUPPORTED] `contain` matcher. Please use the following syntax `its('content') { should match('value') }`.
it looks like this should say "should match". This may effect other resources, but I've only tried file.
2015-11-04 10:35:35 -07:00
Julian C. Dunn
8764dd0194
Fix doc typos
2015-11-04 11:38:39 +00:00
Fletcher Nichol
50930dc520
Fix package resource documentation example.
2015-11-04 00:30:02 +01:00
Dominik Richter
7dd7f29dee
fix formatting of list
2015-11-03 19:30:50 +01:00
Dominik Richter
326965e7dc
add inspec and friends, thank you @chris-rock, @nathenharvey, @colincam, @juliandunn
2015-11-03 19:29:13 +01:00
Christoph Hartmann
43194819e4
rename to control
2015-11-02 23:24:14 +00:00
jamescott
03303b4aba
formatting, mostly ... also package => oneget
2015-11-02 00:55:05 -08:00
Dominik Richter
4c3dce0aec
fix key-files option in docs
2015-11-02 02:06:14 +01:00
Christoph Hartmann
ee3e56adae
update ssh docs
2015-11-02 02:06:14 +01:00
Christoph Hartmann
ad73a606ff
update script and ssh docs
2015-11-02 02:06:14 +01:00
Christoph Hartmann
4e1029f65f
update postgres and script docs
2015-11-02 02:06:14 +01:00
Christoph Hartmann
d44a917385
update port description
2015-11-02 02:06:14 +01:00
Christoph Hartmann
dc1959327f
update description for passwd docs
2015-11-02 02:06:14 +01:00
Christoph Hartmann
ed092b6c0f
update parse_config & passwd
2015-11-02 02:06:14 +01:00
Christoph Hartmann
bfcfe747a7
fix resource doc typos
2015-11-02 02:06:14 +01:00
Christoph Hartmann
64f1e5ee1e
fix resource doc typos
2015-11-02 02:06:14 +01:00
Christoph Hartmann
e52e3b6753
update examples in docs
2015-11-02 02:06:14 +01:00
Christoph Hartmann
789b6cf83f
fix typo in readme
2015-11-02 02:06:14 +01:00
Christoph Hartmann
afb9c2441a
update cli options
2015-11-02 02:06:10 +01:00
Christoph Hartmann
f8302b6383
use ssh_config instead of sshd_conf
2015-11-02 01:53:49 +01:00
Dominik Richter
00e2d800e4
adjust documentation for api change to --sudo
2015-11-02 01:05:00 +01:00
Christoph Hartmann
2a400c37f7
update resource examples
2015-11-01 22:58:31 +01:00
jamescott
ca77f1285c
add draft version of InSpec DSL topic
2015-11-01 22:58:31 +01:00
Christoph Hartmann
1941606b9e
deactivate group policy for now
2015-11-01 22:39:30 +01:00
Christoph Hartmann
9e53556379
fix os_env example
2015-10-31 11:55:10 +01:00
Christoph Hartmann
e08f0b4d88
add abbreviations
2015-10-30 14:29:19 +01:00
jcreedcmu
801bc9700f
Update ctl_inspec.rst
...
Documentation appears to have been describing the state of the world before a62ce0e14b
2015-10-30 12:44:30 +01:00
Jason Reed
5b6397fc25
Fix docs so they at least compile with rst2html.py
2015-10-30 07:28:40 -04:00
jamescott
5c22048caa
sync words
...
|inspec resource| = InSpec audit resource
2015-10-27 23:26:42 +01:00
Christoph Hartmann
438dca1d28
improve docs for parse_config_file
2015-10-27 21:34:09 +01:00
Christoph Hartmann
178cf2564d
remove postgres and mysql from resource docs for now
2015-10-27 21:34:09 +01:00
Christoph Hartmann
0e6a6296a3
remove to_i in its docs
2015-10-27 21:34:09 +01:00
Christoph Hartmann
7f3082f103
introduce stability index for resources
2015-10-27 21:34:08 +01:00
Christoph Hartmann
ebeac09036
extend docs introduction
2015-10-27 21:34:08 +01:00
Christoph Hartmann
164aad5b86
update index of resource docs
2015-10-27 02:26:19 +01:00
Christoph Hartmann
c9defc90c7
add reference to docker
2015-10-27 02:26:19 +01:00
Christoph Hartmann
a1943296cf
docs cli change replacements
2015-10-27 02:26:19 +01:00
Christoph Hartmann
7443b388c2
remove docs done flag
2015-10-27 02:26:19 +01:00