From 95d62fe1e75d0b654d3fa3a6d97dcd4cae83e04f Mon Sep 17 00:00:00 2001 From: rishabhjhs Date: Fri, 12 Dec 2025 13:23:25 +0530 Subject: [PATCH 1/5] Added license id to community api docs Signed-off-by: rishabhjhs --- content/chef_install_script.md | 17 ++++++++++++----- content/download/community.md | 23 ++++++++++++++--------- 2 files changed, 26 insertions(+), 14 deletions(-) diff --git a/content/chef_install_script.md b/content/chef_install_script.md index 15ec6eb0e3..bc74643a89 100644 --- a/content/chef_install_script.md +++ b/content/chef_install_script.md @@ -92,16 +92,19 @@ Use the Chef install script to install packages on UNIX, Linux, and macOS system 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= | 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 +curl -L https://chefdownload-community.chef.io/install.sh?license_id= | sudo bash -s -- -P ``` -Replace `` with the application you want to install. +Replace: + +- `` with your license ID +- `` with the application you want to install For additional script install options, see the [script options](#script-options). @@ -112,15 +115,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= } | iex; install ``` +Replace `` 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 +. { iwr -useb https://chefdownload-community.chef.io/install.ps1?license_id= } | iex; install -project ``` +Replace `` with your license ID. + For additional script install options, see the [script options](#script-options). ## Script options diff --git a/content/download/community.md b/content/download/community.md index 090a001843..28e6ee4d28 100644 --- a/content/download/community.md +++ b/content/download/community.md @@ -70,13 +70,13 @@ 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//packages +https://chefdownload-community.chef.io/stable//packages?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//packages?v= +https://chefdownload-community.chef.io/stable//packages?v=&license_id= ``` ### versions/all @@ -84,7 +84,7 @@ https://chefdownload-community.chef.io/stable//packages?v=/versions/all +https://chefdownload-community.chef.io/stable//versions/all?license_id= ``` ### versions/latest @@ -92,7 +92,7 @@ https://chefdownload-community.chef.io/stable//versions/all Use `versions/latest` to return the latest version of a product. ```plain -https://chefdownload-community.chef.io/stable//versions/latest +https://chefdownload-community.chef.io/stable//versions/latest?license_id= ``` ### metadata @@ -100,7 +100,7 @@ https://chefdownload-community.chef.io/stable//versions/latest The `metadata` endpoint returns data about a particular package of a Chef product. ```plain -https://chefdownload-community.chef.io/stable//metadata?p=&pv=&m=&v= +https://chefdownload-community.chef.io/stable//metadata?p=&pv=&m=&v=&license_id= ``` ### download @@ -108,7 +108,7 @@ https://chefdownload-community.chef.io/stable//metadata?p=&pv The `download` endpoint downloads a particular package of a Chef product. ```plain -https://chefdownload-community.chef.io/stable//download?p=&pv=&m=&v= +https://chefdownload-community.chef.io/stable//download?p=&pv=&m=&v=&license_id= ``` ## Parameters @@ -120,6 +120,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. + `eol` : Whether to include EOL versions of a product or EOL products in the response. @@ -174,7 +179,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= ``` which will return something like: @@ -191,11 +196,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//download?p=&pv=&m=' +curl -LOJ 'https://chefdownload-community.chef.io/stable//download?p=&pv=&m=&license_id=' ``` To use GNU Wget to download a package directly, enter the following: ```bash -wget --content-disposition https://chefdownload-community.chef.io/stable//download?p=&pv=&m= +wget --content-disposition https://chefdownload-community.chef.io/stable//download?p=&pv=&m=&license_id= ``` From ac0c768f11a58573f60e98a9366743187487d0e9 Mon Sep 17 00:00:00 2001 From: rishabhjhs Date: Fri, 19 Dec 2025 12:53:30 +0530 Subject: [PATCH 2/5] Update docs with latest license info Signed-off-by: rishabhjhs --- content/download/commercial.md | 2 +- content/download/community.md | 2 +- 2 files changed, 2 insertions(+), 2 deletions(-) diff --git a/content/download/commercial.md b/content/download/commercial.md index 219c18a340..ff542b4734 100644 --- a/content/download/commercial.md +++ b/content/download/commercial.md @@ -132,7 +132,7 @@ The API accepts the following parameters in a query string. `license_id` : Your license ID. - A license is required to download packages and retrieve package metadata with this API. + A license is required to download packages and retrieve package metadata with this API. Only commercial and free licenses can be used for commercial downloads. `eol` : Whether to include EOL versions of a product or EOL products in the response. diff --git a/content/download/community.md b/content/download/community.md index 28e6ee4d28..8644d97c93 100644 --- a/content/download/community.md +++ b/content/download/community.md @@ -123,7 +123,7 @@ The API accepts the following parameters in a query string. `license_id` : Your license ID. - A license is required to download packages and retrieve package metadata with this API. + 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. From 03b1da66acc01e38295a0164b7ed887e8afc758c Mon Sep 17 00:00:00 2001 From: rishabhjhs Date: Fri, 19 Dec 2025 12:57:46 +0530 Subject: [PATCH 3/5] Update docs with latest license info Signed-off-by: rishabhjhs --- content/chef_install_script.md | 4 ++++ 1 file changed, 4 insertions(+) diff --git a/content/chef_install_script.md b/content/chef_install_script.md index bc74643a89..7d19ec2cab 100644 --- a/content/chef_install_script.md +++ b/content/chef_install_script.md @@ -85,6 +85,10 @@ 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. From 1618cd171fb7ad35cf2ee7a39badb7714d0258c0 Mon Sep 17 00:00:00 2001 From: rishabhjhs Date: Fri, 19 Dec 2025 13:15:24 +0530 Subject: [PATCH 4/5] Update docs with latest license info Signed-off-by: rishabhjhs --- content/download/commercial.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/content/download/commercial.md b/content/download/commercial.md index ff542b4734..f601fa7bf1 100644 --- a/content/download/commercial.md +++ b/content/download/commercial.md @@ -18,7 +18,7 @@ You can use an install script from the API to download and install Chef packages ## License -To download packages and review metadata with this API, you need a license ID. +To download packages and review metadata with this API, you need a license ID. Only commercial and free licenses can be used for commercial downloads. You can get your license ID from the [Chef Downloads portal](https://chef.io/downloads), or [contact Chef](https://www.chef.io/contact-us) if you don't have one. From 137324b1b78789312297d7f2d6ce1a9885dd2226 Mon Sep 17 00:00:00 2001 From: rishabhjhs Date: Fri, 19 Dec 2025 13:58:00 +0530 Subject: [PATCH 5/5] Update docs with latest license info Signed-off-by: rishabhjhs --- content/download/commercial.md | 4 ++-- content/download/community.md | 2 ++ 2 files changed, 4 insertions(+), 2 deletions(-) diff --git a/content/download/commercial.md b/content/download/commercial.md index f601fa7bf1..219c18a340 100644 --- a/content/download/commercial.md +++ b/content/download/commercial.md @@ -18,7 +18,7 @@ You can use an install script from the API to download and install Chef packages ## License -To download packages and review metadata with this API, you need a license ID. Only commercial and free licenses can be used for commercial downloads. +To download packages and review metadata with this API, you need a license ID. You can get your license ID from the [Chef Downloads portal](https://chef.io/downloads), or [contact Chef](https://www.chef.io/contact-us) if you don't have one. @@ -132,7 +132,7 @@ The API accepts the following parameters in a query string. `license_id` : Your license ID. - A license is required to download packages and retrieve package metadata with this API. Only commercial and free licenses can be used for commercial downloads. + A license is required to download packages and retrieve package metadata with this API. `eol` : Whether to include EOL versions of a product or EOL products in the response. diff --git a/content/download/community.md b/content/download/community.md index 8644d97c93..9f4b2e4349 100644 --- a/content/download/community.md +++ b/content/download/community.md @@ -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