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.3.0.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.3.0.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.3.0.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.3.0.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:

5,878

Downloads of v 2.01:

3,182

Last Update:

28 Jun 2019

Package Maintainer(s):

dtgm
xoviat

Software Author(s):

NirSoft

Tags:

file-explorer extensions disable manager

ShellExView

2.01 | Updated: 28 Jun 2019

Downloads:

5,878

Downloads of v 2.01:

3,182

Maintainer(s):

dtgm
xoviat

Software Author(s):

NirSoft

Tags:

file-explorer extensions disable manager

ShellExView 2.01

Legal Disclaimer: Neither this package nor Chocolatey Software, Inc. are affiliated with or endorsed by NirSoft. The inclusion of NirSoft trademark(s), if any, upon this webpage is solely to identify NirSoft goods or services and not for commercial purposes.

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:

This package was submitted (and approved) prior to automated virus scanning integration into the package moderation processs.

We recommend clicking the "Details" link to make your own decision on installing this package.

Details

Learn More

Deployment Method: Individual Install, Upgrade, & Uninstall

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

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

To uninstall ShellExView, 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 shexview --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 shexview -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 shexview -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 shexview
  win_chocolatey:
    name: shexview
    version: '2.01'
    source: INTERNAL REPO URL
    state: present

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


chocolatey_package 'shexview' do
  action    :install
  source   'INTERNAL REPO URL'
  version  '2.01'
end

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


cChocoPackageInstaller shexview
{
    Name     = "shexview"
    Version  = "2.01"
    Source   = "INTERNAL REPO URL"
}

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


package { 'shexview':
  ensure   => '2.01',
  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 by moderator Pauby on 09 Jul 2019.

Description

Shell Extensions are in-process COM objects which extend the abilities of Windows operating system. Most shell extensions are automatically installed by the operating system, but there are also many other applications that install additional shell extension components. For example, if you install WinZip on your computer, you'll see a special WinZip menu when you right-click on a Zip file. This menu is created by adding a shell extension to the system.
The ShellExView utility displays the details of shell extensions installed on your computer, and allows you to easily disable and enable each shell extension.

Files

tools\install\readme.txt




ShellExView v2.01
Copyright (c) 2003 - 2019 Nir Sofer
Web Site: http://www.nirsoft.net



Description
===========

Shell Extensions are in-process COM objects which extend the abilities of
Windows operating system. Most shell extensions are automatically
installed by the operating system, but there are also many other
applications that install additional shell extension components. For
example: If you install WinZip on your computer, you'll see a special
WinZip menu when you right-click on a Zip file. This menu is created by
adding a shell extension to the system.

The ShellExView utility displays the details of shell extensions
installed on your computer, and allows you to easily disable and enable
each shell extension.

ShellExView can be used for solving context-menu problems in Explorer
environment. For more information, read the following article:
Right-click is slow or weird behavior caused by context menu handlers



System Requirements
===================

This utility works on any version of Windows, starting from Windows 98
and up to Windows 10. x64 versions of Windows are also supported.

Versions History
================




10/06/2019
2.01

* Fixed bug: ShellExView crashed on some systems.


07/03/2019
2.00

* Fixed to detect properly the filename of .NET extensions.


30/08/2015
1.97

* Fixed the 'Restart Explorer' option to work properly on Windows 10.


07/08/2015
1.96

* Fixed bug: When the 'Hide All Microsoft Extensions' option was turned
  on, ShellExView didn't display it as checked.
* Fixed bug: ShellExView failed to detect some shell extensions.


02/07/2015
1.95

* Added 'Hide All Microsoft Extensions' option.
* Added 'Missing File' column (Displays 'Yes' if the shell extension
  file is missing).


26/05/2014
1.90

* Added 'Thumbnail Handler' and 'Preview Handler' shell extensions that
  ShellExView failed to locate in previous versions.


05/09/2013
1.86

* Fixed bug: ShellExView failed to extract the digital signatures on
  some systems.


19/08/2013
1.85

* Fixed issue: Microsoft shell extensions displayed as non-Microsoft if
  the company name was 'Microsoft Corp.'
* Added 'Digital Signature' column, which displays the signer name if
  the shell extension dll is signed with a digital signature. This column
  is active only when 'Read Digital Signatures' option (Under the Options
  menu) is turned on. (by default it's turned off)
* Added 'Auto Size Columns+Headers' option.


13/06/2013
1.81

* Added secondary sorting: When clicking the column headers of 'Type',
  'Company', and other columns , the list is sorted by the selected
  column first, and then by the 'Extension Name' column.


31/05/2013
1.80

* Added 'Show 32-bit Shell Extensions' option, under the Options menu,
  available only on 64-bit systems. When it's turned on, ShellExView
  loads the 32-bit instance of installed shell extensions. (Similar to
  the /wow64 command-line option)


25/09/2012
1.76

* Fixed issue: The properties window opened in the wrong monitor, on
  multi-monitors system.


09/09/2012
1.75

* Added 'Restart Explorer' (Ctrl+E) option, under the Options menu,
  which allows you to easily restart Windows Explorer if the
  disabling/enabling a shell extension doesn't affect Explorer
  immediately (Very useful for Windows 7/2008/Vista).


19/03/2012
1.70

* Added 'Put Icon On Tray' option.


24/10/2011
1.68

* Added shell extensions under LibraryFolder\Background key.


03/10/2011
1.67

* You can now drag one or more files from the window of ShellExView
  into Explorer window or other application.


18/05/2011
1.66

* Added 'Show Time In GMT' option.


10/03/2011
1.65

* Added support for 3 types of shell extensions: Disk Cleanup Handlers,
  Icon Overlay Handlers, and Property Handlers


26/02/2011
1.60

* Added /enable and /disable command-line options, which allow you to
  disable/enable shell extensions automatically from command-line without
  displaying any user interface, by specifying the CLSID of the shell
  extension.


14/02/2011
1.55

* Fixed bug: ShellExView failed to detect some shell extensions (When
  the CLSID was specified as Registry key instead of Registry value).
* Added .NET detection - When there is a .NET extension, ShellExView
  now detect the real shell extension dll instead of displaying the .NET
  core dll (mscoree.dll)
* Added .NET column, which displays 'Yes' if the shell extension was
  created in .NET


21/11/2010
1.50

* Added 'Google Search - Filename' and 'Google Search - Extension Name'
  options, which allows you to easily search for information about the
  selected shell extension in Google.


20/09/2010
1.48

* Added 'Add Header Line To CSV/Tab-Delimited File' option. When this
  option is turned on, the column names are added as the first line when
  you export to csv or tab-delimited file.


18/05/2010
1.47

* Fixed ShellExView x64 to require to run as admin under Windows
  7/Vista, like the 32-bit version.


03/05/2010
1.46

* Added 'Preview Handler' shell extensions.


07/11/2009
1.45

* On x64 systems, ShellExView now always shows the shell extensions for
  x64 applications, even on the 32-bit version of ShellExView. If you
  want to get the shell extensions list for 32-bit applications, use
  ShellExView with /wow64 command-line option.
* Added /remote command-line option, which allows you to
  view/enable/disable shell extensions in a remote computer on your
  network.


29/08/2009
1.41

* Changed the definition of 'Suspicious Shell Extensions' - In previous
  versions, Every shell extension with read-only attribute marked as
  Suspicious, which confused some users, because there are many
  legitimated shell extensions that set a read-only attribute, probably
  to protect them from delete by the user. However, if a shell extension
  has an hidden attribute, it'll still be marked as suspicious.


22/08/2009
1.40

* Added option to submit a report about a shell extension that you
  disabled to http://shellfix.nirsoft.net.


05/04/2009
1.37

* ShellExView now displays a special warning when trying to disable a
  shell extension of shell32.dll


07/01/2009
1.36

* Fixed bug: ShellExView crashed when using it with the save
  command-line options.


24/11/2008
1.35

* Added support for using ShellExView with external drive (by using
  /external command-line option).


10/11/2008
1.30

* Added 'Filter By Extension Type' option - Allows you to select which
  type of shell extensions you want to view.


24/10/2008
1.25

* New restriction: ShellExView won't allow you to disable at once more
  than 15 shell extensions created by Microsoft. The reason for this
  restriction is that recently there were a few cases of people that
  disabled most of their shell extensions, including system extensions
  that installed as a part of the operating system, and then found
  themselves with a system that cannot boot properly.


02/10/2008
1.24

* Fixed bug: Exception window appeared when starting ShellExView in
  some systems.


08/07/2008
1.23

* Fixed bug: The dates displayed in system locale format, instead of
  user locale.


14/05/2008
1.22

* Added shell extensions under "My Network Places", "Entire Network",
  and "Remote Computer" Registry keys.
* Added 3 columns: "My Network Places", "Entire Network", and "Remote
  Computer" (which tells you whether the Shell Extension was added into
  these folders)


03/05/2008
1.21

* Fixed bug: The main window lost the focus when the user switched to
  another application and then returned back to ShellExView.


24/04/2008
1.20

* Added support for saving as comma-delimited text file


22/11/2007
1.19

* Under Vista, ShellExView now requires to run as administrator.


21/09/2007
1.18

* Configuration of ShellExView is now saved to a cfg file instead of
  the Registry.


04/08/2007
1.17

* Added support for properly enabling/disabling shell extensions under
  Windows Vista. (The disabled shell extensions are added to
  'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Shell
  Extensions\Blocked' key in the Registry)
* Added x64 version (as a separated download) for using under Windows
  Vista x64.
* Added shell extensions under SystemFileAssociations key.


16/02/2007
1.16

* Fixed bug: When a filename was enclosed with quotes, ShellExView
  failed to display the properties of the file.


12/08/2006
1.15

* A tooltip is displayed when a string in a column is longer than the
  column length.


30/12/2005
1.14

* Added shell extensions under HKEY_CLASSES_ROOT\Directory\Background


15/07/2005
1.13

* New columns: File Attributes and File Size.
* New option: Mark Suspicious Shell Extensions - mark in red color
  shell extensions with unusual file attribues (hidden attribue) or with
  unusual file extensions.


21/06/2005
1.12

* New shell extension types: InfoTip Handler, Shell Link, Structure
  Storage, MetaData.
* Multiple shell extensions with the same CLSID are now displayed in
  separated entries.
* Added support for Windows XP style.


27/02/2005
1.11

* New shell extension type: URL Search Hook.
* Open the CLSID key of the shell extension in RegEdit.
* New column: File Extensions.


25/11/2004
1.10

* New columns: File Created Time, CLSID Modified Time, Microsoft.
* New extensions types: Browser Helper Object, IE Toolbar, Explorer
  Bar, IE Extensions.
* Choose columns dialog-box.
* Auto-Size columns.
* Find dialog-box.
* HTML Reports.
* Save as XML file.
* Mark disabled items in gray color.
* Mark non-Microsoft extensions in pink color.
* Ability to translate to other languages.


23/08/2003
1.01
Critical bug from previous version (1.00) was fixed: In some
circumstances, after disabling a shell extension and then enabling it
again, the shell extension continued to be disabled, even if ShellExView
show that it's enabled.

05/06/2003
1.00
First Release.


License
=======

This utility is released as freeware. You are allowed to freely
distribute this utility via floppy disk, CD-ROM, Internet, or in any
other way, as long as you don't charge anything for this. If you
distribute this utility, you must include all files in the distribution
package, without any modification !



Disclaimer
==========

The software is provided "AS IS" without any warranty, either expressed
or implied, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose. The author will not
be liable for any special, incidental, consequential or indirect damages
due to loss of data or any other reason.



Using ShellExView
=================

The ShellExView is a standalone executable. It doesn't require any
installation process or additional DLLs. Just copy it to any folder you
want, and run it. After you run it, wait a few seconds until ShellExView
loads all shell extensions items.
The main window of ShellExView displays the details of all shell
extensions in 12 different columns:



Extension Name
The name of the shell extension, as it appears in the Registry.

Disabled
Tells you whether the shell extension is disabled.

Type
The type of the shell extension. There are more than 10 different types
of shell extensions. For more information about the types of shell
extensions, see the table below.

Description
Description of the shell extension item. This information is extracted
from the DLL file that contains this shell extension.

Version
Version of the shell extension item. This information is extracted from
the DLL file that contains this shell extension.

Product Name
The name of the product that created this shell extension. This
information is extracted from the DLL file that contains this shell
extension.

Company
The name of the company that created this shell extension.

My Computer
Tells you whether the "My Computer" folder contains this shell extension.
This column is only relevant to "Shell Folder" extensions.

Desktop
Tells you whether the "Desktop" folder contains this shell extension.
This column is only relevant to "Shell Folder" extensions.

Control Panel
Tells you whether the "Control Panel" folder contains this shell
extension. This column is only relevant to "Shell Folder" extensions
under Windows 2000/XP.

Filename
The filename that contains this shell extension.

CLSID
The CLSID of this shell extension.

File Created Time
The creation time of the extension dll. You can use this field in order
to find out when the extension was installed on your system.

CLSID Modified Time
The Modified Time of CLSID in the Registry. Only available under Windows
NT/2000/XP.

Microsoft
Specifies whether the extension was created by Microsoft ('Yes' value) or
by other company ('No' value).

File Extensions
Specifies a list of file extensions (like .txt, .html) that use this
shell extension.

File Attributes
Specifies the attributes of the shell extension file. (H for hidden, R
for read-only, and so on)

File Size
Specifies the size (in bytes) of the shell extension file.

There are more than 10 types of shell extension, here's a small
description for each type:


Shell Folder
Provides special system folders like "Printers", "Fonts", "Recycle Bin",
and more...

Context Menu
Provides the ability to add new items to the context menu of particular
file type.

Drag & Drop Handler
Provides the ability to add new items to the context menu that appears
when you drag a file with right mouse button.

Icon Handler
Provides the ability to dynamically assign icons to file objects.

Copy Hook Handler
This type of shell extension is called when a file is moved, copies,
renamed or deleted.

Drop Handler
Provides the ability to control the "Drop" behavior of files.

Data Handler
Provides the ability to copy files/objects to the clipboard.

Property Sheet
Property Sheet dialog boxes.

Search Handler
Provides the ability to create a system search engine (Like the standard
"Search For Files or Folders" module)

Column Handler
Provides the ability to add new columns to the details view of Explorer
window.

Thumbnail
Provides the ability to display images in "Thumbnail" view.

Browser Helper Object
Provides the ability to customize and control the Internet Explorer
browser.

IE Toolbar
Provides the ability to add new toolbars into Internet Explorer (like
Yahoo! Toolbar)

Explorer Bar
Provides the ability to add Explorer bars to Internet Explorer.

URL Search Hook
Browser extension stored under Software\Microsoft\Internet
Explorer\URLSearchHooks.

System
All other types of shell extensions that ShellExView utility cannot
recognize are categorized as "System" type.



Disable/Enable Shell Extensions
===============================

The ShellExView utility allows you to disable and enable the shell
extensions components on your system. In order to disable or enable a
shell extension item, select the desired item, and from the File menu (or
from the pop-up menu) select the appropriate option - "Enable Selected
Items" or "Disable Selected Items".
Here's 2 examples of useful things that you can do with this feature:

* Context Menu: Some applications, like WinZip, CuteFTP, and others,
  add some items to the context menu when you right-click on a file in
  explorer window. If you disable the appropriate shell extension, you
  won't get these additional menu items.
  In order to locate the desired shell extension item:
  1. Sort the extensions list by the "Type" column and look at all
     "Context Menu" items.
  2. Search the application that creates the menu you want to
     disable. The icon near each item can help to locate the desired
     shell extension.

* Shell Folder: When you enter into some special folders like "History"
  and "Temporary Internet Files", you don't see the real file system, but
  the a virtual folder that the shell extension create for you. If you
  want to watch the real file system inside "History" or "Temporary
  Internet Files", you can disable the appropriate shell extension items.



Sending report to shellfix.nirsoft.net
======================================

If you solved a problem by disabling a shell extension in your Explorer,
and you want to share it with others, you can use the 'Send Report To
ShellFix' option to publish the information in
http://shellfix.nirsoft.net. You can find full instructions about how to
send a report in the main page of http://shellfix.nirsoft.net Web site.



Add/Remove special folders to "My Computer" and "Desktop" folders
=================================================================

Some special shell folders like "Printers", "Recycle Bin", "Scheduled
Tasks", "Network and Dial-up Connections", "Mobile Device", and others
can be added (and be removed) to "My Computer", "Desktop", and even to
"Control Panel" (Only in Windows 2000) by using the ShellExView utility.
For Example: Under Windows 2000, you can add the "Printers", "Recycle
Bin", and "Scheduled Tasks" folders to "My Computer". In order to do
that, select the item that you want to add or remove (You can only use
"Shell Folder" items) and from the File menu, select the appropriate
add/remove option.
Be aware that there are some shell folders that cannot be added to "My
Computer" or "Desktop" folders. For example: adding the "Administrative
Tools" folder to "My Computer" won't work properly as you might expect.



Mark Suspicious Shell Extensions
================================

Most shell extensions use standard file extensions (.dll, .ocx or .cpl)
as well as they usually don't turn on their system attribues
(read-only/hidden/system). If ShellExView detect shell extension with
unusual file extension or with unusual attribute (e.g: shell extension
dll that is marked as hidden in the file system), it'll be marked in red
color. It's recommended to deeply check these unusual shell extensions to
insure that they are not unwanted malicious programs that penetrated into
your system.



Command-line options
====================



/stext <Filename>
Save the list of shell extensions into a regular text file.

/stab <Filename>
Save the list of shell extensions into a tab-delimited text file.

/scomma <Filename>
Save the list of shell extensions into a comma-delimited text file.

/stabular <Filename>
Save the list of shell extensions into a tabular text file.

/shtml <Filename>
Save the list of shell extensions into HTML file.

/sverhtml <Filename>
Save the list of shell extensions into vertical HTML file.

/sxml <Filename>
Save the list of shell extensions into XML file.

/NoLoadSettings
Run ShellExView without loading your last settings. (window position,
columns size, etc. )

/wow64
On x64 systems, load ShellExView for using with 32-bit applications.

/external <Windows Directory> <User Profile Folder (Optional)>
Run ShellExView on external instance of Windows operating system. This
option can be useful when you have Windows operating system that cannot
boot properly. The <User Profile Folder> parameter is optional. If you
don't specify it, ShellExView won't load extensions lists that are stored
in HKEY_CURRENT_USER.

Example:
shexview.exe /external "k:\windows" "k:\Documents and
Settings\Administrator"

/remote < \\ComputerName >
Use ShellExView with the shell extensions of a remote computer on your
network. You must have full administrator access on the remote computer
in order to use this feature.

If you fail to connect the remote computer with ShellExView, read the
instructions in the following Blog post:
How to connect a remote Windows 7/Vista/XP computer with NirSoft
utilities.

/disable <CLSID>
Disables the specified shell extension. You should specify the exact
CLSID value that you see in the CLSID column, for example:
shexview.exe /disable {120B94B5-2E6A-4F13-94D0-414BCB64FA0F}

/enable <CLSID>
Enables the specified shell extension. You should specify the exact CLSID
value that you see in the CLSID column, for example:
shexview.exe /enable {120B94B5-2E6A-4F13-94D0-414BCB64FA0F}



Translating ShellExView to other languages
==========================================

In order to translate ShellExView to other language, follow the
instructions below:
1. Run ShellExView with /savelangfile parameter:
   shexview.exe /savelangfile
   A file named shexview_lng.ini will be created in the folder of
   ShellExView utility.
2. Open the created language file in Notepad or in any other text
   editor.
3. Translate all string entries to the desired language. Optionally,
   you can also add your name and/or a link to your Web site.
   (TranslatorName and TranslatorURL values) If you add this information,
   it'll be used in the 'About' window.
4. After you finish the translation, Run ShellExView, and all
   translated strings will be loaded from the language file.
   If you want to run ShellExView without the translation, simply rename
   the language file, or move it to another folder.



Feedback
========

If you have any problem, suggestion, comment, or you found a bug in my
utility, you can send a message to [email protected]

tools\install\shexview.chm

tools\install\shexview.exe

md5: 8CC6CFF43C3C641BDCC89A950F357383 | sha1: A254BF05EF1DE00706F6BFA9083E18A2A68E6F79 | sha256: 5A9A0DAD900F5D3C90BC78D3EE4BB3F3E6BE253732C9199770418048CA7BB0A1 | sha512: F121C3CAE6209D13874583B4BA05D780D267D4E80E3A738F39E2F671EA40FF57A802D0BE3EE88C393F41D1EA34C3A8943D0030884CCD4D186C1EFE75A22AB981

tools\LICENSE.txt

The contents of this file were automatically copied from \tools\install\readme.txt




ShellExView v2.01
Copyright (c) 2003 - 2019 Nir Sofer
Web Site: http://www.nirsoft.net



Description
===========

Shell Extensions are in-process COM objects which extend the abilities of
Windows operating system. Most shell extensions are automatically
installed by the operating system, but there are also many other
applications that install additional shell extension components. For
example: If you install WinZip on your computer, you'll see a special
WinZip menu when you right-click on a Zip file. This menu is created by
adding a shell extension to the system.

The ShellExView utility displays the details of shell extensions
installed on your computer, and allows you to easily disable and enable
each shell extension.

ShellExView can be used for solving context-menu problems in Explorer
environment. For more information, read the following article:
Right-click is slow or weird behavior caused by context menu handlers



System Requirements
===================

This utility works on any version of Windows, starting from Windows 98
and up to Windows 10. x64 versions of Windows are also supported.

Versions History
================




10/06/2019
2.01

* Fixed bug: ShellExView crashed on some systems.


07/03/2019
2.00

* Fixed to detect properly the filename of .NET extensions.


30/08/2015
1.97

* Fixed the 'Restart Explorer' option to work properly on Windows 10.


07/08/2015
1.96

* Fixed bug: When the 'Hide All Microsoft Extensions' option was turned
  on, ShellExView didn't display it as checked.
* Fixed bug: ShellExView failed to detect some shell extensions.


02/07/2015
1.95

* Added 'Hide All Microsoft Extensions' option.
* Added 'Missing File' column (Displays 'Yes' if the shell extension
  file is missing).


26/05/2014
1.90

* Added 'Thumbnail Handler' and 'Preview Handler' shell extensions that
  ShellExView failed to locate in previous versions.


05/09/2013
1.86

* Fixed bug: ShellExView failed to extract the digital signatures on
  some systems.


19/08/2013
1.85

* Fixed issue: Microsoft shell extensions displayed as non-Microsoft if
  the company name was 'Microsoft Corp.'
* Added 'Digital Signature' column, which displays the signer name if
  the shell extension dll is signed with a digital signature. This column
  is active only when 'Read Digital Signatures' option (Under the Options
  menu) is turned on. (by default it's turned off)
* Added 'Auto Size Columns+Headers' option.


13/06/2013
1.81

* Added secondary sorting: When clicking the column headers of 'Type',
  'Company', and other columns , the list is sorted by the selected
  column first, and then by the 'Extension Name' column.


31/05/2013
1.80

* Added 'Show 32-bit Shell Extensions' option, under the Options menu,
  available only on 64-bit systems. When it's turned on, ShellExView
  loads the 32-bit instance of installed shell extensions. (Similar to
  the /wow64 command-line option)


25/09/2012
1.76

* Fixed issue: The properties window opened in the wrong monitor, on
  multi-monitors system.


09/09/2012
1.75

* Added 'Restart Explorer' (Ctrl+E) option, under the Options menu,
  which allows you to easily restart Windows Explorer if the
  disabling/enabling a shell extension doesn't affect Explorer
  immediately (Very useful for Windows 7/2008/Vista).


19/03/2012
1.70

* Added 'Put Icon On Tray' option.


24/10/2011
1.68

* Added shell extensions under LibraryFolder\Background key.


03/10/2011
1.67

* You can now drag one or more files from the window of ShellExView
  into Explorer window or other application.


18/05/2011
1.66

* Added 'Show Time In GMT' option.


10/03/2011
1.65

* Added support for 3 types of shell extensions: Disk Cleanup Handlers,
  Icon Overlay Handlers, and Property Handlers


26/02/2011
1.60

* Added /enable and /disable command-line options, which allow you to
  disable/enable shell extensions automatically from command-line without
  displaying any user interface, by specifying the CLSID of the shell
  extension.


14/02/2011
1.55

* Fixed bug: ShellExView failed to detect some shell extensions (When
  the CLSID was specified as Registry key instead of Registry value).
* Added .NET detection - When there is a .NET extension, ShellExView
  now detect the real shell extension dll instead of displaying the .NET
  core dll (mscoree.dll)
* Added .NET column, which displays 'Yes' if the shell extension was
  created in .NET


21/11/2010
1.50

* Added 'Google Search - Filename' and 'Google Search - Extension Name'
  options, which allows you to easily search for information about the
  selected shell extension in Google.


20/09/2010
1.48

* Added 'Add Header Line To CSV/Tab-Delimited File' option. When this
  option is turned on, the column names are added as the first line when
  you export to csv or tab-delimited file.


18/05/2010
1.47

* Fixed ShellExView x64 to require to run as admin under Windows
  7/Vista, like the 32-bit version.


03/05/2010
1.46

* Added 'Preview Handler' shell extensions.


07/11/2009
1.45

* On x64 systems, ShellExView now always shows the shell extensions for
  x64 applications, even on the 32-bit version of ShellExView. If you
  want to get the shell extensions list for 32-bit applications, use
  ShellExView with /wow64 command-line option.
* Added /remote command-line option, which allows you to
  view/enable/disable shell extensions in a remote computer on your
  network.


29/08/2009
1.41

* Changed the definition of 'Suspicious Shell Extensions' - In previous
  versions, Every shell extension with read-only attribute marked as
  Suspicious, which confused some users, because there are many
  legitimated shell extensions that set a read-only attribute, probably
  to protect them from delete by the user. However, if a shell extension
  has an hidden attribute, it'll still be marked as suspicious.


22/08/2009
1.40

* Added option to submit a report about a shell extension that you
  disabled to http://shellfix.nirsoft.net.


05/04/2009
1.37

* ShellExView now displays a special warning when trying to disable a
  shell extension of shell32.dll


07/01/2009
1.36

* Fixed bug: ShellExView crashed when using it with the save
  command-line options.


24/11/2008
1.35

* Added support for using ShellExView with external drive (by using
  /external command-line option).


10/11/2008
1.30

* Added 'Filter By Extension Type' option - Allows you to select which
  type of shell extensions you want to view.


24/10/2008
1.25

* New restriction: ShellExView won't allow you to disable at once more
  than 15 shell extensions created by Microsoft. The reason for this
  restriction is that recently there were a few cases of people that
  disabled most of their shell extensions, including system extensions
  that installed as a part of the operating system, and then found
  themselves with a system that cannot boot properly.


02/10/2008
1.24

* Fixed bug: Exception window appeared when starting ShellExView in
  some systems.


08/07/2008
1.23

* Fixed bug: The dates displayed in system locale format, instead of
  user locale.


14/05/2008
1.22

* Added shell extensions under "My Network Places", "Entire Network",
  and "Remote Computer" Registry keys.
* Added 3 columns: "My Network Places", "Entire Network", and "Remote
  Computer" (which tells you whether the Shell Extension was added into
  these folders)


03/05/2008
1.21

* Fixed bug: The main window lost the focus when the user switched to
  another application and then returned back to ShellExView.


24/04/2008
1.20

* Added support for saving as comma-delimited text file


22/11/2007
1.19

* Under Vista, ShellExView now requires to run as administrator.


21/09/2007
1.18

* Configuration of ShellExView is now saved to a cfg file instead of
  the Registry.


04/08/2007
1.17

* Added support for properly enabling/disabling shell extensions under
  Windows Vista. (The disabled shell extensions are added to
  'HKEY_LOCAL_MACHINE\SOFTWARE\Microsoft\Windows\CurrentVersion\Shell
  Extensions\Blocked' key in the Registry)
* Added x64 version (as a separated download) for using under Windows
  Vista x64.
* Added shell extensions under SystemFileAssociations key.


16/02/2007
1.16

* Fixed bug: When a filename was enclosed with quotes, ShellExView
  failed to display the properties of the file.


12/08/2006
1.15

* A tooltip is displayed when a string in a column is longer than the
  column length.


30/12/2005
1.14

* Added shell extensions under HKEY_CLASSES_ROOT\Directory\Background


15/07/2005
1.13

* New columns: File Attributes and File Size.
* New option: Mark Suspicious Shell Extensions - mark in red color
  shell extensions with unusual file attribues (hidden attribue) or with
  unusual file extensions.


21/06/2005
1.12

* New shell extension types: InfoTip Handler, Shell Link, Structure
  Storage, MetaData.
* Multiple shell extensions with the same CLSID are now displayed in
  separated entries.
* Added support for Windows XP style.


27/02/2005
1.11

* New shell extension type: URL Search Hook.
* Open the CLSID key of the shell extension in RegEdit.
* New column: File Extensions.


25/11/2004
1.10

* New columns: File Created Time, CLSID Modified Time, Microsoft.
* New extensions types: Browser Helper Object, IE Toolbar, Explorer
  Bar, IE Extensions.
* Choose columns dialog-box.
* Auto-Size columns.
* Find dialog-box.
* HTML Reports.
* Save as XML file.
* Mark disabled items in gray color.
* Mark non-Microsoft extensions in pink color.
* Ability to translate to other languages.


23/08/2003
1.01
Critical bug from previous version (1.00) was fixed: In some
circumstances, after disabling a shell extension and then enabling it
again, the shell extension continued to be disabled, even if ShellExView
show that it's enabled.

05/06/2003
1.00
First Release.


License
=======

This utility is released as freeware. You are allowed to freely
distribute this utility via floppy disk, CD-ROM, Internet, or in any
other way, as long as you don't charge anything for this. If you
distribute this utility, you must include all files in the distribution
package, without any modification !



Disclaimer
==========

The software is provided "AS IS" without any warranty, either expressed
or implied, including, but not limited to, the implied warranties of
merchantability and fitness for a particular purpose. The author will not
be liable for any special, incidental, consequential or indirect damages
due to loss of data or any other reason.



Using ShellExView
=================

The ShellExView is a standalone executable. It doesn't require any
installation process or additional DLLs. Just copy it to any folder you
want, and run it. After you run it, wait a few seconds until ShellExView
loads all shell extensions items.
The main window of ShellExView displays the details of all shell
extensions in 12 different columns:



Extension Name
The name of the shell extension, as it appears in the Registry.

Disabled
Tells you whether the shell extension is disabled.

Type
The type of the shell extension. There are more than 10 different types
of shell extensions. For more information about the types of shell
extensions, see the table below.

Description
Description of the shell extension item. This information is extracted
from the DLL file that contains this shell extension.

Version
Version of the shell extension item. This information is extracted from
the DLL file that contains this shell extension.

Product Name
The name of the product that created this shell extension. This
information is extracted from the DLL file that contains this shell
extension.

Company
The name of the company that created this shell extension.

My Computer
Tells you whether the "My Computer" folder contains this shell extension.
This column is only relevant to "Shell Folder" extensions.

Desktop
Tells you whether the "Desktop" folder contains this shell extension.
This column is only relevant to "Shell Folder" extensions.

Control Panel
Tells you whether the "Control Panel" folder contains this shell
extension. This column is only relevant to "Shell Folder" extensions
under Windows 2000/XP.

Filename
The filename that contains this shell extension.

CLSID
The CLSID of this shell extension.

File Created Time
The creation time of the extension dll. You can use this field in order
to find out when the extension was installed on your system.

CLSID Modified Time
The Modified Time of CLSID in the Registry. Only available under Windows
NT/2000/XP.

Microsoft
Specifies whether the extension was created by Microsoft ('Yes' value) or
by other company ('No' value).

File Extensions
Specifies a list of file extensions (like .txt, .html) that use this
shell extension.

File Attributes
Specifies the attributes of the shell extension file. (H for hidden, R
for read-only, and so on)

File Size
Specifies the size (in bytes) of the shell extension file.

There are more than 10 types of shell extension, here's a small
description for each type:


Shell Folder
Provides special system folders like "Printers", "Fonts", "Recycle Bin",
and more...

Context Menu
Provides the ability to add new items to the context menu of particular
file type.

Drag & Drop Handler
Provides the ability to add new items to the context menu that appears
when you drag a file with right mouse button.

Icon Handler
Provides the ability to dynamically assign icons to file objects.

Copy Hook Handler
This type of shell extension is called when a file is moved, copies,
renamed or deleted.

Drop Handler
Provides the ability to control the "Drop" behavior of files.

Data Handler
Provides the ability to copy files/objects to the clipboard.

Property Sheet
Property Sheet dialog boxes.

Search Handler
Provides the ability to create a system search engine (Like the standard
"Search For Files or Folders" module)

Column Handler
Provides the ability to add new columns to the details view of Explorer
window.

Thumbnail
Provides the ability to display images in "Thumbnail" view.

Browser Helper Object
Provides the ability to customize and control the Internet Explorer
browser.

IE Toolbar
Provides the ability to add new toolbars into Internet Explorer (like
Yahoo! Toolbar)

Explorer Bar
Provides the ability to add Explorer bars to Internet Explorer.

URL Search Hook
Browser extension stored under Software\Microsoft\Internet
Explorer\URLSearchHooks.

System
All other types of shell extensions that ShellExView utility cannot
recognize are categorized as "System" type.



Disable/Enable Shell Extensions
===============================

The ShellExView utility allows you to disable and enable the shell
extensions components on your system. In order to disable or enable a
shell extension item, select the desired item, and from the File menu (or
from the pop-up menu) select the appropriate option - "Enable Selected
Items" or "Disable Selected Items".
Here's 2 examples of useful things that you can do with this feature:

* Context Menu: Some applications, like WinZip, CuteFTP, and others,
  add some items to the context menu when you right-click on a file in
  explorer window. If you disable the appropriate shell extension, you
  won't get these additional menu items.
  In order to locate the desired shell extension item:
  1. Sort the extensions list by the "Type" column and look at all
     "Context Menu" items.
  2. Search the application that creates the menu you want to
     disable. The icon near each item can help to locate the desired
     shell extension.

* Shell Folder: When you enter into some special folders like "History"
  and "Temporary Internet Files", you don't see the real file system, but
  the a virtual folder that the shell extension create for you. If you
  want to watch the real file system inside "History" or "Temporary
  Internet Files", you can disable the appropriate shell extension items.



Sending report to shellfix.nirsoft.net
======================================

If you solved a problem by disabling a shell extension in your Explorer,
and you want to share it with others, you can use the 'Send Report To
ShellFix' option to publish the information in
http://shellfix.nirsoft.net. You can find full instructions about how to
send a report in the main page of http://shellfix.nirsoft.net Web site.



Add/Remove special folders to "My Computer" and "Desktop" folders
=================================================================

Some special shell folders like "Printers", "Recycle Bin", "Scheduled
Tasks", "Network and Dial-up Connections", "Mobile Device", and others
can be added (and be removed) to "My Computer", "Desktop", and even to
"Control Panel" (Only in Windows 2000) by using the ShellExView utility.
For Example: Under Windows 2000, you can add the "Printers", "Recycle
Bin", and "Scheduled Tasks" folders to "My Computer". In order to do
that, select the item that you want to add or remove (You can only use
"Shell Folder" items) and from the File menu, select the appropriate
add/remove option.
Be aware that there are some shell folders that cannot be added to "My
Computer" or "Desktop" folders. For example: adding the "Administrative
Tools" folder to "My Computer" won't work properly as you might expect.



Mark Suspicious Shell Extensions
================================

Most shell extensions use standard file extensions (.dll, .ocx or .cpl)
as well as they usually don't turn on their system attribues
(read-only/hidden/system). If ShellExView detect shell extension with
unusual file extension or with unusual attribute (e.g: shell extension
dll that is marked as hidden in the file system), it'll be marked in red
color. It's recommended to deeply check these unusual shell extensions to
insure that they are not unwanted malicious programs that penetrated into
your system.



Command-line options
====================



/stext <Filename>
Save the list of shell extensions into a regular text file.

/stab <Filename>
Save the list of shell extensions into a tab-delimited text file.

/scomma <Filename>
Save the list of shell extensions into a comma-delimited text file.

/stabular <Filename>
Save the list of shell extensions into a tabular text file.

/shtml <Filename>
Save the list of shell extensions into HTML file.

/sverhtml <Filename>
Save the list of shell extensions into vertical HTML file.

/sxml <Filename>
Save the list of shell extensions into XML file.

/NoLoadSettings
Run ShellExView without loading your last settings. (window position,
columns size, etc. )

/wow64
On x64 systems, load ShellExView for using with 32-bit applications.

/external <Windows Directory> <User Profile Folder (Optional)>
Run ShellExView on external instance of Windows operating system. This
option can be useful when you have Windows operating system that cannot
boot properly. The <User Profile Folder> parameter is optional. If you
don't specify it, ShellExView won't load extensions lists that are stored
in HKEY_CURRENT_USER.

Example:
shexview.exe /external "k:\windows" "k:\Documents and
Settings\Administrator"

/remote < \\ComputerName >
Use ShellExView with the shell extensions of a remote computer on your
network. You must have full administrator access on the remote computer
in order to use this feature.

If you fail to connect the remote computer with ShellExView, read the
instructions in the following Blog post:
How to connect a remote Windows 7/Vista/XP computer with NirSoft
utilities.

/disable <CLSID>
Disables the specified shell extension. You should specify the exact
CLSID value that you see in the CLSID column, for example:
shexview.exe /disable {120B94B5-2E6A-4F13-94D0-414BCB64FA0F}

/enable <CLSID>
Enables the specified shell extension. You should specify the exact CLSID
value that you see in the CLSID column, for example:
shexview.exe /enable {120B94B5-2E6A-4F13-94D0-414BCB64FA0F}



Translating ShellExView to other languages
==========================================

In order to translate ShellExView to other language, follow the
instructions below:
1. Run ShellExView with /savelangfile parameter:
   shexview.exe /savelangfile
   A file named shexview_lng.ini will be created in the folder of
   ShellExView utility.
2. Open the created language file in Notepad or in any other text
   editor.
3. Translate all string entries to the desired language. Optionally,
   you can also add your name and/or a link to your Web site.
   (TranslatorName and TranslatorURL values) If you add this information,
   it'll be used in the 'About' window.
4. After you finish the translation, Run ShellExView, and all
   translated strings will be loaded from the language file.
   If you want to run ShellExView without the translation, simply rename
   the language file, or move it to another folder.



Feedback
========

If you have any problem, suggestion, comment, or you found a bug in my
utility, you can send a message to [email protected]

tools\VERIFICATION.txt


The contents of this folder were automatically downloaded
and extracted from https://www.nirsoft.net/utils/shexview.zip on Friday, 28-Jun-19 16:46:45 CDT.

Virus Scan Results

shexview.2.01.nupkg (c5ec49897575) - ## / 63
shexview.exe (5a9a0dad900f) - ## / 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
ShellExView 2.01	3182	Friday, June 28, 2019	Approved
ShellExView 2.00	441	Friday, April 12, 2019	Approved
ShellExView 1.97	1199	Tuesday, September 1, 2015	Approved
ShellExView 1.95	476	Friday, July 10, 2015	Approved
ShellExView 1.90	456	Saturday, June 27, 2015	Approved

Dependencies

This package has no dependencies.

Discussion for the ShellExView Package

Ground Rules:

This discussion is only about ShellExView and the ShellExView 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 ShellExView, 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

5,878

3,182

28 Jun 2019

ShellExView

ShellExView 2.01

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

Ground Rules: