Step 1: Review Your Packages

Step 2: Choose Your Integration Method

Step 3: Copy Your Script or Download Config

Option 1: Copy Script

Option 2: Download Config

Step 4: Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)

Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the packages and push them to a repository
  Download Packages

Option 2: Internalized Package (Reliable, Scalable)

Open Source
- Download the packages:
  Download Packages
- Follow manual internalization instructions
Package Internalizer (C4B)
- Run: (additional options)
- For package and dependencies run:
- Automate package internalization

Step 5: Copy Your Script

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:

If Applicable - Chocolatey Configuration/Installation


## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###

#### We initialize a few things that are needed by this script - there are no other requirements.
$ErrorActionPreference = "Stop"

#### Set TLS 1.2 (3072) as that is the minimum required by various up-to-date repositories.
#### Use integers because the enumeration value for TLS 1.2 won't exist
#### in .NET 4.0, even though they are addressable if .NET 4.5+ is
#### installed (.NET 4.5 is an in-place upgrade).
[System.Net.ServicePointManager]::SecurityProtocol = [System.Net.ServicePointManager]::SecurityProtocol -bor 3072

#### We use this variable for future REST calls.
$RequestArguments = @{
    UseBasicParsing = $true
}

## 2. TOP LEVEL VARIABLES ##

### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
$NugetRepositoryUrl = "INTERNAL REPO URL"

### b. Internal Repository Credential ###
#### If required, add the repository access credential here
# $NugetRepositoryCredential = [PSCredential]::new(
#     "username",
#     ("password" | ConvertTo-SecureString -AsPlainText -Force)
# )
# $RequestArguments.Credential = $NugetRepositoryCredential

### c. Chocolatey nupkg download url ###
#### This url should result in an immediate download when you navigate to it
$ChocolateyDownloadUrl = "$($NugetRepositoryUrl.TrimEnd('/'))/package/chocolatey.2.2.2.nupkg"

### d. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
# $ChocolateyCentralManagementUrl = "https://chocolatey-central-management:24020/ChocolateyManagementService"

#### ii. If using a Client Salt, add it here
# $ChocolateyCentralManagementClientSalt = "clientsalt"

#### iii. If using a Service Salt, add it here
# $ChocolateyCentralManagementServiceSalt = "servicesalt"

## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository

#### Download the Nupkg, appending .zip to the filename to handle archive cmdlet limitations
if (-not (Get-Command choco.exe -ErrorAction SilentlyContinue)) {
    $TempDirectory = Join-Path $env:Temp "chocolateyInstall"
    if (-not (Test-Path $TempDirectory -PathType Container)) {
        $null = New-Item -Path $TempDirectory -ItemType Directory
    }
    $DownloadedNupkg = Join-Path $TempDirectory "$(Split-Path $ChocolateyDownloadUrl -Leaf).zip"
    Invoke-WebRequest -Uri $ChocolateyDownloadUrl -OutFile $DownloadedNupkg @RequestArguments

    #### Extract the Nupkg, and run the chocolateyInstall script
    if (Get-Command Microsoft.PowerShell.Archive\Expand-Archive -ErrorAction SilentlyContinue) {
        Microsoft.PowerShell.Archive\Expand-Archive -Path $DownloadedNupkg -DestinationPath $TempDirectory -Force
    } else {
        # PowerShell versions <4.0 do not have this function available
        try {
            $shellApplication = New-Object -ComObject Shell.Application
            $zipPackage = $shellApplication.NameSpace($DownloadedNupkg)
            $destinationFolder = $shellApplication.NameSpace($TempDirectory)
            $destinationFolder.CopyHere($zipPackage.Items(), 0x10)
        } catch {
            Write-Warning "Unable to unzip package using built-in compression."
            throw $_
        }
    }

    & $(Join-Path $TempDirectory "tools\chocolateyInstall.ps1")
}

if (-not (Get-Command choco.exe -ErrorAction SilentlyContinue)) {
    refreshenv
}

## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations
# choco feature enable -n useFipsCompliantChecksums

### b. Apply Recommended Configuration ###
#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
choco config set --name cacheLocation --value C:\ProgramData\chocolatey\cache

#### Increase timeout to at least 4 hours
choco config set --name commandExecutionTimeoutSeconds --value 14400

#### Turn off download progress when running choco through integrations
choco feature disable --name showDownloadProgress

### c. Sources ###
#### Remove the default community package repository source
choco source list --limitoutput | ConvertFrom-Csv -Header 'Name', 'Location' -Delimiter '|' | ForEach-Object {
    if ($_.Location -eq 'https://community.chocolatey.org/api/v2/') {
        choco source remove -n $_.Name
    }
}

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here

#### NOTE: This EXAMPLE may require changes
if ($NugetRepositoryCredential) {
    choco source add --name ChocolateyInternal --source $NugetRepositoryUrl --user $NugetRepositoryCredential.UserName --password $NugetRepositoryCredential.GetNetworkCredential().Password --priority 1
} else {
    choco source add --name ChocolateyInternal --source $NugetRepositoryUrl --priority 1
}

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/
choco upgrade chocolatey --confirm

## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.

### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/how-tos/setup-offline-installation#exercise-4-create-a-package-for-the-license
choco install chocolatey-license --source $NugetRepositoryUrl --confirm

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
if ("chocolatey-license" -in (choco list --localonly --limitoutput | ConvertFrom-Csv -Header "Name" -Delimiter "|").Name) {
    choco source disable --name chocolatey.licensed
} else {
    Write-Warning "Not disabling 'chocolatey.licensed' feed, as Chocolatey-License has not been installed."
}

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
if ("chocolatey-license" -in (choco list --localonly --limitoutput | ConvertFrom-Csv -Header "Name" -Delimiter "|").Name) {
    choco install chocolatey.extension --source $NugetRepositoryUrl --confirm
} else {
    Write-Warning "Not installing 'chocolatey.extension', as Chocolatey-License has not been installed."
}

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
choco feature disable --name showNonElevatedWarnings
choco feature enable --name useBackgroundService
choco feature enable --name useBackgroundServiceWithNonAdministratorsOnly
choco feature enable --name allowBackgroundServiceUninstallsFromUserInstallsOnly
choco config set --name allowedBackgroundServiceCommands --value "install,upgrade,uninstall"

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
if ($ChocolateyCentralManagementUrl) {
    choco install chocolatey-agent --source $NugetRepositoryUrl --confirm
    choco config set --name CentralManagementServiceUrl --value $ChocolateyCentralManagementUrl
    if ($ChocolateyCentralManagementClientSalt) {
        choco config set --name centralManagementClientCommunicationSaltAdditivePassword --value $ChocolateyCentralManagementClientSalt
    }
    if ($ChocolateyCentralManagementServiceSalt) {
        choco config set --name centralManagementServiceCommunicationSaltAdditivePassword --value $ChocolateyCentralManagementServiceSalt
    }
    choco feature enable --name useChocolateyCentralManagement
    choco feature enable --name useChocolateyCentralManagementDeployments
}

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.

If Applicable - Chocolatey Configuration/Installation


## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###
#### i. chocolatey.chocolatey
##### You will require the chocolatey.chocolatey collection to be installed
##### on all machines using this playbook.
##### Please see https://github.com/chocolatey/chocolatey-ansible/#installing-the-collection-from-ansible-galaxy

- name: Install and Configure Chocolatey
  hosts: all

## 2. TOP LEVEL VARIABLES ##
  vars:

### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
    nuget_repository_url: INTERNAL REPO URL

### b. Internal Repository Credential ###
#### If required, add the repository access credential here and
#### uncomment lines with source_username and source_password below
#    nuget_repository_username: username
#    nuget_repository_password: password

### c. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
#    chocolatey_central_management_url: https://chocolatey-central-management:24020/ChocolateyManagementService

#### ii. If using a Client Salt, add it here
#    chocolatey_central_management_client_salt: clientsalt

#### iii. If using a Service Salt, add it here
#    chocolatey_central_management_service_salt: servicesalt

## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository

  tasks:
  - name: Install chocolatey
    win_chocolatey:
      name: chocolatey
      source: ""{{ nuget_repository_url }}""
      # source_username: ""{{ nuget_repository_username }}""
      # source_password: ""{{ nuget_repository_password }}""

## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations
#   - name: Enable FIPS compliance
#     win_chocolatey_feature:
#       name: useFipsCompliantChecksums
#       state: enabled

### b. Apply Recommended Configuration ###

#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
  - name: Set the cache location
    win_chocolatey_config:
      name: cacheLocation
      state: present
      value: C:\ProgramData\chocolatey\cache

#### Increase timeout to at least 4 hours
  - name: Set the command execution timeout
    win_chocolatey_config:
      name: commandExecutionTimeoutSeconds
      state: present
      value: 14400

#### Turn off download progress when running choco through integrations
  - name: Disable showing download progress
    win_chocolatey_feature:
      name: showDownloadProgress
      state: disabled

### c. Sources ###
#### Remove the default community package repository source
  - name: Remove Chocolatey Community Repository
    win_chocolatey_source:
      name: chocolatey
      state: absent

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here
#### NOTE: This EXAMPLE may require changes
  - name: Add Internal Repository
    win_chocolatey_source:
      name: ChocolateyInternal
      state: present
      source: {{ nuget_repository_url }}
      # source_username: {{ nuget_repository_username }}
      # source_password: {{ nuget_repository_password }}
      priority: 1

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/
  - name: Upgrade Chocolatey
    win_chocolatey:
      name: chocolatey
      state: latest

## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.
### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/how-tos/setup-offline-installation#exercise-4-create-a-package-for-the-license
  - name: Install Chocolatey License
    win_chocolatey:
      name: chocolatey-license
      source: ChocolateyInternal
      state: latest

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
  - name: Disable Chocolatey Community Repository
    win_chocolatey_source:
      name: chocolatey.licensed
      state: disabled

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
  - name: Install Chocolatey Extension
    win_chocolatey:
      name: chocolatey.extension
      source: ChocolateyInternal
      state: latest

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
  - name: Hide not-elevated warnings
    win_chocolatey_feature:
      name: showNonElevatedWarnings
      state: disabled

  - name: Use background mode for self-service
    win_chocolatey_feature:
      name: useBackgroundService
      state: enabled

  - name: Use background service for non-admins
    win_chocolatey_feature:
      name: useBackgroundServiceWithNonAdministratorsOnly
      state: enabled

  - name: Allow background uninstallation for user installs
    win_chocolatey_feature:
      name: allowBackgroundServiceUninstallsFromUserInstallsOnly
      state: enabled

  - name: Set allowed background service commands
    win_chocolatey_config:
      name: backgroundServiceAllowedCommands
      state: present
      value: install,upgrade,uninstall

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
  - name: Install Chocolatey Agent
    when: chocolatey_central_management_url is defined
    win_chocolatey:
      name: chocolatey-agent
      source: ChocolateyInternal
      state: latest

  - name: Set the Central Management Service URL
    when: chocolatey_central_management_url is defined
    win_chocolatey_config:
      name: CentralManagementServiceUrl
      state: present
      value: {{ chocolatey_central_management_url }}

  - name: Set the Central Management Client Salt
    when: chocolatey_central_management_client_salt is defined
    win_chocolatey_config:
      name: centralManagementClientCommunicationSaltAdditivePassword
      state: present
      value: {{ chocolatey_central_management_client_salt }}

  - name: Set the Central Management Service Salt
    when: chocolatey_central_management_service_salt is defined
    win_chocolatey_config:
      name: centralManagementServiceCommunicationSaltAdditivePassword
      state: present
      value: {{ chocolatey_central_management_service_salt }}

  - name: Use Central Management
    when: chocolatey_central_management_url is defined
    win_chocolatey_feature:
      name: useChocolateyCentralManagement
      state: enabled

  - name: Use Central Management Deployments
    when: chocolatey_central_management_url is defined
    win_chocolatey_feature:
      name: useChocolateyCentralManagementDeployments
      state: enabled

See docs at https://docs.chef.io/resource_chocolatey_package.html.

If Applicable - Chocolatey Configuration/Installation


## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###
#### The Chocolatey resources are available with any recent version of Chef.
#### We utilise the Chocolatey recipe to install the Chocolatey binaries.
include_recipe "chocolatey"

## 2. TOP LEVEL VARIABLES ##
### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
NugetRepositoryUrl = "INTERNAL REPO URL"

### b. Internal Repository Credential ###
#### If required, add the repository access credential here
# NugetRepositoryUsername = "username"
# NugetRepositoryPassword = "password"

### c. Chocolatey nupkg download url ###
#### This url should result in an immediate download when you navigate to it in
#### a web browser
ChocolateyNupkgUrl = "INTERNAL REPO URL/package/chocolatey.2.2.2.nupkg",

### d. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
# ChocolateyCentralManagementUrl = "https://chocolatey-central-management:24020/ChocolateyManagementService"

#### ii. If using a Client Salt, add it here
# ChocolateyCentralManagementClientSalt = "clientsalt"

#### iii. If using a Service Salt, add it here
# ChocolateyCentralManagementServiceSalt = "servicesalt"

## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository
node['chocolatey']['install vars'] = {
  'chocolateyDownloadUrl' => "#{ChocolateyNupkgUrl}",
}

## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations
# chocolatey_feature 'useFipsCompliantChecksums' do
#   action :enable
# end

### b. Apply Recommended Configuration ###

#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
chocolatey_config 'cacheLocation' do
  value 'C:\ProgramData\chocolatey\cache'
end

#### Increase timeout to at least 4 hours
chocolatey_config 'commandExecutionTimeoutSeconds' do
  value '14400'
end

#### Turn off download progress when running choco through integrations
chocolatey_feature 'showDownloadProgress' do
  action :disable
end

### c. Sources ###
#### Remove the default community package repository source
chocolatey_source 'chocolatey' do
  action :remove
end

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here

#### NOTE: This EXAMPLE may require changes
chocolatey_source 'ChocolateyInternal' do
  source "#{NugetRepositoryUrl}"
  priority 1
  action   :add
end

execute 'ChocolateyInternal' do
  command "choco source add --name ChocolateyInternal -s #{NugetRepositoryUrl} -u=#{NugetRepositoryUsername} -p=#{NugetRepositoryPassword} --priority=1"
  only_if { NugetRepositoryUsername != nil || NugetRepositoryPassword != nil }
end

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/
chocolatey_package 'chocolatey' do
  action :upgrade
  source "#{NugetRepositoryUrl}"
end

## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.

### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/how-tos/setup-offline-installation#exercise-4-create-a-package-for-the-license
chocolatey_package 'chocolatey-license' do
  action :install
  source "#{NugetRepositoryUrl}"
end

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
chocolatey_source 'chocolatey.licensed' do
  action            :disable
end

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
chocolatey_package 'chocolatey.extention' do
  action     install
  source     "#{NugetRepositoryUrl}"
end

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
chocolatey_feature 'showNonElevatedWarnings' do
  action :disable
end

chocolatey_feature 'useBackgroundService' do
  action :enable
end

chocolatey_feature 'useBackgroundServiceWithNonAdministratorsOnly' do
  action :enable
end

chocolatey_feature 'allowBackgroundServiceUninstallsFromUserInstallsOnly' do
  action :enable
end

chocolatey_config 'backgroundServiceAllowedCommands' do
  value 'install,upgrade,uninstall'
end

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
chocolatey_package 'chocolatey-agent' do
  action     install
  source     "#{NugetRepositoryUrl}"
  # user       "#{NugetRepositoryUsername}"
  # password   "#{NugetRepositoryPassword}"
  only_if { ChocolateyCentralManagementUrl != nil }
end

chocolatey_config 'CentralManagementServiceUrl' do
  value  "#{ChocolateyCentralManagementUrl}"
  only_if { ChocolateyCentralManagementUrl != nil }
end

chocolatey_config 'centralManagementClientCommunicationSaltAdditivePassword' do
  value   "#{ChocolateyCentralManagementClientSalt}"
  only_if { ChocolateyCentralManagementClientSalt != nil }
end

chocolatey_config 'centralManagementServiceCommunicationSaltAdditivePassword' do
  value   "#{ChocolateyCentralManagementServiceSalt}"
  only_if { ChocolateyCentralManagementServiceSalt != nil }
end

chocolatey_feature 'useChocolateyCentralManagement' do
  action :enable
  only_if { ChocolateyCentralManagementUrl != nil }
end

chocolatey_feature 'useChocolateyCentralManagementDeployments' do
  action :enable
  only_if { ChocolateyCentralManagementUrl != nil }
end

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.

If Applicable - Chocolatey Configuration/Installation


#requires -Modules cChoco
## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###
#### i. Requires chocolatey\cChoco DSC module to be installed on the machine compiling the DSC manifest
#### NOTE: This will need to be installed before running the DSC portion of this script
if (-not (Get-Module cChoco -ListAvailable)) {
    $null = Install-PackageProvider -Name NuGet -MinimumVersion 2.8.5.201 -Force
    if (($PSGallery = Get-PSRepository -Name PSGallery).InstallationPolicy -ne "Trusted") {
        Set-PSRepository -Name PSGallery -InstallationPolicy Trusted
    }
    Install-Module -Name cChoco
    if ($PSGallery.InstallationPolicy -ne "Trusted") {
        Set-PSRepository -Name PSGallery -InstallationPolicy $PSGallery.InstallationPolicy
    }
}

#### ii. Requires a hosted copy of the install.ps1 script
##### This should be available to download without authentication.
##### The original script can be found here: https://community.chocolatey.org/install.ps1

Configuration ChocolateyConfig {
## 2. TOP LEVEL VARIABLES ##
    param(
### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
        $NugetRepositoryUrl      = "INTERNAL REPO URL",

### b. Chocolatey nupkg download url ###
#### This url should result in an immediate download when you navigate to it in
#### a web browser
        $ChocolateyNupkgUrl      = "INTERNAL REPO URL/package/chocolatey.2.2.2.nupkg",

### c. Internal Repository Credential ###
#### If required, add the repository access credential here
#        $NugetRepositoryCredential = [PSCredential]::new(
#            "username",
#            ("password" | ConvertTo-SecureString -AsPlainText -Force)
#        ),

### d. Install.ps1 URL
#### The path to the hosted install script:
        $ChocolateyInstallPs1Url = "https://community.chocolatey.org/install.ps1"

### e. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
#        $ChocolateyCentralManagementUrl = "https://chocolatey-central-management:24020/ChocolateyManagementService",

#### ii. If using a Client Salt, add it here
#        $ChocolateyCentralManagementClientSalt = "clientsalt",

#### iii. If using a Service Salt, add it here
#        $ChocolateyCentralManagementServiceSalt = "servicesalt"
    )
    Import-DscResource -ModuleName PSDesiredStateConfiguration
    Import-DscResource -ModuleName cChoco

    Node 'localhost' {
## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository
        Environment chocoDownloadUrl {
            Name  = "chocolateyDownloadUrl"
            Value = $ChocolateyNupkgUrl
        }

        cChocoInstaller installChocolatey {
            DependsOn = "[Environment]chocoDownloadUrl"
            InstallDir = Join-Path $env:ProgramData "chocolatey"
            ChocoInstallScriptUrl = $ChocolateyInstallPs1Url
        }

## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations
#        cChocoFeature featureFipsCompliance {
#            FeatureName = "useFipsCompliantChecksums"
#        }

### b. Apply Recommended Configuration ###

#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
        cChocoConfig cacheLocation {
            DependsOn  = "[cChocoInstaller]installChocolatey"
            ConfigName = "cacheLocation"
            Value      = "C:\ProgramData\chocolatey\cache"
        }

#### Increase timeout to at least 4 hours
        cChocoConfig commandExecutionTimeoutSeconds {
            DependsOn  = "[cChocoInstaller]installChocolatey"
            ConfigName = "commandExecutionTimeoutSeconds"
            Value      = 14400
        }

#### Turn off download progress when running choco through integrations
        cChocoFeature showDownloadProgress {
            DependsOn   = "[cChocoInstaller]installChocolatey"
            FeatureName = "showDownloadProgress"
            Ensure      = "Absent"
        }

### c. Sources ###
#### Remove the default community package repository source
        cChocoSource removeCommunityRepository {
            DependsOn  = "[cChocoInstaller]installChocolatey"
            Name       = "chocolatey"
            Ensure     = "Absent"
        }

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here.
#### NOTE: This EXAMPLE may require changes
        cChocoSource addInternalSource {
            DependsOn  = "[cChocoInstaller]installChocolatey"
            Name        = "ChocolateyInternal"
            Source      = $NugetRepositoryUrl
            Credentials = $NugetRepositoryCredential
            Priority    = 1
        }

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/
        cChocoPackageInstaller updateChocolatey {
            DependsOn   = "[cChocoSource]addInternalSource", "[cChocoSource]removeCommunityRepository"
            Name        = "chocolatey"
            AutoUpgrade = $true
        }

## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.

### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/how-tos/setup-offline-installation#exercise-4-create-a-package-for-the-license
        cChocoPackageInstaller chocolateyLicense {
            DependsOn = "[cChocoPackageInstaller]updateChocolatey"
            Name      = "chocolatey-license"
        }

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
        Script disableLicensedSource {
            DependsOn  = "[cChocoPackageInstaller]chocolateyLicense"
            GetScript  = {
                $Source = choco source list --limitoutput | `
                    ConvertFrom-Csv -Delimiter '|' -Header Name, Source, Disabled | `
                    Where-Object Name -eq "chocolatey.licensed"

                return @{
                    Result = if ($Source) {
                        [bool]::Parse($Source.Disabled)
                    } else {
                        Write-Warning "Source 'chocolatey.licensed' was not present."
                        $true  # Source does not need disabling
                    }
                }
            }
            SetScript  = {
                $null = choco source disable --name "chocolatey.licensed"
            }
            TestScript = {
                $State = [ScriptBlock]::Create($GetScript).Invoke()
                return $State.Result
            }
        }

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
        cChocoPackageInstaller chocolateyLicensedExtension {
            DependsOn = "[Script]disableLicensedSource"
            Name      = "chocolatey.extension"
        }

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
        cChocoFeature hideElevatedWarnings {
            DependsOn   = "[cChocoPackageInstaller]chocolateyLicensedExtension"
            FeatureName = "showNonElevatedWarnings"
            Ensure      = "Absent"
        }

        cChocoFeature useBackgroundService {
            DependsOn   = "[cChocoPackageInstaller]chocolateyLicensedExtension"
            FeatureName = "useBackgroundService"
            Ensure      = "Present"
        }

        cChocoFeature useBackgroundServiceWithNonAdmins {
            DependsOn   = "[cChocoPackageInstaller]chocolateyLicensedExtension"
            FeatureName = "useBackgroundServiceWithNonAdministratorsOnly"
            Ensure      = "Present"
        }

        cChocoFeature useBackgroundServiceUninstallsForUserInstalls {
            DependsOn   = "[cChocoPackageInstaller]chocolateyLicensedExtension"
            FeatureName = "allowBackgroundServiceUninstallsFromUserInstallsOnly"
            Ensure      = "Present"
        }

        cChocoConfig allowedBackgroundServiceCommands {
            DependsOn   = "[cChocoFeature]useBackgroundService"
            ConfigName = "backgroundServiceAllowedCommands"
            Value       = "install,upgrade,uninstall"
        }

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
        if ($ChocolateyCentralManagementUrl) {
            cChocoPackageInstaller chocolateyAgent {
                DependsOn = "[cChocoPackageInstaller]chocolateyLicensedExtension"
                Name      = "chocolatey-agent"
            }

            cChocoConfig centralManagementServiceUrl {
                DependsOn   = "[cChocoPackageInstaller]chocolateyAgent"
                ConfigName = "CentralManagementServiceUrl"
                Value       = $ChocolateyCentralManagementUrl
            }

            if ($ChocolateyCentralManagementClientSalt) {
                cChocoConfig centralManagementClientSalt {
                    DependsOn  = "[cChocoPackageInstaller]chocolateyAgent"
                    ConfigName = "centralManagementClientCommunicationSaltAdditivePassword"
                    Value      = $ChocolateyCentralManagementClientSalt
                }
            }

            if ($ChocolateyCentralManagementServiceSalt) {
                cChocoConfig centralManagementServiceSalt {
                    DependsOn  = "[cChocoPackageInstaller]chocolateyAgent"
                    ConfigName = "centralManagementServiceCommunicationSaltAdditivePassword"
                    Value      = $ChocolateyCentralManagementServiceSalt
                }
            }

            cChocoFeature useCentralManagement {
                DependsOn   = "[cChocoPackageInstaller]chocolateyAgent"
                FeatureName = "useChocolateyCentralManagement"
                Ensure      = "Present"
            }

            cChocoFeature useCentralManagementDeployments {
                DependsOn   = "[cChocoPackageInstaller]chocolateyAgent"
                FeatureName = "useChocolateyCentralManagementDeployments"
                Ensure      = "Present"
            }
        }
    }
}

# If working this into an existing configuration with a good method for
$ConfigData = @{
    AllNodes = @(
        @{
            NodeName                    = "localhost"
            PSDscAllowPlainTextPassword = $true
        }
    )
}

try {
    Push-Location $env:Temp
    $Config = ChocolateyConfig -ConfigurationData $ConfigData
    Start-DscConfiguration -Path $Config.PSParentPath -Wait -Verbose -Force
} finally {
    Pop-Location
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.

If Applicable - Chocolatey Configuration/Installation


## 1. REQUIREMENTS ##
### Here are the requirements necessary to ensure this is successful.

### a. Internal/Private Cloud Repository Set Up ###
#### You'll need an internal/private cloud repository you can use. These are
####  generally really quick to set up and there are quite a few options.
####  Chocolatey Software recommends Nexus, Artifactory Pro, or ProGet as they
####  are repository servers and will give you the ability to manage multiple
####  repositories and types from one server installation.

### b. Download Chocolatey Package and Put on Internal Repository ###
#### You need to have downloaded the Chocolatey package as well.
####  Please see https://chocolatey.org/install#organization

### c. Other Requirements ###
#### i. Requires puppetlabs/chocolatey module
####  See https://forge.puppet.com/puppetlabs/chocolatey


## 2. TOP LEVEL VARIABLES ##
### a. Your internal repository url (the main one). ###
####  Should be similar to what you see when you browse
#### to https://community.chocolatey.org/api/v2/
$_repository_url = 'INTERNAL REPO URL'

### b. Chocolatey nupkg download url ###
#### This url should result in an immediate download when you navigate to it in
#### a web browser
$_choco_download_url = 'INTERNAL REPO URL/package/chocolatey.2.2.2.nupkg'

### c. Chocolatey Central Management (CCM) ###
#### If using CCM to manage Chocolatey, add the following:
#### i. Endpoint URL for CCM
# $_chocolatey_central_management_url = 'https://chocolatey-central-management:24020/ChocolateyManagementService'

#### ii. If using a Client Salt, add it here
# $_chocolatey_central_management_client_salt = "clientsalt"

#### iii. If using a Service Salt, add it here
# $_chocolatey_central_management_service_salt = 'servicesalt'


## 3. ENSURE CHOCOLATEY IS INSTALLED ##
### Ensure Chocolatey is installed from your internal repository
### Note: `chocolatey_download_url is completely different than normal
###  source locations. This is directly to the bare download url for the
###  chocolatey.nupkg, similar to what you see when you browse to
###  https://community.chocolatey.org/api/v2/package/chocolatey
class {'chocolatey':
  chocolatey_download_url => $_choco_download_url,
  use_7zip                => false,
}


## 4. CONFIGURE CHOCOLATEY BASELINE ##
### a. FIPS Feature ###
#### If you need FIPS compliance - make this the first thing you configure
#### before you do any additional configuration or package installations

#chocolateyfeature {'useFipsCompliantChecksums':
#  ensure => enabled,
#}

### b. Apply Recommended Configuration ###

#### Move cache location so Chocolatey is very deterministic about
#### cleaning up temporary data and the location is secured to admins
chocolateyconfig {'cacheLocation':
  value => 'C:\ProgramData\chocolatey\cache',
}

#### Increase timeout to at least 4 hours
chocolateyconfig {'commandExecutionTimeoutSeconds':
  value => '14400',
}

#### Turn off download progress when running choco through integrations
chocolateyfeature {'showDownloadProgress':
  ensure => disabled,
}

### c. Sources ###
#### Remove the default community package repository source
chocolateysource {'chocolatey':
  ensure   => absent,
  location => 'https://community.chocolatey.org/api/v2/',
}

#### Add internal default sources
#### You could have multiple sources here, so we will provide an example
#### of one using the remote repo variable here

#### NOTE: This EXAMPLE requires changes
chocolateysource {'internal_chocolatey':
  ensure             => present,
  location           => $_repository_url,
  priority           => 1,
  username           => 'optional',
  password           => 'optional,not ensured',
  bypass_proxy       => true,
  admin_only         => false,
  allow_self_service => false,
}

### b. Keep Chocolatey Up To Date ###
#### Keep chocolatey up to date based on your internal source
#### You control the upgrades based on when you push an updated version
####  to your internal repository.
#### Note the source here is to the OData feed, similar to what you see
####  when you browse to https://community.chocolatey.org/api/v2/

package {'chocolatey':
  ensure   => latest,
  provider => chocolatey,
  source   => $_repository_url,
}


## 5. ENSURE CHOCOLATEY FOR BUSINESS ##
### If you don't have Chocolatey for Business (C4B), you'll want to remove from here down.

### a. Ensure The License File Is Installed ###
#### Create a license package using script from https://docs.chocolatey.org/en-us/guides/organizations/organizational-deployment-guide#exercise-4-create-a-package-for-the-license

# TODO: Add resource for installing/ensuring the chocolatey-license package
package {'chocolatey-license':
  ensure   => latest,
  provider => chocolatey,
  source   => $_repository_url,
}

### b. Disable The Licensed Source ###
#### The licensed source cannot be removed, so it must be disabled.
#### This must occur after the license has been set by the license package.
## Disabled sources still need all other attributes until
## https://tickets.puppetlabs.com/browse/MODULES-4449 is resolved.
## Password is necessary with user, but not ensurable, so it should not
## matter what it is set to here. If you ever do get into trouble here,
## the password is your license GUID.
chocolateysource {'chocolatey.licensed':
  ensure   => disabled,
  priority => '10',
  user     => 'customer',
  password => '1234',
  require  => Package['chocolatey-license'],
}

### c. Ensure Chocolatey Licensed Extension ###
#### You will have downloaded the licensed extension to your internal repository
#### as you have disabled the licensed repository in step 5b.

#### Ensure the chocolatey.extension package (aka Chocolatey Licensed Extension)
package {'chocolatey.extension':
  ensure   => latest,
  provider => chocolatey,
  source   => $_repository_url,
  require  => Package['chocolatey-license'],
}

#### The Chocolatey Licensed Extension unlocks all of the following, which also have configuration/feature items available with them. You may want to visit the feature pages to see what you might want to also enable:
#### - Package Builder - https://docs.chocolatey.org/en-us/features/paid/package-builder
#### - Package Internalizer - https://docs.chocolatey.org/en-us/features/paid/package-internalizer
#### - Package Synchronization (3 components) - https://docs.chocolatey.org/en-us/features/paid/package-synchronization
#### - Package Reducer - https://docs.chocolatey.org/en-us/features/paid/package-reducer
#### - Package Audit - https://docs.chocolatey.org/en-us/features/paid/package-audit
#### - Package Throttle - https://docs.chocolatey.org/en-us/features/paid/package-throttle
#### - CDN Cache Access - https://docs.chocolatey.org/en-us/features/paid/private-cdn
#### - Branding - https://docs.chocolatey.org/en-us/features/paid/branding
#### - Self-Service Anywhere (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/self-service-anywhere
#### - Chocolatey Central Management (more components will need to be installed and additional configuration will need to be set) - https://docs.chocolatey.org/en-us/features/paid/chocolatey-central-management
#### - Other - https://docs.chocolatey.org/en-us/features/paid/

### d. Ensure Self-Service Anywhere ###
#### If you have desktop clients where users are not administrators, you may
#### to take advantage of deploying and configuring Self-Service anywhere
chocolateyfeature {'showNonElevatedWarnings':
  ensure => disabled,
}

chocolateyfeature {'useBackgroundService':
  ensure => enabled,
}

chocolateyfeature {'useBackgroundServiceWithNonAdministratorsOnly':
  ensure => enabled,
}

chocolateyfeature {'allowBackgroundServiceUninstallsFromUserInstallsOnly':
  ensure => enabled,
}

chocolateyconfig {'backgroundServiceAllowedCommands':
  value => 'install,upgrade,uninstall',
}

### e. Ensure Chocolatey Central Management ###
#### If you want to manage and report on endpoints, you can set up and configure
### Central Management. There are multiple portions to manage, so you'll see
### a section on agents here along with notes on how to configure the server
### side components.
if $_chocolatey_central_management_url {
  package {'chocolatey-agent':
    ensure   => latest,
    provider => chocolatey,
    source   => $_repository_url,
    require  => Package['chocolatey-license'],
  }

  chocolateyconfig {'CentralManagementServiceUrl':
    value   => $_chocolatey_central_management_url,
  }

  if $_chocolatey_central_management_client_salt {
    chocolateyconfig {'centralManagementClientCommunicationSaltAdditivePassword':
      value => $_chocolatey_central_management_client_salt,
    }
  }

  if $_chocolatey_central_management_service_salt {
    chocolateyconfig {'centralManagementClientCommunicationSaltAdditivePassword':
      value => $_chocolatey_central_management_client_salt,
    }
  }

  chocolateyfeature {'useChocolateyCentralManagement':
    ensure  => enabled,
    require => Package['chocolatey-agent'],
  }

  chocolateyfeature {'useChocolateyCentralManagementDeployments':
    ensure  => enabled,
    require => Package['chocolatey-agent'],
  }
}

Need Help? View our docs or file an issue.

There is already a version of this package in your Script Builder

Current Version	New Version

Downloads:

2,643

Downloads of v 1.4.553:

121

Last Update:

03 Apr 2024

Package Maintainer(s):

cderv

Software Author(s):

Posit Software
PBC

Tags:

quarto markdown publishing latex pdf revealjs html cross-plateform cli

Quarto

1.4.553 | Updated: 03 Apr 2024

Downloads:

2,643

Downloads of v 1.4.553:

121

Maintainer(s):

cderv

Software Author(s):

Posit Software
PBC

Tags:

quarto markdown publishing latex pdf revealjs html cross-plateform cli

Quarto 1.4.553

Some Checks Have Failed or Are Not Yet Complete

Not All Tests Have Passed

Hide Checks

Validation Testing Passed

Verification Testing Passed

Details

Scan Testing Resulted in Flagged as a Note:

At least one file within this package has greater than 0 detections, but less than 5

Details

Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

To install Quarto, run the following command from the command line or from PowerShell:

To upgrade Quarto, run the following command from the command line or from PowerShell:

To uninstall Quarto, run the following command from the command line or from PowerShell:

NOTE

This applies to both open source and commercial editions of Chocolatey.

1. Enter Your Internal Repository Url

(this should look similar to https://community.chocolatey.org/api/v2/)

2. Setup Your Environment

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

2. Get the package into your environment

Option 1: Cached Package (Unreliable, Requires Internet - Same As Community)

Open Source or Commercial:
- Proxy Repository - Create a proxy nuget repository on Nexus, Artifactory Pro, or a proxy Chocolatey repository on ProGet. Point your upstream to https://community.chocolatey.org/api/v2/. Packages cache on first access automatically. Make sure your choco clients are using your proxy repository as a source and NOT the default community repository. See source command for more information.
- You can also just download the package and push it to a repository Download

Option 2: Internalized Package (Reliable, Scalable)

Open Source
- Download the package:
  Download
- Follow manual internalization instructions

Package Internalizer (C4B)

Run: (additional options)

choco download quarto --internalize --source=https://community.chocolatey.org/api/v2/

For package and dependencies run:

choco push --source="'INTERNAL REPO URL'"

Automate package internalization

3. Copy Your Script

choco upgrade quarto -y --source="'INTERNAL REPO URL'" [other options]

See options you can pass to upgrade.

See best practices for scripting.

Add this to a PowerShell script or use a Batch script with tools and in places where you are calling directly to Chocolatey. If you are integrating, keep in mind enhanced exit codes.

If you do use a PowerShell script, use the following to ensure bad exit codes are shown as failures:


choco upgrade quarto -y --source="'INTERNAL REPO URL'" 
$exitCode = $LASTEXITCODE

Write-Verbose "Exit code was $exitCode"
$validExitCodes = @(0, 1605, 1614, 1641, 3010)
if ($validExitCodes -contains $exitCode) {
  Exit 0
}

Exit $exitCode


- name: Install quarto
  win_chocolatey:
    name: quarto
    version: '1.4.553'
    source: INTERNAL REPO URL
    state: present

See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.


chocolatey_package 'quarto' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '1.4.553'
end

See docs at https://docs.chef.io/resource_chocolatey_package.html.


cChocoPackageInstaller quarto
{
    Name     = "quarto"
    Version  = "1.4.553"
    Source   = "INTERNAL REPO URL"
}

Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.


package { 'quarto':
  ensure   => '1.4.553',
  provider => 'chocolatey',
  source   => 'INTERNAL REPO URL',
}

Requires Puppet Chocolatey Provider module. See docs at https://forge.puppet.com/puppetlabs/chocolatey.

4. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

Package Approved

This package was approved as a trusted package on 03 Apr 2024.

Description

Features of Quarto:

Create dynamic content with Python, R, Julia, and Observable.
Author documents as plain text markdown or Jupyter notebooks.
Publish high-quality articles, reports, presentations, websites, blogs, and books in HTML, PDF, MS Word, ePub, and more.
Author with scientific markdown, including equations, citations, crossrefs, figure panels, callouts, advanced layout, and more.

Files

legal\LICENSE.md


From: https://quarto.org/license.html

Quarto is open source software licensed under the [GNU GPL v2](https://www.gnu.org/licenses/old-licenses/gpl-2.0.en.html). We believe that it's better for everyone if the tools used for research and science are free and open. Reproducibility, widespread sharing of knowledge and techniques, and the leveling of the playing field by eliminating cost barriers are but a few of the shared benefits of free software in science.

The Quarto source code is available at <https://github.com/quarto-dev/>

Quarto is a registered trademark of Posit. Please see our [trademark policy](trademark.qmd) for guidelines on usage of the Quarto trademark.

Quarto also makes use of several other open-source projects, the distribution of which is subject to their respective licenses. Major components and their licenses include:

| Project                                                       | License                                                            |
|---------------------------------------------------------------|--------------------------------------------------------------------|
| [Pandoc](https://pandoc.org/)                                 | [GNU GPL v2](https://github.com/jgm/pandoc/blob/master/COPYING.md) |
| [Bootstrap 5.1](https://getbootstrap.com/docs/5.1/)           | [MIT](https://github.com/twbs/bootstrap/blob/v5.1.3/LICENSE)       |
| [Bootswatch 5.1](https://bootswatch.com/)                     | [MIT](https://github.com/thomaspark/bootswatch/blob/v5/LICENSE)    |
| [Deno](https://deno.land/)                                    | [MIT](https://github.com/denoland/deno/blob/main/LICENSE.md)       |
| [esbuild](https://esbuild.github.io/)                         | [MIT](https://github.com/evanw/esbuild/blob/master/LICENSE.md)     |
| [Dart Sass](https://sass-lang.com/dart-sass)                  | [MIT](https://github.com/sass/dart-sass/blob/main/LICENSE)         |
| [Observable Runtime](https://github.com/observablehq/runtime) | [ISC](https://github.com/observablehq/runtime/blob/main/LICENSE)   |

legal\VERIFICATION.txt

VERIFICATION
Verification is intended to assist the Chocolatey moderators and community
in verifying that this package's contents are trustworthy.

This chocolatey package is maintained directly by Quarto authors <https://quarto.org/about.html>

Verification can be done this this way: 

- Downloaded bundle: https://github.com/quarto-dev/quarto-cli/releases/download/v1.4.553/quarto-1.4.553-win.zip

- Use 'Get-FileHash' to check the checksum: 14176fd7f687470309d96b5b317648e52f3f2d40be7ff656f331da5a6af0f408

tools\chocolateyinstall.ps1


$ErrorActionPreference = 'Stop';
$toolsDir   = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"

$packageArgs = @{
  packageName   = $env:ChocolateyPackageName
  FileFullPath  = gi $toolsDir\quarto*win.zip
  Destination   = $toolsDir
}

Get-ChocolateyUnzip @packageArgs
rm $toolsDir\*.zip -ea 0

$files = get-childitem (Join-Path $toolsDir "bin/tools" ) -include *.exe -recurse
foreach ($file in $files) {
    New-Item "$file.ignore" -type file -force | Out-Null
}

tools\quarto-1.4.553-win.zip

md5: 9F99108DB1D2461E5D696DC7E1B3F60E | sha1: B8620F7F834AAE97757F90B470847D6BD01C9F91 | sha256: 14176FD7F687470309D96B5B317648E52F3F2D40BE7FF656F331DA5A6AF0F408 | sha512: AF684CC472E3DFC967B4B59C6EA525B80025C8209142C479D9DFA7B5690CF0E17F3D97533D7E0E22325796037D624974F47ADC3A4EAEBF2346519CFFD9404E71

Virus Scan Results

plugin.dll (8d182dd5339d) - ## / 70
typst.exe (3e533897d145) - ## / 70
pandoc.exe (0f22e6cecb8f) - ## / 66
deno.exe (b958630a0cc2) - ## / 70
esbuild.exe (1e9e30176dd3) - ## / 72
dart.exe (fedde407dad7) - ## / 68
quarto.1.4.553.nupkg (de78dd147d39) - ## / 64
quarto-1.4.553-win.zip (14176fd7f687) - ## / 60
quarto.exe (ec9a497dc14a) - ## / 71

In cases where actual malware is found, the packages are subject to removal. Software sometimes has false positives. Moderators do not necessarily validate the safety of the underlying software, only that a package retrieves software from the official distribution point and/or validate embedded software against official distribution point (where distribution rights allow redistribution).

Chocolatey Pro provides runtime protection from possible malware.

Version History

Version	Downloads	Last Updated	Status
Quarto 1.4.553	121	Wednesday, April 3, 2024	Approved
Quarto 1.4.552	83	Tuesday, March 26, 2024	Approved
Quarto 1.4.551	145	Wednesday, March 6, 2024	Approved
Quarto 1.4.550	133	Thursday, February 15, 2024	Approved
Quarto 1.4.549	145	Wednesday, January 24, 2024	Approved
Quarto 1.3.450	625	Tuesday, August 15, 2023	Approved
Quarto 1.3.433	174	Monday, June 26, 2023	Approved
Quarto 1.3.427	58	Friday, June 23, 2023	Approved
Quarto 1.3.361	148	Tuesday, May 30, 2023	Approved
Quarto 1.3.354	69	Friday, May 26, 2023	Approved
Quarto 1.3.353	109	Friday, May 12, 2023	Approved
Quarto 1.3.340	120	Tuesday, April 25, 2023	Approved
Quarto 1.2.475	121	Wednesday, March 22, 2023	Approved
Quarto 1.2.335	141	Wednesday, February 8, 2023	Approved
Quarto 1.2.269	220	Tuesday, November 15, 2022	Approved
Quarto 1.1.189	82	Monday, September 12, 2022	Approved
Quarto 1.0.38	95	Tuesday, August 16, 2022	Approved
Quarto 1.0.35	54	Wednesday, July 20, 2022	Approved

Posit Software, PBC 2020-2023

Release Notes

Fixed in this release

(#8439): ensure that lack of subject line is handled
(#9076): Fix rendering of code cells with layout-ncol and column settings in html format.
(#9200): Fix regression with tbl-colwidths outside of a cross-referenceable table element.

Fixed in previous releases

(#8749): Fix bundle creation for publishing Quarto projects to Posit Connect using quarto publish connect.
(#8785): Fix issue with noncentered, non-referenceable subfigures in LaTeX format.
(#8795): Fix issue with select controls appearing in Dashboard toolbar.
(#8798): Fix issue with duplicate level 1 headings in rendered ipynb notebooks.
(#8818): Fix alignment of right items in Navbars.
(#8852): Do not strip index.html from external links.
(#8854): Don't allow margin footnotes to break hover-citations
(#8858): Fix issue rendering markdown in bread-crumbs
(#8843): Fix issue in books when some R code cells emits LaTeX dependencies to be included in the LaTeX preamble.
(#8857): Fix issue with format: dashboard using Plotly in Jupyter on Windows.
(#8937): Fix unix quarto launcher in the case of paths with spaces.
(#8417): Maintain a single AST element in the output cell when parsing HTML from RawBlock
(#8490): Properly embed qmd cells even when they include an explicit echo declaration.
(#8464): Fix a regression where shortcodes were not being expanded recursively.
(#8485): Fix a regression where shortcodes could not Unicode characters with code points above 127.
(#8507): Fix a regression with callout rendering in docx.
(#8510): Fix a regression on undocumented behavior with sidebar.align instead of sidebar.alignment in YAML configuration.
(#8514): Fix a regression where crossreferences in number-sections: false documents were being rendered incorrectly.
(#8536): Fix a regression with column specifiers in html.
(#8552): Fix incorrect behavior reading title from code cells in Dashboards.
(#8555): Fix malformed HTML when outputing page navigation (books and websites).
(#8566): Fix issues with usage of iTables in Quarto Dashboards. This includes layout issues for large or wide tables, appearance of sticky headers, as well as a hang that can occur when rendering a Dashboard using iTables 1.7.
(#8567): Improve website search performance for large sites with long search terms.
(#8586): Fix regression on rendering multiple embedded citations in LaTeX tables.
(#8603): Fix a regression with multiple-column layouts and code-folding.
(#8630): Fix a regression with latex crossref identifiers with underscores. Note that this syntax is not officially supported in Quarto, but this change reverts to the behavior in 1.3.
(#8652): Make code cell detection in IDE tooling consistent across editor modes.
(#8662): Do not incorrectly prevent previewing docusaurus websites without an index file.
(#8697): Ensure that lightboxed figures with margin captions properly position the caption.
(#8708): Resolve complex layouts in ipynbs embeds for manuscripts.
(#8728): Don't crash with empty floats in LaTeX format.
(#8733): Fix regression with image-align=right in LaTeX format.
(#8741): Fix issue where the MacOS installer would incorrectly report that Rosetta is required (it is not).

Languages

Add Serbian-Latin translation (author: @n_grubor)
Add Slovak translation (author: @tom67)
Improve Italian translation of 'proof' (author: @espinielli)
Add Greek translation (author: @cultab)
Add Norwegian translation (author: @lektorodd)
Add Lithuanian translation (author: @GegznaV)
Add Traditional Chinese (Taiwan) translation (author: @bobby1030)
Update Catalan translation (author: @jmaspons)

Dependencies

Update to Pandoc 3.1.11
Update to Typst 0.10.0

Breaking Changes

In website projects, a single sidebar with a id property will no longer be used as a global sidebar. It will instead be used as a sidebar for only pages which specify that id or pages linked to from the sidebar.

HTML Format

Add support for showing cross reference contents on hover (use crossrefs-hover: false to disable).
Add support for displaying keywords in HTML page title block, when present.
(#3473): Add support for body-right and body-left layouts for Website Table of Contents.
(#3895): Other format links can appear on the left (ensure that they follow the toc-location whether or not a toc is visible).
(#4840): Add support for specifying a custom Hypothesis client url using client-url
(#4882): Add support for canonical-url, which when provided will include a link tag with rel='canonical' which will use an explictly provided or automatically generated canonical url for the document.
(#5189): Ensure appendix shows even when page-layout is custom.
(#5196): Properly support title-prefix for HTML output
(#5210): Update to Bootstrap 5.2.2
(#5393): Properly set color of headings without using opacity.
(#5403): Fix accessibility issues with the kbd shortcode.
(#5431): Properly apply column positioning to title metadata.
(#5516): Ensure that images which appear in the margin are properly marked as fluid.
(#5663): Properly forward column grid position to sub grids with margin elements.
(#5700): Don't show scrollbars on Windows when hovering over hover code annotations.
(#5708): Fix hang when viewing pages with specific query parameter
(#5789): Correct appearance of languageless code cells in some contexts
(#5794): Fix incorrect caching behavior when import is used in scss themes.
(#5798): Improve the layout consistency of HTML callouts.
(#5856): Always render the title block of HTML pages (previously would only render when title or subtitle was provided).
(#5929): Split border-bottom properties to avoid invalid inherit entry in resulting CSS.
(#5955): Correct HTML callout appearance when title isn't present.
(#5957): Fix layout issues when margin footnotes are contained in headings or other formatted text.
(#6004): Improve appearance of Cross Talk controls in Quarto HTML documents
(#6163): Wrap svg output of dot cells in RawBlock html elements.
(#6430): Fix layout issue with banner style title block authors when page-layout: full
(#6627): Add a bit of margin-right to checkbox inputs.
(#6693): Fine tune table appearance to improve consistency
(#6714): Display title block for HTML when other (non-title/author/subtitle) metadata is present.
(#6833): Handle partially-specified aspect ratio, width, and height attributes in video shortcode.
(#6910): Properly forward code-summary as a global HTML option
(#7024): Ensure HTML documents can render properly even when installed Quarto files aren't writable
(#7137): Automatically set rel="noopener" when setting a target on external links
(#7183): Mark asides that appear in the margin with a margin-aside class
(#7187): Add html-table-processing: none to document- and project-level metadata to disable HTML table processing. Add {html-table-processing="none"} to a fenced div to disable HTML table processing for the elements in that div. Add html-table-processing: none on knitr or jupyter cell to disable HTML table processing for the cell output content.
(#7441): Links in hover box (e.g. links to DOI when hover for citations is opt-in) are now correctly process for external and new window processing (when link-external-icon: true and link-external-newwindow: true).
(#7542): Title block will properly present author affiliations when there is a mix of authors with affiliations and authors without affiliations
Ensure that code annotation buttons are not selectable text.
(#7364): Restore support for layout-align attribute in panels
(#8032): Fix layout issue when margin footnotes are contained on a list item inside a callout.
(#7153): Fix layout issue when margin footnotes are contained in a blockquote.

Appendix

(#6783): Add additional CC licenses, improve link text
(#5685): Provide consistent ids for appendix sections

RevealJS Format

(#1943): Allow setting code-block-height in presentation front matter.
(#3671): Remove untitled slides from the table of contents.
(#5210): Update to Bootstrap 5.2.2
(#5546): Images inside links can't be stretched, and so auto-stretch feature now ignores them.
(#5783): Ensure fenced code blocks work with line numbers.
(#6120): pdf-max-pages-per-slide is now correctly setting pdfMaxPagesPerSlide config for RevealJS.
(#6800): Move automatically-added content (slide footers, etc) to top-level of DOM when last slide is hidden, to avoid inadvertently removing it.
(#6827): Correctly layout callout in revealjs slides when changing appearance.
(#6853, #5208): Wrap callout in div when attr is non-empty.
(#7042): Line highligthting now works correctly with code annotation.
(#7104): Line highlighting progressive reveal now correctly has code annotation anchor on the right.
(#7366): smaller: true now applies correctly on nested slides.
(#7394): Fix issue with mermaid diagrams in revealjs slides when output-location: fragment.
(#4988): targets for links on numbered code lines are removed, as revealjs doesn't support them because navigation is done by slide only.
(#4156): footer and slide number text on slide with dark background have now an adapted text muted color based on $dark-bg-text-color.
(#7134): .nostrech can now be applied on image directly to opt-out Revealjs' image stretching when auto-stretch: true (the default).

PDF Format

(#4370): Hoist code cells deep in the AST out of layout cells to avoid \raisebox issues with the Shaded environment.
(#5078): Ensure format-resources are copied before PDF rendering when latex-auto-mk is false
(#5058): Add a before-title.tex partial to the PDF format. This partial will appear in the document premable just before the title block, allowing further customization of the document preamble. By default, this partial is empty.
(#5969): Correctly detect a required rerun for biblatex when using backref link options.
(#5690): Improve validation of pdf-engine
(#6077): Make sure proof environments are tight around contents.
(#6907): Fix issue with footnote mark line processor not triggering.
(#6990): Fix an issue where underscore in filename code cell attribute were not escaped.
(#7175): Fix an issue with code annotations when more than one digit is used for annotation number.
(#7267): Fix issue with longtable environments interfering with the table counter.
(#7434): Support resource-path when resolving images in PDF
(#7534): Fix issue with multiple paragraph footnotes when using reference-location: margin.
(#7568): Code annotation now works in LaTeX document when having other comments on same line.
(#6716): Fix marginpar error when placing citations in the margin

Docusaurus Format

(#5152): Support for code-line-numbers: true in Docusaurus output.
(#6046): Fix citation regression in Docusaurus output.
(#6310): Support Docusaurus 3.0 by rendering to .mdx by default.
(#7201): Support for line highlighting using code-line-numbers, as raw block attributes or code cell options.

Beamer Format

(#3650): Use classoption=notheorems to not conflict with Quarto's own theorem environments.
(#5536): Correctly support Code Filename feature for Beamer output by fixing issue with float environment.
(#6041): Correctly support code block appearance options (code-block-bg and code-block-border-left).
(#6226): Correctly detect the need for an additional compilation for TOC layout when using lualatex
(#6956): Add support number-section to format: beamer to control whether sections are numbered.

Asciidoc Format

(#6589): Don't crash when format: asciidoc with a missing title.
(#7632): Render citations properly inside callouts

Confluence Format

(#5151): Provide an informational message about attachment delays when publishing.
(#7256): No undesired newline are created anymore in Callouts.

Website Listings

(#3933): Don't emit base Quarto CSS or theme highlighting CSS when minimal is selected.
(#4800): Add support for including an xml-stylesheet in listings. Use the xml-stylesheet: example.xsl under feed: to provide a path to an XSL style sheet to style your RSS feed.
(#5371): Properly compute the trimmed length of descriptions included in listings.
(#5463): Error if the contents of a listing match no items.
(#5742): Use any element to compute a description for the listing, even when there are no paragraphs.
(#5802): Don't display the string undefined for date values if a listing table displays items without a date.
(#5805): Update the inherited word-break: break-word style (Bootstrap) to word-break: keep-all to prevent hyphenation of words in listings.
(#6029): Only use the image-placeholder for a listing if no other image is available.
(#6091): Don't use remote / absolutes images when auto-discovering images.
(#6268): Enable listings even when theme: none
(#6407): Add supporting for the field word-count for listing items. It is not displayed by default.
(#6408): Fix error on Windows when using yaml to create a listing with an external (e.g. path: https://www.quarto.org)
(#6447): Fix image placholder for pages with more than one listing (or a single listing passed as an array item in yaml)
(#6777): Add support for complex fields like citation.container-title when includes custom fields in listings.
(#6903): Don't display the path field for external paths provided in metadata files.
(#6904): Within feeds, remove index.html from urls which shouldn't include it.
(#7088): Don't emit extraneous link or whitespace in default listing template.
(#7184): Properly use the boostrap variable pagination-active-color for coloring pagination controls.
(#7634): Use an explicit width to ensure default listing layout doesn't grow outside its desired boundss
(#7345): Improve display of categories in a table style listing
(#7699): Properly ignore non-HTML output for listings when project level renders render HTML and other formats (for example, a book of both HTML and PDF format)
(#7290): Add support for feed:type of metadata, which will use only explicitly provided description metadata when generating an RSS feed. Additionally, note that partial feed types will prefer to use an explicit description over the first paragraph, when a description is available.
Add support for programmatically filtering content from a listing using include or exclude with glob syntax to include or exclude specific items from the listing. See <https://github.com/quarto-dev/quarto-cli/commit/d415d9ca5b7cb59a8a4750dd3eeb60116b931bd6s>
(#8197): Custom field-types are now correctly merged with default values for website listings.

Websites

Add support for navbar > toggle-position to control whether the responsive navbar toggle appears on the right or the left.
Add support for setting page-navigation: true|false in either a page or in _metadata.yml. This allows individual pages or sections of a website to control whether page-navigaation appears.
Add support for bread-crumbs: true|false to control whether bread crumbs are displayed. Add support for display of breadcrumbs on full width (non-mobile) pages when bread-crumbs is true. Default value is true.
Add support for show-item-context key within the search key to control whether page parents are display next to items in search results. Pass tree, parent, root, or boolean (if you pass true, tree is the default).
(#3493): Fix issue with website about pages complaining about missing citation when using an @ in hrefs.
(#4668): Allow per page metadata (front matter or a _metadata.yml file) to overide the repo-url for a page by providing a repo-url
(#4739): Improve handling of reader mode at mobile responsive sizes
(#5204): About pages rely upon TOC being positioned right, so force that to be true
(#5212): Ensure navbar search button respects collapse-below and remains aligned properly
(#5251): Allow individual pages to specify image: false to prevent image discover for Twitter and Open Graph metadata.
(#5283): Add support for setting repo-actions: false in a document to prevent the display of repository actions on a specific page.
(#5389): Allow a website project to provide a default image used in social metadata tags.
(#5503): Fix issue with markdown rendering of href text converting dashes to en/em dashes.
(#5604): Process footer content as blocks.
(#5624): Add support for localized Cookie Consent (using either the document's language or by specifying the language explicitly under the cookie consent key).
(#5625): Prefer the website image (if specified) over undecorated images that appear in the page.
(#5689): Don't use a single sidebar with an id as a global sidebar (the id explicitly means that the sidbar will match pages specifying that id or pages which the sidebar contains).
(#5756): Add rel="..." resolution to navbar tools.
(#5763): Add support for a keyboard shortcut to launch search (defaults to f or /). Use search > keyboard-shortcut to override with your own key(s).
(#5818): Ensure that repo-actions for websites (and books) appear responsively in the footer if the TOC isn't visible.
(#5932): Correct Open Graph metadata key name for og:site_name
(#5964): Add support for repo-link-target and repo-link-rel to control the corresponding attributes of repo-action links.
(#6432): Don't decorate navigation tools with external link icon (we generally don't decorate navigation chrome in this way)
(#6703): Warn users when a theme key in a document is being ignored.
(#6704): Use the correct title when there are duplicate sidebar href targets
(#6708): Prevent duplication of footnotes within the abstract or description within websites and books.
(#6732): Allow specifying global alt text for social metadata
(#7447): Changing the $primary color in a SCSS theme will now properly change the navigation bar background color.
(#7754): Use the site title as the html title for a page if no other title is available.
(#8083): Improve About Page layouts when a sidebar is present
(#8150): Correctly support sidebar alignment. Default sidebar text alignment to left.
(#8166): Properly discover 'image' property as a resource when using a project path.

Website Search

(#4531): Section cross references are now properly searchable
(#7105): Improve search results by raising default limit and fixing and removing warning that would appear for Algolia when limit was more than 20.
(#7150): Search keyboard shortcut will not intercept keys directed at inputs.
(#7117): Ensure that search works properly in mobile layouts when not scrolled to top of page (don't close search when scroll occurs because of keyboard being shown).
(#7796): Allow providing placeholder text using the language key search-text-placeholder

Books

(#5454): Fix errors previewing with formats such as asciidoc are added to book projects.
(#5630): Properly form sharing URL for books
(#6708): Prevent duplication of footnotes within the abstract or description within websites and books.
(#7206): Properly enabled issue-url for books
(#8011): Improve support for unsectioned chapters in search.
(#8145): Support localization of book tools (Download, Share, Source Code)

Publishing

(#5436): Add support for publishing to Posit Cloud.
(#5220): Properly respect output-dir when publishin individual files in a default Quarto project
(#4498): Better error when quarto publish gh-pages fails because gh-pages branch does not exist on origin remote.

Video (and Audio)

(#5496, #5847, #5268): Properly display local audio and video files with website projects (properly discover the src as a resource)

Preview

Display render output/progress for previews that take longer than 2 seconds
Ability to cancel an executing preview from within the progress UI
Automatically render missing formats (e.g. PDF, MS Word) on the fly
Correct detection of Hugo project type from hugo.toml (in addition to already supported config.toml)
Only re-use Jupyter kernels for languages that explicitly opt into it
(#4801): Provide a more specific error upon a directory preview of a default project type without a root index file
(#5882): Disable browser cache using Cache-Control header config in the viewer redirect for PDF preview, correctly allowing a HTML preview later on same port.

Jupyter

Support for executing inline expressions (e.g. `{python} x`)
Improved detection/exclusion of spurious matplotlib plain text output
Correctly exclude id fields when converting Colab notebooks to qmd.
More thorough cleaning out of text artifacts created by matplotlib intermediate statements.
Added ipynb-shell-interactivity option (enables specification of IPython InteractiveShell.ast_node_interactivity option)
Only search for Julia conda installation when the engine language is Julia
Support for plotly-connected option to determine where Plotly is embedded or loaded from CDN
Reduce default margins for Plotly figures (t=30,r=0,b=0,l=0)
Restart kernel daemon when non-package Python modules change
(#5051): Don't emit strong tag with trailing spaces to not confuse Jupyter MD reader.
(#6344): Somewhat improve the error message in case of YAML parsing errors in metadata of Python code cells.
(#6367): Fix bug with nested code cells in the generation of Jupyter notebook from .qmd files.
(#6393): Search JULIA_HOME for Julia-specific Python installations.
(#7016): Ignore directories for which we don't have permissions when searching for unactivated environments.
(#7302): Avoid name collisions when embedding output from multiple notebooks in a Quarto document
(#7512): Improved error message listing known kernels, when a kernel set with jupyter key in YAML is not found.
(#7548): Don't use fig_format="png" in Julia's CairoMakie because of interaction with display()
(#7607): Make output: asis behave the same way as the knitr engine, emitting div enclosures when necessary.
(#5363): Fix issue caused by Quarto incorrectly using some headings as a title when reading notebooks.
(#6411): Don't perform notebook title fixup if the project is providing a title.

Knitr

(#4735): Special verbatim and embed language engine for knitr's chunk are now better supported, including with special quarto cell option like echo: fenced.
(#5506): Fix error in if-statement when knitr::asis_output(x) is used with length(x) != 1 (author: @rcannood).
(#6775): Avoid duplicating special internal tools:quarto R environment used for making ojs_define() accessible during knitting.
(#6792): fig-asp provided at YAML config level now correctly work to set fig.asp chunk option in knitr.
(#7002): layout-valign is correctly forwarded to HTML to tweak vertical figure layout alignment for computational figures.
(#5994): Options like include or echo for ojs or mermaid cells are now correctly handled with knitr engine.
(#4869): sql cell output has now correct Quarto treatment so that specific features like column: margin works.
(#7600): output: asis now correctly don't emit .cell-output-display div around cell outputs of class knit_asis.
(#7877): crop: false chunk options allows to opt out (per chunk or globally) automatic cropping in PDF when pdfcrop and ghostscript are detected. This complements knitr's way crop: null.
(#7943): Internal Quarto R function should not leak to user's global environment.
(#7029): Fix issue with some encoding while reading configuration in R.

OJS engine

Update observablehq's runtime to version 5.6.0.
(#4927): Add support for code-summary option in OJS code cells.
(#5215): Report CORS requests as plain text when serving single-file previews.
(#6267): Fix error message when running in file://.
(#7537): Code annotations works better with OJS cells.
(#7747): Fix FileAttachment path resolution to work with revealjs format (and more generally, URLs that have a non-empty hash).
(#8071): Add support to hugo-md as an output format.

Mermaid diagrams

Upgrade to 10.2.0-rc.2
(#5426): Don't escape mermaid output in markdown formats (author: @rcannood).

Code Annotations

(#5339): Improve behavior of code annotations when present on scrollable slides
(#6016): Ensure that annotations are on the correct line in Safari
(#6385): Add support for code annotation in fenced code cells
(#7056): Only make content of the hover annotation scrollable if it necessary
(#7435): Use # as a fallback comment character for unknown languages
Add support for OCaml code annotations

Author and Affiliations

Add support for specifying author roles, with optional support for degree of contribution and automatic normalization of CreDiT roles, when applicable.
Improved support for affiliation metadata, including ringgold, isni, ror
Add support for funding, including support for simple strings or funding including source, recipient, and investigator. source and recipient may
-be one or more simple strings, refs to an author or affiliation id, or an object following the institution schema.
(#5764): Add support for affiliations to include a group property to represent the team or research group within the affiliation
(#6068): Properly display author names in default commonmark and gfm output
(#6138): Add support for degrees to specify academic titles or professional certifications displayed following a personal name (for example, "MD", "PhD").
(#6139): For markdown output that will not include yaml front matter, still perform author normalization. When yaml_metadata_block is enabled (or for pandoc markdown) do not normalize author front matter since that will result in extraneous author keys.

Lua filters

Add support for relative paths in require() calls.
Add support quarto.doc.add_resource and quarto.doc.add_supporting. add_resource will add a resource file to the current render, copying that file to the same relative location in the output directory. add_supporting will add a supporting file to the current render, moving that file file to the same relative location in the output directory.
(#5242): Add line numbers to error messages.
(#5461): ensure return type of stripTrailingSpace is always pandoc.List.
(#5466): Provide global environment _G to user filters.
(#6211): Improve error message when a JSON filter (or a potentially misspelled Lua filter from an extension) is not found.
(#6215): Add quarto.utils.string_to_inlines and quarto.utils.string_to_blocks to Lua API to convert a string to a list of inlines or blocks taking into account quarto's AST structure.
(#6289): allow markdownToInlines to take empty string.
(#6935): Add isGithubMarkdownOutput() to quarto.format API.
(#6935): render callouts to gfm using GitHub's syntax.
(#7067): Add new entry points to user Lua filters. See <https://quarto.org/docs/prerelease/1.4/lua_changes.html>.
(#7083): Separate custom node handlers for Span and Div nodes, enabling conditional content spans (author: @knuesel)

Debian Installer

(#3785): Recommend installation of unzip, which is used when installed extensions.
(#5167): Don't fail installation if symlink cannot be created in path.

Citable Articles

(#6766): Add id as valid CSL property when specifying a documents citation metadata.

Crossrefs

(#2551): Support crossreferenceable figures without captions.
(#6620): Introduce FloatRefTarget AST nodes that generalize crossref targets to include figures, tables, and custom floating elements.
(#7200): Support Unicode in subref labels.

Input format

(#7905): Use html+raw_html as input format when processing HTML rawblocks for tables to avoid Pandoc converting SVG elements to images.

Extensions

When installing an extension, offer to open documentation explaining usage.
(#4889): Improve error message when attempting to create a duplicate extension
(#6759): Properly support format extensions controlling the order of filters that they use
(#7375): Updating extensions will now remove files that are not present in newer versions of an extension.
(#7886): Better support installation of extensions and usage of templates from repos which have been renamed.
(#7909): Properly resolve filter extensions even when a directory of the same name exists.

Other Fixes and Improvements

Exit if project pre or post render script fails
Support --output-dir for rendering individual files.
Use InternalError in typescript code, and offer a more helpful error message when an internal error happens.
(#1173): Allow specifying margin caption location on a per cell basis
(#1237): Allow include shortcodes to be resolved from inside non-executable code cells and metadata blocks.
(#1392): Add tools and LaTeX information to quarto check output.
(#2214, reopened): don't report a non-existing version of Google Chrome in macOS.
(#3599, #5870): Fix hash issue causing unexpected render when freeze is activated on Windows but re-rendered on Linux (e.g. in Github Action).
(#4614): Correctly remove empty mediabag directory in remote drives.
(#4673): Quarto now report in check and error message if rmarkdown R package minimal requirement (>= 2.3) is not fullfilled, and it will ask to update the package.
(#4820): Add support for setting the Giscus light/dark themes.
(#5377): support from: formats correctly.
(#5421): Correct quarto --help command to provide correct commands and descriptions
(#5444): Introduce a build command make-installer-dir to better support third party packaging without dependencies. Fine tuning of code/patch provided in https://github.com/conda-forge/quarto-feedstock/pull/7.
(#5748): Don't cleanup shared lib_dir files when using embed-resources within a project
(#5755): Allow document metadata to control conditional content.
(#5785): Don't process juptyer notebook markdown into metadata when embedding notebooks into documents.
(#5902): Support paired shortcode syntax.
(#6013): Don't error if citation is passed as a boolean value in metadata via flags
(#6042): Correctly support empty lines in YAML blocks.
(#6142): Properly respect DENO_DIR when set
(#6154): quarto check knitr does not fail anymore when user's .Rprofile contains cat() calls.
(#6178): When QUARTO_LOG_LEVEL=DEBUG, information about search for a R binary will be shown.
(#6207): When QUARTO_R is set to a non-existing path, a warning is now thrown like with QUARTO_PYTHON. Quarto still fallback to search a working R version.
(#6244): Code annotation now works for executable code cells using echo: fenced. Also it now supports HTML and Markdown code cells.
(#6269): Fix issue with YAML validation where the annotated value was incorrectly built.
(#6487): Fix serviceworkers check in htmlDependency to look at the correct key.
(#6568): Trim file extension in data URI that might have been inadvertently added by Pandoc.
(#6620): Rewrite Crossreferenceable figure support. See the prerelease documentation for more information.
(#6697): Fix issue with outputing to stdout (quarto render <file> -o -) on Windows.
(#6705): Fix issue with gfm output being removed when rendered with other formats.
(#6746): Let stdout and stderr finish independently to avoid deadlock.
(#6807): Improve sourcemapping reference cleanup in generated CSS files.
(#6825): Show filename when YAML parsing error occurs.
(#6836): Fix missing docx format for abstract key in reference schema.
(#7013): Improve error message when there is an issue finding or running R and add more verbosity in verbose mode.
(#7032): quarto is now correctly working when installed in a folder with spaces in path.
(#7131): Fix typo in ISBN entry for JATS subarticle template (author: @jasonaris).
(#7252): Improve handling with tlmgr of some mismatched LaTeX support files, associated with expl3.sty loading.
(#7502): Correct execute-debug help text
(#7674): Configure font paths for TinyTeX after installation so that xetex can find custom fonts correctly.
(#7675): On Windows, quarto install tinytex will install TinyTeX to the directory defined by the environment variable ProgramData when APPDATA is not a suitable location for TeX Live.
(#8086): Add support for indexing array metadata in meta shortcode.
(#8245): On Windows, prevent Quarto error due to access issue when trying to read codepage from registry.

Dependencies

This package has no dependencies.

Discussion for the Quarto Package

Ground Rules:

This discussion is only about Quarto and the Quarto package. If you have feedback for Chocolatey, please contact the Google Group.
This discussion will carry over multiple versions. If you have a comment about a particular version, please note that in your comments.
The maintainers of this Chocolatey Package will be notified about new comments that are posted to this Disqus thread, however, it is NOT a guarantee that you will get a response. If you do not hear back from the maintainers after posting a message below, please follow up by using the link on the left side of this page or follow this link to contact maintainers. If you still hear nothing back, please follow the package triage process.
Tell us what you love about the package or Quarto, or tell us what needs improvement.
Share your experiences with the package, or extra configuration or gotchas that you've found.
If you use a url, the comment will be flagged for moderation until you've been whitelisted. Disqus moderated comments are approved on a weekly schedule if not sooner. It could take between 1-5 days for your comment to show up.

Resources

Events

Courses

2,643

121

03 Apr 2024

Quarto

Quarto 1.4.553

Some Checks Have Failed or Are Not Yet Complete

Deployment Method: Individual Install, Upgrade, & Uninstall

Deployment Method:

1. Enter Your Internal Repository Url

2. Setup Your Environment

1. Ensure you are set for organizational deployment

2. Get the package into your environment

3. Copy Your Script

4. If applicable - Chocolatey configuration/installation

Fixed in this release

Fixed in previous releases

Languages

Dependencies

Breaking Changes

HTML Format

Appendix

RevealJS Format

PDF Format

Docusaurus Format

Beamer Format

Asciidoc Format

Confluence Format

Website Listings

Websites

Website Search

Books

Publishing

Video (and Audio)

Preview

Jupyter

Knitr

OJS engine

Mermaid diagrams

Code Annotations

Author and Affiliations

Lua filters

Debian Installer

Citable Articles

Crossrefs

Input format

Extensions

Other Fixes and Improvements

Ground Rules: