Skip to content

Added license id to community api docs #4524

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
rishabhjhs wants to merge 5 commits into
base: main
Choose a base branch
from
Open

Added license id to community api docs #4524

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
95d62fe
Added license id to community api docs
rishabhjhs Dec 12, 2025
ac0c768
Update docs with latest license info
rishabhjhs Dec 19, 2025
03b1da6
Update docs with latest license info
rishabhjhs Dec 19, 2025
1618cd1
Update docs with latest license info
rishabhjhs Dec 19, 2025
137324b
Update docs with latest license info
rishabhjhs Dec 19, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
21 changes: 16 additions & 5 deletions content/chef_install_script.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -85,23 +85,30 @@ For additional script install options, see the [script options](#script-options)

Community users can use the install script from the [Chef Community API](/download/community/) to install Chef software.

### Prerequisites

You must have a license ID to use the install script from the Chef Community API. Only free licenses can be used for community downloads.

### UNIX, Linux, and macOS

Use the Chef install script to install packages on UNIX, Linux, and macOS systems.

By default the script installs the latest available version of Chef Infra Client:

```bash
curl -L https://chefdownload-community.chef.io/install.sh | sudo bash
curl -L https://chefdownload-community.chef.io/install.sh?license_id=<LICENSE_ID> | sudo bash
```

Use the `-P` option to specify a Chef application to install:

```bash
curl -L https://chefdownload-community.chef.io/install.sh | sudo bash -s -- -P <PROJECT>
curl -L https://chefdownload-community.chef.io/install.sh?license_id=<LICENSE_ID> | sudo bash -s -- -P <PROJECT>
```

Replace `<PROJECT>` with the application you want to install.
Replace:

- `<LICENSE_ID>` with your license ID
- `<PROJECT>` with the application you want to install

For additional script install options, see the [script options](#script-options).

Expand All @@ -112,15 +119,19 @@ On Windows systems, you can install Chef software using the Powershell install s
By default the script installs the latest available version of Chef Infra Client:

```powershell
. { iwr -useb https://chefdownload-community.chef.io/install.ps1 } | iex; install
. { iwr -useb https://chefdownload-community.chef.io/install.ps1?license_id=<LICENSE_ID> } | iex; install
```

Replace `<LICENSE_ID>` with your license ID.

Use the `-project` option to specify a Chef application to install:

```powershell
. { iwr -useb https://chefdownload-community.chef.io/install.ps1 } | iex; install -project <PROJECT>
. { iwr -useb https://chefdownload-community.chef.io/install.ps1?license_id=<LICENSE_ID> } | iex; install -project <PROJECT>
```

Replace `<LICENSE_ID>` with your license ID.

For additional script install options, see the [script options](#script-options).

## Script options
Expand Down
25 changes: 16 additions & 9 deletions content/download/community.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -15,6 +15,8 @@ Chef community members can use Chef's Community API to download Chef software pa

## License

To download packages and review metadata with this API, you need a license ID. Only free licenses can be used for community downloads.

See [Chef's licensing documentation]({{< relref "chef_license" >}}) for more information on the Chef license.

## Endpoints
Expand Down Expand Up @@ -70,45 +72,45 @@ Use `packages` to get a list of all packages for a particular product.
By default, it returns packages for the latest version.

```plain
https://chefdownload-community.chef.io/stable/<PRODUCT>/packages
https://chefdownload-community.chef.io/stable/<PRODUCT>/packages?license_id=<LICENSE_ID>
```

You can specify a version number with the `v` query string to get packages for a particular product version.

```plain
https://chefdownload-community.chef.io/stable/<PRODUCT>/packages?v=<VERSION_NUMBER>
https://chefdownload-community.chef.io/stable/<PRODUCT>/packages?v=<VERSION_NUMBER>&license_id=<LICENSE_ID>
```

### versions/all

Use `versions/all` to return a list of versions of a product.

```plain
https://chefdownload-community.chef.io/stable/<PRODUCT>/versions/all
https://chefdownload-community.chef.io/stable/<PRODUCT>/versions/all?license_id=<LICENSE_ID>
```

### versions/latest

Use `versions/latest` to return the latest version of a product.

```plain
https://chefdownload-community.chef.io/stable/<PRODUCT>/versions/latest
https://chefdownload-community.chef.io/stable/<PRODUCT>/versions/latest?license_id=<LICENSE_ID>
```

### metadata

The `metadata` endpoint returns data about a particular package of a Chef product.

```plain
https://chefdownload-community.chef.io/stable/<PRODUCT>/metadata?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>
https://chefdownload-community.chef.io/stable/<PRODUCT>/metadata?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
```

### download

The `download` endpoint downloads a particular package of a Chef product.

```plain
https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>
https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&v=<PRODUCT_VERSION>&license_id=<LICENSE_ID>
```

## Parameters
Expand All @@ -120,6 +122,11 @@ The API accepts the following parameters in a query string.

A list of valid product keys can be found in the [Chef product matrix](https://github.com/chef/mixlib-install/blob/main/PRODUCT_MATRIX.md) or by using the [`products`](#products) endpoint.

`license_id`
: Your license ID.

A license is required to download packages and retrieve package metadata with this API. Only free licenses can be used for community downloads.

`eol`
: Whether to include EOL versions of a product or EOL products in the response.

Expand Down Expand Up @@ -174,7 +181,7 @@ This is a list of currently supported products that you can install with this AP
To get the latest supported build of Chef Infra Client for Ubuntu 20.04, enter the following:

```plain
https://chefdownload-community.chef.io/stable/chef/metadata?p=ubuntu&pv=20.04&m=x86_64
https://chefdownload-community.chef.io/stable/chef/metadata?p=ubuntu&pv=20.04&m=x86_64&license_id=<LICENSE_ID>
```

which will return something like:
Expand All @@ -191,11 +198,11 @@ version "14.15.6"
To use cURL to download a package directly, enter the following:

```bash
curl -LOJ 'https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>'
curl -LOJ 'https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&license_id=<LICENSE_ID>'
```

To use GNU Wget to download a package directly, enter the following:

```bash
wget --content-disposition https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>
wget --content-disposition https://chefdownload-community.chef.io/stable/<PRODUCT>/download?p=<PLATFORM>&pv=<PLATFORM_VERSION>&m=<ARCHITECTURE>&license_id=<LICENSE_ID>
```