Merge pull request #4163 from inspec/cw/fix-4145-mention-inspec-bin

Mention inspec-bin gem in installation instructions
This commit is contained in:
Miah Johnson 2019-05-31 11:29:37 -07:00 committed by GitHub
commit b27f52b8d7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
2 changed files with 11 additions and 4 deletions

View file

@ -53,7 +53,7 @@ inspec exec test.rb -t docker://container_id
## Installation ## Installation
Chef InSpec requires Ruby ( >= 2.4 ). Chef InSpec requires Ruby ( >= 2.4 ).
Note: Versions of Chef InSpec 4.0 and later require accepting the EULA to use. Please visit the [license acceptance page](https://docs.chef.io/chef_license_accept.html) on the Chef docs site for more information. Note: Versions of Chef InSpec 4.0 and later require accepting the EULA to use. Please visit the [license acceptance page](https://docs.chef.io/chef_license_accept.html) on the Chef docs site for more information.
@ -85,12 +85,19 @@ For Ubuntu:
apt-get -y install ruby ruby-dev gcc g++ make apt-get -y install ruby ruby-dev gcc g++ make
``` ```
To install inspec from [rubygems](https://rubygems.org/): To install the `inspec` executable, which requires accepting the [Chef License](https://docs.chef.io/chef_license_accept.html), run:
```bash
gem install inspec-bin
```
You may also use `inspec` as a library, with no executable. This does not require accepting the license. To install the library as a gem, run:
```bash ```bash
gem install inspec gem install inspec
``` ```
### Usage via Docker ### Usage via Docker
Download the image and define a function for convenience: Download the image and define a function for convenience:

View file

@ -70,12 +70,12 @@ header.bg-gradient.margin-top-offset.short-bg.relative
' Chef InSpec is included in the ' Chef InSpec is included in the
a href="https://downloads.chef.io/chefdk" ChefDK a href="https://downloads.chef.io/chefdk" ChefDK
' and is available as a standalone ' and is available as a standalone
a href="https://rubygems.org/gems/inspec" Ruby gem a href="https://rubygems.org/gems/inspec-bin" Ruby gem
' . ' .
.pad-under-xs .pad-under-xs
.box-code.shadow.box-code-overwrite.margin-top-xs .box-code.shadow.box-code-overwrite.margin-top-xs
i#copy.fa.fa-copy.copy.t-purple.mobile-hide onclick="copyToClipboard('#ruby-users-install')" i#copy.fa.fa-copy.copy.t-purple.mobile-hide onclick="copyToClipboard('#ruby-users-install')"
code#ruby-users-install gem install inspec code#ruby-users-install gem install inspec-bin
.triangle-right .triangle-right