Welcome to the Chocolatey Community Package Repository! The packages found in this section of the site are provided, maintained, and moderated by the community.
Moderation
Every version of each package undergoes a rigorous moderation process before it goes live that typically includes:
- Security, consistency, and quality checking
- Installation testing
- Virus checking through VirusTotal
- Human moderators who give final review and sign off
More detail at Security and Moderation.
Organizational Use
If you are an organization using Chocolatey, we want your experience to be fully reliable. Due to the nature of this publicly offered repository, reliability cannot be guaranteed. Packages offered here are subject to distribution rights, which means they may need to reach out further to the internet to the official locations to download files at runtime.
Fortunately, distribution rights do not apply for internal use. With any edition of Chocolatey (including the free open source edition), you can host your own packages and cache or internalize existing community packages.
Disclaimer
Your use of the packages on this site means you understand they are not supported or guaranteed in any way. Learn more...
-
STEP1
Package Review
-
STEP2
Integration Method
-
STEP3
Internal Repo Url
-
STEP4
Environment Setup
-
STEP5
Install Script
Step 1: Review Your Packages
Step 2: Choose Your Integration Method
Step 3: Enter Your Internal Repository Url
(this should look similar to https://community.chocolatey.org/api/v2/)
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
-
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
-
Run: (additional options)
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:
## 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.1.1.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.1.1.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.1.1.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.1.1.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 |
---|---|
- Passing
- Failing
- Pending
- Unknown / Exempted

Downloads:
849
Downloads of v 1.10:
136
Last Update:
02 Aug 2021
Package Maintainer(s):
Software Author(s):
- Voxengo
Tags:
drumformer vst aax audio mixing mastering recording transient trial- Software Specific:
- Software Site
- Software License
- Software Docs
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download

Voxengo Drumformer (Install)
- 1
- 2
- 3
1.10 | Updated: 02 Aug 2021
- Software Specific:
- Software Site
- Software License
- Software Docs
- Package Specific:
- Package Source
- Package outdated?
- Package broken?
- Contact Maintainers
- Contact Site Admins
- Software Vendor?
- Report Abuse
- Download
Downloads:
849
Downloads of v 1.10:
136
Maintainer(s):
Software Author(s):
- Voxengo
Edit Package
To edit the metadata for a package, please upload an updated version of the package.
Chocolatey's Community Package Repository currently does not allow updating package metadata on the website. This helps ensure that the package itself (and the source used to build the package) remains the one true source of package metadata.
This does require that you increment the package version.
- 1
- 2
- 3
Voxengo Drumformer (Install)
1.10
- 1
- 2
- 3
All Checks are Passing
3 Passing Tests
Deployment Method: Individual Install, Upgrade, & Uninstall
To install Voxengo Drumformer (Install), run the following command from the command line or from PowerShell:
To upgrade Voxengo Drumformer (Install), run the following command from the command line or from PowerShell:
To uninstall Voxengo Drumformer (Install), run the following command from the command line or from PowerShell:
Deployment Method:
📝 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
-
Open Source
-
Download the package:
Download - Follow manual internalization instructions
-
-
Package Internalizer (C4B)
-
Run: (additional options)
choco download voxengo-drumformer --internalize --source=https://community.chocolatey.org/api/v2/
-
For package and dependencies run:
choco push --source="'INTERNAL REPO URL'"
- Automate package internalization
-
Run: (additional options)
3. Copy Your Script
choco upgrade voxengo-drumformer -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 voxengo-drumformer -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 voxengo-drumformer
win_chocolatey:
name: voxengo-drumformer
version: '1.10'
source: INTERNAL REPO URL
state: present
See docs at https://docs.ansible.com/ansible/latest/modules/win_chocolatey_module.html.
chocolatey_package 'voxengo-drumformer' do
action :install
source 'INTERNAL REPO URL'
version '1.10'
end
See docs at https://docs.chef.io/resource_chocolatey_package.html.
cChocoPackageInstaller voxengo-drumformer
{
Name = "voxengo-drumformer"
Version = "1.10"
Source = "INTERNAL REPO URL"
}
Requires cChoco DSC Resource. See docs at https://github.com/chocolatey/cChoco.
package { 'voxengo-drumformer':
ensure => '1.10',
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.
This package was approved as a trusted package on 05 Aug 2021.
Drumformer is a multiband drum and master track dynamics processing AU and VST plugin for professional music and audio production applications. Drumformer was designed to be a comprehensive solution for the broadest range of sound processing tasks, allowing you to easily implement almost any dynamics processing idea you may have.
Package Specific
Package Parameters
The following package parameters can be set:
/NoVst2x86
- Do not install the x86 VST2 version/NoVst2x64
- Do not install the x64 VST2 version/NoVst3x86
- Do not install the x86 VST3 version/NoVst3x64
- Do not install the x64 VST3 version/NoAaxx86
- Do not install the x86 AAX version/NoAaxx64
- Do not install the x64 AAX version/NoShortcuts
- Do not install shortcuts to manuals and uninstaller into start menu or onto desktop/Vst2Path:
- Installation path of the VST2 version/Vst2x86Path:
- Installation path of the x86 VST2 version on x64 CPU architecture/InstallerPath:
- Do not download the installer from the official Voxengo website and use the one passed with this argument instead. Use it, if you don't have an internet connection at your studio computer./CompanyPath:
- Path of the company to put all program files in. Override if you want to have the program files at a custom location.
You must pass the package parameters like this:
choco install voxengo-drumformer --package-parameters "'/NoVst2x64 /Vst2x86Path:${env:CommonProgramFiles(x86)}\VST2\Voxengo '"
# Installer Functions
# Comments to this script have been added upon request by the chocolatey community reviewer
function CreateShortcut ($shortcutObject) {
if($shortcutObject.execute -eq $true) {
$TemporaryWorkaroundFile = $false;
$tempShortcutPathAndName = "" + $shortcutObject.linkPath + "\" + $shortcutObject.linkName
If (-not(Test-Path -Path $shortcutObject.destPath)) {
If ([string]::IsNullOrWhiteSpace([System.IO.Path]::GetExtension($shortcutObject.destPath))) {
Write-Debug "Target path does not exist and has no file type extension. Assuming a folder. Creating it first."
New-Item -ItemType Directory -Force -Path $shortcutObject.destPath
} else {
New-Item -ItemType File -Force $shortcutObject.destPath
$TemporaryWorkaroundFile = $true;
}
}
Write-Debug "This is the Shortcut Full Path:"; Write-Debug $tempShortcutPathAndName
Install-ChocolateyShortcut -ShortcutFilePath $tempShortcutPathAndName -TargetPath $shortcutObject.destPath
If ($TemporaryWorkaroundFile -eq $true) {
Write-Debug "Deleting temporary workaround file."
Remove-Item $shortcutObject.destPath -Force
}
}
}
function CreateSymlink ($symlinkObject) {
if($symlinkObject.execute -eq $true) {
$tempSymlinkPathAndName = $symlinkObject.linkPath + "\" + $symlinkObject.linkName
If ($tempSymlinkPathAndName -eq $symlinkObject.destPath) {
Write-Error ("Target and Destination Paths of an overwritten parameter and an internal parameter are the same.")
return
}
if (Test-Path -Path $symlinkObject.destPath) {
Write-Debug ("Destination Path " + $symlinkObject.destPath + " already exists.")
} else {
Write-Debug ("Creating " + $symlinkObject.destPath)
New-Item $symlinkObject.destPath -ItemType Directory -Force
}
if (Test-Path -Path $tempSymlinkPathAndName) {
if((Get-Item $tempSymlinkPathAndName).Attributes.ToString() -Match "ReparsePoint") {
Write-Debug ("Link Path " + $tempSymlinkPathAndName + " already exists as SymbolicLink. Will overwrite SymbolicLink.")
} else {
Write-Debug ("Link Path " + $tempSymlinkPathAndName + " already exists. Will move to destination path and link afterwards.")
If (Test-Path $tempSymlinkPathAndName -pathType leaf) {
Write-Debug ("Link Path " + $tempSymlinkPathAndName + " is a file.")
Move-Item -Path $tempSymlinkPathAndName -Destination $symlinkObject.destPath -Force
} ElseIf (Test-Path $tempSymlinkPathAndName -pathType container) {
Write-Debug ("Link Path " + $tempSymlinkPathAndName + " is a folder.")
Move-Item -Path "$tempSymlinkPathAndName\*" -Destination $symlinkObject.destPath -Force
Remove-Item -Path "$tempSymlinkPathAndName"
} Else {
Write-Error ("Link Path " + $tempSymlinkPathAndName + " is neither file nor folder.")
return
}
}
}
Write-Debug ("Linking " + $tempSymlinkPathAndName + " to " + $symlinkObject.destPath)
New-Item -Type SymbolicLink -Path "$tempSymlinkPathAndName" -Value $symlinkObject.destPath -Force
}
}
function CreateRegKey ($regKeyObject) {
If ([string]::IsNullOrWhiteSpace($regKeyObject.path)) {
Write-Warning ("Given Registry Object Path is NULL.")
return
}
if($regKeyObject.execute -eq $true) {
# Determine value type
if (${regKeyObject}.value -is [String]) {
$registryValueType = "String"
Write-Debug("Registry value type is String.")
} elseif (${regKeyObject}.value -is [Int32]) {
$registryValueType = "DWORD"
Write-Debug("Registry value type is DWORD.")
} else {
$registryValueType = "String"
Write-Warning("Registry value type unknown. Using String as type.")
}
# Write reg key
if($regKeyObject.key -eq '') {
New-Item -PropertyType $registryValueType -Path ${regKeyObject}.path -Value ${regKeyObject}.value -Force
} else {
if (Test-Path ${regKeyObject}.path) { } else { New-Item ${regKeyObject}.path -force }
New-ItemProperty -PropertyType $registryValueType -Path ${regKeyObject}.path -Name ${regKeyObject}.key -Value ${regKeyObject}.value -force
}
}
}
function CreateRegKeyFromFile ($regKeyFileObject) {
if($regKeyFileObject.execute -eq $true) {
Write-Debug ("Creating registry entry from file " + $env:ChocolateyPackageFolder + "\" + $regKeyFileObject.path)
regedit.exe /S ($env:ChocolateyPackageFolder + "\" + $regKeyFileObject.path)
}
}
<#
.SYNOPSIS
Create the component list that will be parsed to the installer.
.DESCRIPTION
Create the component list that will be parsed to the installer. A component is a tickable box in an installer.
The resulting component list depends on the 'execute' bool that should be set before handing the installer
component into this function.
.PARAMETER instParamObject
An installer parameter object/action defined in the chocolateyvariables.ps1.
.NOTES
Comment added because reviewer asked to do so.
#>
function CreateInstallerParameters ($instParamObject) {
if($instParamObject.execute -eq $true) {
Write-Debug "Checking Installer Components for: "; Write-Debug $instParamObject.value
$global:installerComponents += $instParamObject.value
$global:installerComponents += ","
Write-Debug ("These are the current installerComponents: " + $global:installerComponents + ".")
}
}
function CopyPackageRessources ($PackageResourcePathObject) {
if($PackageResourcePathObject.execute -eq $true) {
Write-Debug ("Preparing Package Ressource Path for: " + $PackageResourcePathObject.value + ".")
$tempPath = ($env:ChocolateyPackageFolder + "\" + ($PackageResourcePathObject.value).ToString())
if((Test-Path $tempPath) -eq $false) {
Write-Debug ("The resource object " + $PackageResourcePathObject.value + " does not exist.")
return
}
# We create the target directory first as Copy-Item behaves differently when the target path doesn't exist as directory
New-Item $PackageResourcePathObject.installPath -ItemType Directory -Force
if($tempPath -Match "zip") {
Get-ChocolateyUnzip -FileFullPath "$tempPath" -Destination $PackageResourcePathObject.installPath
} else {
Move-Item -Path $tempPath -Destination $PackageResourcePathObject.installPath -Force -Recurse
Write-Debug ("Copying all files from Package\" + $PackageResourcePathObject.value + " to " + $PackageResourcePathObject.installPath + ".")
}
}
}
function CreateTxtFiles ($txtFileObject) {
if($txtFileObject.execute -eq $true) {
Write-Debug ("Creating txt file in " + $txtFileObject.key + " with the content: " + $txtFileObject.value)
Remove-Item $txtFileObject.key -ErrorAction SilentlyContinue
New-Item $txtFileObject.key -ItemType file -Force
[System.IO.File]::WriteAllLines($txtFileObject.key, $txtFileObject.value, (New-Object ("System.Text." + $txtFileObject.encoding + "Encoding") $txtFileObject.bom))
}
}
<#
.SYNOPSIS
Checks for default installer values
#>
function GetDefaultValues () {
$newDefaultPath = GetDefaultVst2Directory(64)
If (![string]::IsNullOrWhiteSpace($newDefaultPath)) {
Write-Debug("Default VST2 64 Path found: " + $newDefaultPath)
$global:vst2DefaultPath = $newDefaultPath
}
$newDefaultPath = GetDefaultVst2Directory(32)
If (![string]::IsNullOrWhiteSpace($newDefaultPath)) {
Write-Debug("Default VST2 32 Path found: " + $newDefaultPath)
$global:vst2x86_64DefaultPath = $newDefaultPath
}
}
<#
.SYNOPSIS
If default values were found (for instance in the registry) and no overrides have been given, set default installer settings
.DESCRIPTION
If default values were found (for instance in the registry) and no overrides have been given, set default installer settings
#>
function PickDefaultValuesFromSystem () {
If ([string]::IsNullOrWhiteSpace($pp["Vst2Path"])) {
If (![string]::IsNullOrWhiteSpace($global:vst2DefaultPath)) {
Write-Debug("Overwriting VST2 path with value found in registry: " + $vst2DefaultPath)
$global:vst2Path = $global:vst2DefaultPath
}
}
If ([string]::IsNullOrWhiteSpace($pp["Vst2x86Path"])) {
If (![string]::IsNullOrWhiteSpace($global:vst2x86_64DefaultPath)) {
Write-Debug("Overwriting VST2x86 path with value found in registry: " + $global:vst2x86_64DefaultPath)
$global:vst2x86_64Path = $global:vst2x86_64DefaultPath
}
}
If ($pp["CompanyPath"] -eq $false) {
# Some installers have an automatic detection mechanism for this path next to a default
Write-Debug "Checking if automatic install path detection is implemented ..."
if (Get-Command InstallerCompanyPathAutomaticDetection -errorAction SilentlyContinue) {
Write-Debug "Method has been implemented!"
InstallerCompanyPathAutomaticDetection
If ($autoInstDetectionCompanyPath) {
Write-Debug("AutoInstDetectionCompanyPath: " + $autoInstDetectionCompanyPath)
$global:companyPath = $autoInstDetectionCompanyPath
}
}
}
}
<#
.SYNOPSIS
Checks if a given path is a kind of link and returns its value resolved
.DESCRIPTION
Checks if a given path is a kind of link and returns its value resolved. Also returns the path if it's a directory or a file. Returns $null if it doesn't exist.
.NOTES
Comment added because reviewer asked to do so.
#>
function ResolvePath($target) {
$targetpath = $null
If (!(Test-Path $target)) {
Write-Debug ("Ended prematurely")
Write-Debug ("$targetpath")
return $targetpath
}
if($target.EndsWith(".lnk")) {
$sh = new-object -com wscript.shell
$fullpath = resolve-path $target
$targetpath = $sh.CreateShortcut($fullpath).TargetPath
Write-Debug ("Target ended with lnk and is " + "$targetpath")
return $targetpath
}
If ((Get-ItemPropertyValue -Path $target -Name LinkType) -eq "SymbolicLink") {
return $targetpath = Get-ItemPropertyValue -Path $target -Name Target
} ElseIf (Test-Path $target -pathType leaf) {
return $targetpath = (Get-Item $target).DirectoryName
} ElseIf (Test-Path $target -pathType container) {
return $targetpath = $target
}
Write-Debug ($targetpath)
return $targetpath
}
<#
.SYNOPSIS
Checks if given an array of paths has an entry with a kind of link and returns the first value resolved
.DESCRIPTION
Checks if a given an array of paths it checks for link and returns the first value resolved. Also returns the first path if it's a directory or a file. Returns $null if nothing exists.
.NOTES
Comment added because reviewer asked to do so.
#>
function ResolvePaths([String[]] $Paths) {
Foreach ($path in $Paths) {
If (ResolvePath($path)) {
Write-Debug ("Successfully resolved path " + "$path")
return ResolvePath($path)
break
}
}
Write-Debug ("Returning NULL path ")
return $null
}
<#
.SYNOPSIS
Returns a given registry key/name's value
.DESCRIPTION
Returns a given registry key/name's value
.NOTES
Comment added because reviewer asked to do so.
#>
function ResolveRegPath($reg) {
If (!(Test-Path -Path $reg.key)) {
Write-Debug ("Given key is NULL")
return $null
}
$value = Get-ItemProperty -Path $reg.key -ErrorAction SilentlyContinue | Select-Object -ExpandProperty $reg.name -ErrorAction SilentlyContinue
If ([string]::IsNullOrWhiteSpace($value)) {
Write-Debug ("Given key's name is NULL")
return $null
}
Write-Debug ("Value found: " + $value)
return $value
}
<#
.SYNOPSIS
Try to find the default VST2 directory
.DESCRIPTION
Try to find the default VST2 directory
.PARAMETER bitToCheck
Wether to find the default 32 bit or 64 bit directory
.NOTES
Comment added because reviewer asked to do so.
#>
function GetDefaultVst2Directory ($bitToCheck) {
If ($bitToCheck -eq 32) {
$defaultRegBasePath = "HKLM:\\SOFTWARE\WOW6432Node\VST"
$installerDefaultRegPath = $vst2x86_64PathReg
} ElseIf ($bitToCheck -eq 64) {
$defaultRegBasePath = "HKLM:\\SOFTWARE\VST"
$installerDefaultRegPath = $vst2PathReg
}
$returnVst2Path = $null
If (Test-Path -Path $defaultRegBasePath) {
$newVst2Path = Get-ItemProperty -Path $defaultRegBasePath -ErrorAction SilentlyContinue | Select-Object -ExpandProperty VstPluginsPath -ErrorAction SilentlyContinue
If (![string]::IsNullOrWhiteSpace($newVst2Path)) {
If ($vst2AddSubfolder) {
$newVst2Path += "\$companyPath"
}
$returnVst2Path = $newVst2Path
}
}
If (![string]::IsNullOrWhiteSpace($installerDefaultRegPath.key)) {
$newVst2Path = Get-ItemProperty -Path $installerDefaultRegPath.key -ErrorAction SilentlyContinue | Select-Object -ExpandProperty $installerDefaultRegPath.name -ErrorAction SilentlyContinue
If (![string]::IsNullOrWhiteSpace($newVst2Path)) {
$returnVst2Path = $newVst2Path
}
}
return $returnVst2Path
}
function RunInstallerWithPackageParametersObject ($packageParameterObject) {
$installerPathViaPP = (Test-Path $pp["InstallerPath"])
## Does the following check work for 32 bit installers??
$installerEmbedded = ((Test-Path ($env:ChocolateyPackageFolder + "\" + $packageParameterObject.file)) -And ($packageParameterObject.file64 -ne $null) -And (Test-Path ($env:ChocolateyPackageFolder + "\" + $packageParameterObject.file64)))
$installerDownload = (($packageParameterObject.url -ne $null) -Or ($packageParameterObject.url64 -ne $null))
$installerDownloadExe = (($packageParameterObject.url -ne $null) -And ($packageParameterObject.url).EndsWith(".exe"))
Write-Debug ("This is the InstallerPath Variable: " + $pp["InstallerPath"])
if($installerPathViaPP -eq $true) {
Write-Debug "Installer overridden via package parameter"
$packageParameterObject["file"] = $fileLocation
Install-ChocolateyInstallPackage @packageParameterObject # https://chocolatey.org/docs/helpers-install-chocolatey-install-package
return
}
if($installerEmbedded -eq $true) {
Write-Debug "Installer is embedded"
$packageParameterObject.file = ($env:ChocolateyPackageFolder + "\" + $packageParameterObject.file)
$packageParameterObject.file64 = ($env:ChocolateyPackageFolder + "\" + $packageParameterObject.file64)
Write-Debug ("Installer (32 bit referenced) embedded path: " + $packageParameterObject.file)
Write-Debug ("Installer (64 bit referenced) embedded path: " + $packageParameterObject.file64)
Install-ChocolateyInstallPackage @packageParameterObject
return
}
if($installerDownload -eq $true -And $installerPathViaPP -eq $false) {
Write-Debug ("Installer needs to be downloaded from " + $packageParameterObject.url)
if($installerDownloadExe -eq $true) {
Write-Debug "Installer is exe, running now..."
Install-ChocolateyPackage @packageParameterObject # https://chocolatey.org/docs/helpers-install-chocolatey-package
} else {
Write-Debug "Installer inside zip"
Write-Debug ("UnzipLocation is: " + $packageParameterObject.unzipLocation)
$packageParameterObject["file"] = $fileLocation
Install-ChocolateyZipPackage @packageParameterObject
Install-ChocolateyInstallPackage @packageParameterObject
}
return
}
Write-Warning ("No installer found!");
}
function RemoveInstallerObjects ($packageParameterObject) {
if($packageParameterObject.file) {
if(Test-Path ($packageParameterObject.file) -ErrorAction Ignore){
Remove-Item $packageParameterObject.file -Force -ErrorAction SilentlyContinue
}
}
if($packageParameterObject.file64) {
if(Test-Path ($packageParameterObject.file64) -ErrorAction Ignore){
Remove-Item $packageParameterObject.file64 -Force -ErrorAction SilentlyContinue
}
}
}
function RemoveTemporaryFiles ($PackageResourcePathObject) {
Write-Debug ("Deleting temp package files: " + $env:ChocolateyPackageFolder + "\" + $PackageResourcePathObject.value + " and" + $env:ChocolateyPackageFolder + "\" + $PackageResourcePathObject.value + ".txt")
Remove-Item ($env:ChocolateyPackageFolder + "\" + $PackageResourcePathObject.value) -Force -ErrorAction SilentlyContinue
Remove-Item ($env:ChocolateyPackageFolder + "\" + $PackageResourcePathObject.value + ".txt") -Force -ErrorAction SilentlyContinue
}
function HandlePackageArgs ($packageParameterObject) {
if ($global:installerComponents) {
If ($global:installerComponents.EndsWith(',')) {
Write-Debug ("Components list ends with , - removing.")
$global:installerComponents = $global:installerComponents.Substring(0,$global:installerComponents.Length-1)
}
$packageParameterObject["silentArgs"] += " /Components=$global:installerComponents"
}
Write-Debug "This are the silentArgs"; Write-Debug $packageParameterObject["silentArgs"]
}
# Creates txt file containing all zip files and where they have been copied to.
# Also checks whether extracted zip content should be uninstalled or not (.delete=$false).
function WriteUninstallData ($PackageResourcePathObject) {
if($PackageResourcePathObject.delete -ne $false) {
foreach($line in Get-Content ($env:ChocolateyPackageFolder + "\" + $PackageResourcePathObject.value + ".txt")) {
Add-Content -Path ($env:ChocolateyPackageFolder + "\uninstall.txt") -Value ($PackageResourcePathObject.installPath + "\" + $line)
}
}
}
# Creates/Overwrites bit-aware variables, so x86 files can use the same path-var on both platforms
function CreateBitAwareVariables () {
if($osBitness -eq 64) {
$global:vst2x86BitAware = "$vst2x86_64Path"
$global:vst3x86BitAware = "$vst3x86_64Path"
$global:aaxx86BitAware = "$aaxx86_64Path"
$global:vst2x86PathRegBitAware = "$vst2x86_64PathReg"
$global:rtasBitaware = "${env:COMMONPROGRAMFILES(x86)}\Digidesign\DAE\Plug-Ins"
}
if($osBitness -eq 32) {
$global:vst2x86BitAware = "$vst2Path"
$global:vst3x86BitAware = "$vst3Path"
$global:aaxx86BitAware = "$aaxPath"
$global:vst2x86PathRegBitAware = "$vst2PathReg"
$global:rtasBitaware = "${env:COMMONPROGRAMFILES}\Digidesign\DAE\Plug-Ins"
}
}
# Uninstaller Functions
function Test-Registry ($path, $value) {
try {
Get-ItemProperty -Path $Path | Select-Object -ExpandProperty $Value -ErrorAction Stop | Out-Null
return $true
} catch {
return $false
}
}
function DeleteFolders ($folderPath) {
if([string]::IsNullOrWhiteSpace($folderPath)) {
Write-Debug "Path variable is null."
return
}
if(Test-Path -path "$folderPath") {
Write-Debug "$folderPath will be deleted."
# "Archive" seems to be a lnk file
if((Get-Item ($folderPath).ToString()).Attributes.ToString() -Match "Archive" ) {
Remove-Item $folderPath -Force -Recurse
} else {
[System.IO.Directory]::Delete("$folderPath", $true)
}
}
}
# Checks, if a folder is empty and if true, deletes that folder. Also checks three levels upwards. -Force is not necessary.
function DeleteFoldersIfEmpty ($folderPath) {
Write-Debug ("Checking " + $folderPath)
if([string]::IsNullOrWhiteSpace($folderPath)) {
Write-Debug "Path variable is null."
return
}
if((Test-Path -Path "$folderPath") -eq $false) {
Write-Debug "$folderPath does not exist."
return
}
$parentFolder = (Get-ItemProperty $folderPath).Parent.FullName
$parentParentFolder = (Get-ItemProperty $folderPath).Parent.Parent.FullName
$folderList = "$folderPath", "$parentFolder", "$parentParentFolder"
Foreach ($path in $folderList) {
Write-Debug ("Checking if path exists and is empty: " + $path)
if($path -ne '' -and $path -ne $null) {
if(((Test-Path "$path") -and (Get-ChildItem "$path") -eq $null)) {
Write-Debug "$path is empty and will be deleted."
Remove-Item "$path"
}
}
}
}
function DeleteDataFromTxtFile ($uninstallFile) {
Foreach($path in Get-Content $uninstallFile) {
If ([string]::IsNullOrWhiteSpace($path)) {
return
}
Write-Debug ("About to delete " + $path)
if(Test-Path $path -pathType leaf) {
$directoryName = (Get-Item $path).DirectoryName
Write-Debug "$path will be deleted."
Remove-Item "$path" -Force
DeleteFoldersIfEmpty($directoryName)
}
if(Test-Path $path -pathType container) {
$parentDirectory = (Get-ItemProperty $path).Parent.FullName
Write-Debug "$path will be deleted."
#Remove-Item -Recurse -Force fails if folder contains a symlink -.-
[System.IO.Directory]::Delete("$path", $true)
DeleteFoldersIfEmpty($parentDirectory)
}
}
}
# Removes all registry entires in a given registry file from the registry
function DeleteRegKeysFromFile ($file) {
if(Test-Path $file) {
(Get-Content $file) -replace "^\[","[-" | out-file $file
regedit.exe /S ($file)
}
}
# Deletes a registry key or property, if it exists and is not marked as delete=$false
function DeleteRegKeyFromObjects ($regKey) {
Write-Debug ("About to delete Registry Entry: " + $regKey.path + $regKey.key)
if($regKey.ContainsKey("delete")) {
return
}
If ([string]::IsNullOrWhiteSpace($regKey.path)) {
Write-Debug("Given Registry Path is null or empty.")
return
}
if((Test-Path -Path $regKey.path) -eq $false) {
Write-Debug ("Registry Entry does not exist anymore.")
return
}
if(($regKey.key -eq "")) {
Write-Debug ("Deleting " + $regKey.path)
Remove-Item -Path $regKey.path -Force
return
}
if ($regKey.key -ne "") {
Write-Debug ("Deleting Key " + $regKey.key + " at Path " + $regKey.path)
Remove-ItemProperty -Path $regKey.path -Name $regKey.key -Force -ErrorAction SilentlyContinue
return
}
If (([string]::IsNullOrWhiteSpace((Get-Item -Path $regKey.path | Get-ItemProperty))) -And ([string]::IsNullOrWhiteSpace((Get-ChildItem -Path $regKey.path)))) {
Write-Debug ("Deleting orphaned key " + $regKey.path)
Remove-Item -Path $regKey.path
return
}
}
# Deletes a file, if it exists
function DeleteFile ($pathToFile) {
Write-Debug ("Checking " + $pathToFile)
if(Test-Path $pathToFile) {
Write-Debug ("Deleting " + $pathToFile)
Remove-Item $pathToFile -Force
}
}
# Packaging functions
function CreateFileList ($packagePaths, $targetPath) {
Remove-Item ($targetPath + ".txt") -ErrorAction SilentlyContinue
Foreach ($path in $packagePaths) {
#Add-Content -Path ($targetPath + ".txt") -Value (Get-ChildItem -Path "$path" -Recurse -Name) -Force
Add-Content -Path ($targetPath + ".txt") -Value ((Get-Item -Path "$path").Name) -Force
}
}
function CreateDataArchive ($packagePaths, $targetPath) {
# This cmdlet does not include hidden files/folders https://github.com/PowerShell/Microsoft.PowerShell.Archive/issues/66
Compress-Archive $packagePaths $targetPath -CompressionLevel Optimal -Force
}
function CreateDataArchiveAndFileList ($packagePaths, $targetPath) {
if ((Test-Path $targetPath) -eq $false ) {
New-Item $targetPath -Force
Remove-Item $targetPath -Force
}
CreateDataArchive $packagePaths $targetPath
CreateFileList $packagePaths $targetPath
}
<#
.SYNOPSIS
Reduces the nupkg package file by deleting big binaries from the file.
.DESCRIPTION
Reduces the nupkg package file by deleting all files from the .nupkg file that are not necessary anymore like installer files or 7z binaries.
It keeps the following files and folders:
/package/
/tools/
_rels
*.nuspec
[Content_Types].xml
The rest will be removed from the nupkg file.
.NOTES
Comment added because reviewer asked to do so.
#>
#
function ReducePackageSize () {
.$env:ChocolateyInstall\tools\7z.exe d ($env:ChocolateyPackageFolder + "\" + $env:ChocolateyPackageName + ".nupkg") * -r -xr!package -xr!tools -xr!_rels -x!"*.nuspec" -x!"[Content_Types].xml"
}
<#
.SYNOPSIS
Which installation steps are actually necessary for the given OS and package parameters?
.DESCRIPTION
Checks the current OS bitness and the given package parameters and marks all steps from the chocolateyvariables file to be actually executed by setting their 'execute' bit.
.PARAMETER objectsList
A list of objects with a 'validpp' key and a 'bit' key from the chocolateyvariables.ps1 file.
.NOTES
Comment added because reviewer asked to do so.
#>
function DetermineExecutionOfAllObjects ($objectsList) {
Foreach($object in $objectsList) {
$object.Add('execute', $false)
$bitStatus = ($object.bit -eq $null) -Or ($object.bit -Contains $osBitness)
$ppIndependent = (($object.validpp -eq $null) -Or ($object.validpp -Like "Always"))
Write-Debug ("ppindependent: " + $ppIndependent)
Write-Debug ("bitStatus: " + $bitStatus)
Foreach($packageParameter in $object.validpp) {
Write-Debug ("Status of evaluated package parameter:" + $packageParameter)
if((Test-Path variable:pp.packageParameter) -eq $true) {
Write-Debug $pp[$packageParameter]
Write-Debug ($pp[$packageParameter] -eq $false)
}
if(($pp[$packageParameter] -eq $false) -And $bitStatus) {
$object.execute = $true
}
}
if($ppIndependent -And $bitStatus) {
$object.execute = $true
}
If ($object.ContainsKey("dropIfNull")) {
Write-Debug ("Object $object contains a dropIfNull!")
Foreach ($variableToCheck in $object.dropIfNull) {
If ([string]::IsNullOrWhiteSpace($variableToCheck)) {
Write-Debug ("Dependent variable is NULL")
$object.execute = $false
} else {
Write-Debug ("Dependent variable is $variableToCheck")
}
}
}
}
}
<#
.SYNOPSIS
Create the protocol file for the uninstallation
.DESCRIPTION
Writes a list of files that have been extracted from zip files embedded in this package. Is empty if no zip files have been embedded.
.NOTES
Comment added because reviewer asked to do so.
#>
function CreateUninstallFile () {
# Create empty uninstall file
Out-File -FilePath ($env:ChocolateyPackageFolder + "\uninstall.txt")
}
# Comments to this script have been added upon request by the chocolatey community reviewer
$ErrorActionPreference = 'Stop';
$toolsDir = "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"
$unzPath = "${env:TEMP}"
$osBitness = Get-ProcessorBits
if(Test-Path Env:\ChocolateyPackageFolder) {
. $env:ChocolateyPackageFolder\tools\chocolateyfunctions.ps1
. $env:ChocolateyPackageFolder\tools\chocolateyvariables.ps1
} else {
. ((Get-Item -Path ".\" -Verbose).FullName + "\tools\chocolateyfunctions.ps1")
. ((Get-Item -Path ".\" -Verbose).FullName + "\tools\chocolateyvariables.ps1")
}
# Get default values that may or may not be already on the machein
GetDefaultValues
$pp = Get-PackageParameters
# Audio plugins can come in various formats for multiple platforms, all contained in one single installer with different control schemes at the CLI (if available).
# With the package parameters below it is possible for the user to have a single unified interface for all audio plugin packages I create.
# If the package parameter is set here and an equivalent installation action is found in the chocovariables.ps1 with the 'validpp' key being equal to the
# package parameter, the default behaviour of the package/installer can be changed.
# Not all possible package parameters here actually do something as this depends on the specific package/software vendor. If a package parameter either does
# not exist below or does not exist in a 'validpp'-key in the chocolateyvariables.ps1, it will be ignored and have no effect.
if ($pp["NoVst2x86"] -eq $null -or $pp["NoVst2x86"] -eq '') { $pp["NoVst2x86"] = $false }
if ($pp["NoVst2x64"] -eq $null -or $pp["NoVst2x64"] -eq '') { if($osBitness -eq 64) { $pp["NoVst2x64"] = $false }}
if ($pp["NoVst3x86"] -eq $null -or $pp["NoVst3x86"] -eq '') { $pp["NoVst3x86"] = $false }
if ($pp["NoVst3x64"] -eq $null -or $pp["NoVst3x64"] -eq '') { if($osBitness -eq 64) { $pp["NoVst3x64"] = $false }}
if ($pp["NoAaxx86"] -eq $null -or $pp["NoAaxx86"] -eq '') { $pp["NoAaxx86"] = $false }
if ($pp["NoAaxx64"] -eq $null -or $pp["NoAaxx64"] -eq '') { if($osBitness -eq 64) { $pp["NoAaxx64"] = $false }}
if ($pp["NoRtas"] -eq $null -or $pp["NoRtas"] -eq '') { $pp["NoRtas"] = $false }
if ($pp["NoPresets"] -eq $null -or $pp["NoPresets"] -eq '') { $pp["NoPresets"] = $false }
if ($pp["NoNks"] -eq $null -or $pp["NoNks"] -eq '') { $pp["NoNks"] = $false }
if ($pp["NoUserFolder"] -eq $null -or $pp["NoUserFolder"] -eq '') { $pp["NoUserFolder"] = $false }
if ($pp["NoShortcuts"] -eq $null -or $pp["NoShortcuts"] -eq '') { $pp["NoShortcuts"] = $false }
if ($pp["InstallerPath"] -eq $null -or $pp["InstallerPath"] -eq '') { $fileLocation = "$unzPath\$unzInstPath"; $pp["InstallerPath"]=$false } else { $fileLocation = $pp["InstallerPath"] }
if ($pp["CompanyPath"] -eq $null -or $pp["CompanyPath"] -eq '') { $pp["CompanyPath"] = $false } else { $standardCompanyPath=$global:companyPath; $global:companyPath = $pp["CompanyPath"] }
if ($pp["LibraryPath"] -eq $null -or $pp["LibraryPath"] -eq '') { $pp["LibraryPath"] = $false } else { $libraryPath = $pp["LibraryPath"] }
if ($pp["UserFolderPath"] -eq $null -or $pp["UserFolderPath"] -eq ''){ } else { $userFolderPath = $pp["UserFolderPath"]}
if ($pp["Vst2Path"] -eq $null -or $pp["Vst2Path"] -eq '') { } else { $global:vst2Path = $pp["Vst2Path"] }
if ($pp["Vst2x86Path"] -eq $null -or $pp["Vst2x86Path"] -eq '') { } else { $global:vst2x86_64Path = $pp["Vst2x86Path"] }
if ($pp["Vst3Path"] -eq $null -or $pp["Vst3Path"] -eq '') { } else { $vst3Path = $pp["Vst3Path"] }
if ($pp["Vst3x86Path"] -eq $null -or $pp["Vst3x86Path"] -eq '') { } else { $vst3x86_64Path = $pp["Vst3x86Path"] }
# Create/Overwrite bit-aware variables. These variables are used to access different paths across different OS bitnesses in a uniform way.
CreateBitAwareVariables
# Create all the necessary information for the setup after package parameters changed the packages default values.
# This includes registry keys to write, shortcuts to create or additional installer parameters to parse.
# Begin with handling the components of the installer so the settings can be written to registry afterwards
CreateInstallerObjects
CreatePackageParametersObjects
DetermineExecutionOfAllObjects($installerComponentsList)
Foreach ($item in $installerComponentsList) { CreateInstallerParameters($item) }
# Now that the package parameters (from possibly previous installations) have been evaluated
# as well as the installer components, we pick default values for any settings without overrides
PickDefaultValuesFromSystem
# Decision to use previous values or package parameters have been made. Whatever it is, finalize and append to installer call.
Foreach ($item in $packageParametersObjectsList) { HandlePackageArgs($item) }
# Installer components are now fully evaluated and can be written to registry in case some installers don't save these settings on their own (needed for upgrades)
CreateRegistryObjects
CreateRegistryFileObjects
CreateShortcutObjects
CreateSymlinkObjects
CreatePackageRessourcePathObjects
CreateTxtFileObjects
# These functions are necessary for embedded installer and other embedded files, only. Nothing actually happens if
# this package doesn't include something in the 'bin' folder.
ReducePackageSize
CreateUninstallFile
# For each possible install action defined in chocolateyvariables.ps1 that can be customized via package parameter or depends on the OS bitness,
# it is determined if it is ultimately executed or not. Up until here including all DetermineExecutionOfAllObjects calls, nothing has actually
# happened on the system.
$objectsLists = $regKeys, $regKeyFileObjects, $shortcuts, $symlinks, $PackageRessourcePathList, $PackageNewFiles
Foreach($objectsList in $objectsLists) { DetermineExecutionOfAllObjects($objectsList) }
# Each possible install action defined in chocolateyvariables.ps1 with the execute-bit set to true is being executed by each corresponding function.
Foreach ($item in $regKeys) { CreateRegKey($item) }
Foreach ($item in $regKeyFileObjects) { CreateRegKeyFromFile($item) }
Foreach ($item in $shortcuts) { CreateShortcut($item) }
Foreach ($item in $symlinks) { CreateSymlink ($item) }
Foreach ($item in $PackageRessourcePathList) { CopyPackageRessources($item) }
Foreach ($item in $PackageRessourcePathList) { WriteUninstallData($item) }
Foreach ($item in $PackageRessourcePathList) { RemoveTemporaryFiles($item) }
Foreach ($item in $PackageNewFiles) { CreateTxtFiles($item) }
Foreach ($item in $packageParametersObjectsList) { RunInstallerWithPackageParametersObject($item) }
Foreach ($item in $packageParametersObjectsList) { RemoveInstallerObjects($item) }
$ErrorActionPreference = 'Stop';
$installerType = 'EXE'
. $env:ChocolateyPackageFolder\tools\chocolateyfunctions.ps1
. $env:ChocolateyPackageFolder\tools\chocolateyvariables.ps1
$silentArgs = '/qn /norestart'
$validExitCodes = @(0, 3010, 1605, 1614, 1641)
if ($installerType -ne 'MSI') {
$silentArgs = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-' # Inno Setup
$validExitCodes = @(0)
}
$uninstalled = $false
[array]$key = Get-UninstallRegistryKey -SoftwareName $softwareName
if ($key.Count -eq 1) {
$key | % {
$file = "$($_.UninstallString)"
if ($installerType -eq 'MSI') {
$silentArgs = "$($_.PSChildName) $silentArgs"
$file = ''
}
Uninstall-ChocolateyPackage -PackageName $packageName `
-FileType $installerType `
-SilentArgs "$silentArgs" `
-ValidExitCodes $validExitCodes `
-File "$file"
}
} elseif ($key.Count -eq 0) {
Write-Warning "$packageName has already been uninstalled by other means."
} elseif ($key.Count -gt 1) {
Write-Warning "$key.Count matches found!"
Write-Warning "To prevent accidental data loss, no programs will be uninstalled."
Write-Warning "Please alert package maintainer the following keys were matched:"
$key | % {Write-Warning "- $_.DisplayName"}
}
CreateRegistryObjects
Foreach ($item in $regKeys) { DeleteRegKeyFromObjects($item) }
$packageName = 'Drumformer'
$company = 'Voxengo'
$softwareName = "$company $packageName"
$url32 = 'https://www.voxengo.com/files/VoxengoDrumformer_110_Win32_64_VST_VST3_AAX_setup.exe'
$releases = 'https://www.voxengo.com/product/drumformer/'
$checksum32 = 'c934833ea0c86482e590a555491357ddc194a710c38ad2e92b45524902e61ed7'
$global:companyPath = "${env:PROGRAMFILES}\$company"
$global:vst2Path = "${env:PROGRAMFILES}\Steinberg\VSTPlugins\$company"
$global:vst2x86_64Path = "${env:ProgramFiles(x86)}\Steinberg\VSTPlugins\$company"
function CreateRegistryObjects () {
# The installer does not have an option for custom paths so we need to create the registry entry before
$global:regKeys =
@{'path'="HKLM:\Software\Voxengo\AudioPluginsInstall"; 'key'="DirVST2_64"; 'value'="$global:vst2Path"; 'bit'=64; 'validpp'="NoVst2x64"},
@{'path'="HKLM:\Software\Voxengo\AudioPluginsInstall"; 'key'="DirVST2_32"; 'value'="$global:vst2x86BitAware"; 'bit'=64,32; 'validpp'="NoVst2x86"}
}
function CreateRegistryFileObjects () { $global:regKeyFileObjects }
function CreateShortcutObjects () { $global:shortcuts }
function CreateSymlinkObjects () {
if($pp["CompanyPath"] -ne $false) {
$global:linkUserDataSupport = @{'linkPath'="$standardCompanyPath"; 'linkName'=""; 'destPath'=$global:companyPath; 'bit'=64,32; 'validpp'="NoVst2x64", "NoVst2x86", "NoVst3x64", "NoVst3x86", "NoAaxx86", "NoAaxx64"}
$global:symlinks = $linkUserDataSupport
} else {
$global:symlinks
}
}
function CreateInstallerObjects () {
$global:installerComponentsList =
@{'value'="shortcuts"; 'bit'=64,32; 'validpp'="NoShortcuts"},
@{'value'="guides"; 'bit'=64,32; 'validpp'="NoVst2x64", "NoVst2x86", "NoVst3x64", "NoVst3x86", "NoAaxx86", "NoAaxx64"},
@{'value'="vst2_32"; 'bit'=64,32; 'validpp'="NoVst2x86"},
@{'value'="vst2_64"; 'bit'=64; 'validpp'="NoVst2x64"},
@{'value'="vst3_32"; 'bit'=64,32; 'validpp'="NoVst3x86"},
@{'value'="vst3_64"; 'bit'=64; 'validpp'="NoVst3x64"},
@{'value'="aax_32"; 'bit'=64,32; 'validpp'="NoAaxx86"},
@{'value'="aax_64"; 'bit'=64; 'validpp'="NoAaxx64"}
}
function CreatePackageRessourcePathObjects () { $global:PackageRessourcePathList }
function CreateTxtFileObjects () { $global:PackageNewFiles }
function CreatePackageParametersObjects () {
$global:packageArgs = @{
packageName = $packageName
unzipLocation = $unzPath
fileType = 'exe'
url = $url32
url64bit = $url32
softwareName = "$company $packageName*" #part or all of the Display Name as you see it in Programs and Features. It should be enough to be unique
checksum = $checksum32
checksumType = 'sha256' #default is md5, can also be sha1, sha256 or sha512
silentArgs = '/VERYSILENT /SUPPRESSMSGBOXES /NORESTART /SP-' # Inno Setup
}
$global:packageParametersObjectsList = $packageArgs
}
Log in or click on link to see number of positives.
- voxengo-drumformer.1.10.nupkg (37f9af0391cd) - ## / 62
- VoxengoDrumformer_110_Win32_64_VST_VST3_AAX_setup.exe (c934833ea0c8) - ## / 68
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.
Add to Builder | Version | Downloads | Last Updated | Status |
---|---|---|---|---|
Voxengo Drumformer (Install) 1.10 | 136 | Monday, August 2, 2021 | Approved | |
Voxengo Drumformer (Install) 1.9 | 160 | Wednesday, July 22, 2020 | Approved | |
Voxengo Drumformer (Install) 1.8 | 237 | Tuesday, January 7, 2020 | Approved | |
Voxengo Drumformer (Install) 1.7 | 140 | Thursday, October 3, 2019 | Approved | |
Voxengo Drumformer (Install) 1.5 | 176 | Thursday, January 3, 2019 | Approved |
2002-2021 Aleksey Vaneev
-
- chocolatey-core.extension (≥ 1.1.0)
Ground Rules:
- This discussion is only about Voxengo Drumformer (Install) and the Voxengo Drumformer (Install) 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 Voxengo Drumformer (Install), 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.