Editing for install script docs (#7129)

Signed-off-by: Ian Maddaus <ian.maddaus@progress.com>
This commit is contained in:
Ian Maddaus 2024-08-09 12:07:18 -04:00 committed by GitHub
parent 9848bb736f
commit 7192b79e88
No known key found for this signature in database
GPG key ID: B5690EEEBB952194
2 changed files with 20 additions and 14 deletions

View file

@ -57,22 +57,24 @@ inspec exec test.rb -t docker://container_id
Chef InSpec requires Ruby ( >= 3.0.3 ).
All currently supported 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.
All currently supported versions of Chef InSpec (4.0 and later) require accepting the EULA to use. Please visit the [license acceptance page](https://docs.chef.io/licensing/accept/) on the Chef docs site for more information.
### Install as package
The Chef InSpec package is available for MacOS, RedHat, Ubuntu and Windows. Download the latest package at [Chef InSpec Downloads](https://www.chef.io/downloads/tools/inspec) or install Chef InSpec via script:
{{< note >}}Please follow steps mentioned in this document [Chef Software Install Script](/install_omnibus/). Please replace `<YOUR LICENSE ID>` with your licenseId.{{< /note >}}
```
```text
# RedHat, Ubuntu, and macOS
curl https://chefdownload-commerical.chef.io/install.sh?license_id=<YOUR LICENSE ID> | sudo bash -s -- -P inspec
curl https://chefdownload-commerical.chef.io/install.sh?license_id=<LICENSE_ID> | sudo bash -s -- -P inspec
# Windows
. { iwr -useb https://chefdownload-commerical.chef.io/install.ps1?license_id=<YOUR LICENSE ID> } | iex; install -project inspec
. { iwr -useb https://chefdownload-commerical.chef.io/install.ps1?license_id=<LICENSE_ID> } | iex; install -project inspec
```
Replace `<LICENSE_ID>` with your license ID.
For more information about the install scripts, see the [Chef Install Script documentation](/chef_install_script/).
### Install it via rubygems.org
Installing Chef InSpec from source may require installing ruby build tools to manage gem dependencies. (A compiler-free variant is available with reduced functionality; use `inspec-core-bin` and `inspec-core`.)
@ -103,7 +105,6 @@ You may also use `inspec` as a library, with no executable. This does not requir
gem install inspec
```
### Usage via Docker
Download the image and define a function for convenience:

View file

@ -21,10 +21,10 @@ To see which platforms and platform versions Chef InSpec is supported on, see th
You can install Chef InSpec using a curl script.
{{< note >}}Please follow steps mentioned in this document [Chef Software Install Script](/install_omnibus/). Please replace `<YOUR LICENSE ID>` with your licenseId.{{< /note >}}
{{< note >}}Please follow steps mentioned in this document [Chef Software Install Script](/install_omnibus/). Please replace `<LICENSE_ID>` with your licenseId.{{< /note >}}
```bash
curl -L https://chefdownload-commerical.chef.io/install.sh?license_id=<YOUR LICENSE ID> | sudo bash -s -- -P inspec
curl -L https://chefdownload-commerical.chef.io/install.sh?license_id=<LICENSE_ID> | sudo bash -s -- -P inspec
```
## Windows
@ -38,12 +38,14 @@ then double-click on the `.msi` file to launch the installer and follow the prom
You can install Chef InSpec using the following Powershell script.
{{< note >}}Please follow steps mentioned in this document [Chef Software Install Script](/install_omnibus/). Please replace `<YOUR LICENSE ID>` with your licenseId.{{< /note >}}
```powershell
. { iwr -useb https://chefdownload-commerical.chef.io/install.ps1?license_id=<YOUR LICENSE ID> } | iex; install -project inspec
. { iwr -useb https://chefdownload-commerical.chef.io/install.ps1?license_id=<LICENSE_ID> } | iex; install -project inspec
```
Replace `<LICENSE_ID>` with your license ID.
For more information about the install script, see the [Chef Install Script documentation](/chef_install_script/).
Once you have installed Chef InSpec, run `inspec version` to verify that the installation
was successful.
@ -52,12 +54,15 @@ was successful.
### CLI
The following curl script will install Chef InSpec for Ubuntu and Red Hat Enterprise Linux:
{{< note >}}Please follow steps mentioned in this document [Chef Software Install Script](/install_omnibus/). Please replace `<YOUR LICENSE ID>` with your licenseId.{{< /note >}}
```bash
curl https://chefdownload-commerical.chef.io/install.sh?license_id=<YOUR LICENSE ID> | sudo bash -s -- -P inspec
curl https://chefdownload-commerical.chef.io/install.sh?license_id=<LICENSE_ID> | sudo bash -s -- -P inspec
```
Replace `<LICENSE_ID>` with your license ID.
For more information about the install script, see the [Chef Install Script documentation](/chef_install_script/).
If you prefer, you can use a package manager to install Chef InSpec.
Once you downloaded the latest [Chef InSpec package](https://www.chef.io/downloads)
relevant to your Linux-based platform, use the command for the respective package