Downloads of v 0.14.0:


Last Update:

20 Mar 2016

Package Maintainer(s):

Software Author(s):

  • HashiCorp
  • Inc.


consul-template consul

consul-template (Install)

0.14.0 | Updated: 20 Mar 2016



Downloads of v 0.14.0:



Software Author(s):

  • HashiCorp
  • Inc.

consul-template (Install) 0.14.0

All Checks are Passing

2 Passing Test

Validation Testing Passed

Verification Testing Passed


To install consul-template (Install), run the following command from the command line or from PowerShell:


To upgrade consul-template (Install), run the following command from the command line or from PowerShell:


To uninstall consul-template (Install), run the following command from the command line or from PowerShell:


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

1. Ensure you are set for organizational deployment

Please see the organizational deployment guide

  • 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 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

3. Enter your internal repository url

(this should look similar to

4. Choose your deployment method:

choco upgrade consul-template -y --source="'STEP 3 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 consul-template -y --source="'STEP 3 URL'"

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

Exit $exitCode

- name: Ensure consul-template installed
    name: consul-template
    state: present
    version: 0.14.0
    source: STEP 3 URL

See docs at

Coming early 2020! Central Managment Reporting available now! More information...

chocolatey_package 'consul-template' do
  action    :install
  version  '0.14.0'
  source   'STEP 3 URL'

See docs at

    Name: consul-template,
    Version: 0.14.0,
    Source: STEP 3 URL

Requires Otter Chocolatey Extension. See docs at

cChocoPackageInstaller consul-template
   Name     = 'consul-template'
   Ensure   = 'Present'
   Version  = '0.14.0'
   Source   = 'STEP 3 URL'

Requires cChoco DSC Resource. See docs at

package { 'consul-template':
  provider => 'chocolatey',
  ensure   => '0.14.0',
  source   => 'STEP 3 URL',

Requires Puppet Chocolatey Provider module. See docs at

salt '*' chocolatey.install consul-template version="0.14.0" source="STEP 3 URL"

See docs at

5. If applicable - Chocolatey configuration/installation

See infrastructure management matrix for Chocolatey configuration elements and examples.

This package was approved by moderator ferventcoder on 22 Mar 2016.


This project provides a convenient way to populate values from Consul into the filesystem using the consul-template daemon.
The daemon consul-template queries a Consul instance and updates any number of specified templates on the filesystem. As an added bonus, consul-template can optionally run arbitrary commands when the update process completes. See the Examples section for some scenarios where this functionality might prove useful.

md5: D01A56C88424F236687639A4D3DECCC7 | sha1: 432B3BBC54C5B373B0D9177A9AFE7A450835C9D0 | sha256: 2DBC3D130356F9A52C2A0E1C045FC109BF06FE6692F0ECE94EF1DFB894A37DCA | sha512: 6F269CA14E2C5691AE0237E8FE4A22DB4E32651741E6EA615C3256C140659929345AB6B3E76986BF8C3A8347878F4F6EA0BB8A2DB78F4FDCC71E904D7D017DD9
md5: 576B3061AE294A9140F483E7055EC047 | sha1: F5751BEEAB8AB168B391578917171582CFC59B6C | sha256: 48DCCD0134DF43B6EBDCEDDC4185E8C25FEA169E43FEECCB7CA4E42CE299BC2C | sha512: 5112C688C6DF445898EC9D18BE435411E3BA2FF0DEB18C69B44CF8CD35BAFCCCCD17401603A1D481F5513FD5AEACAC426D15EC6C9D3BC1DF9E1FAA713843E2BC
$binariesPath = $(Join-Path (Split-Path -parent $MyInvocation.MyCommand.Definition) "..\binaries\")
$toolsPath = (Split-Path -Parent $MyInvocation.MyCommand.Definition)
$wrapperExe = "$env:ChocolateyInstall\bin\nssm.exe"
# consul-template related variables
${consul-templateVersion} = '0.14.0'
$sourcePath = if (Get-ProcessorBits 32) {
  $(Join-Path $binariesPath "consul-template_$(${consul-templateVersion})")
} else {
  $(Join-Path $binariesPath "consul-template_$(${consul-templateVersion})")

# Unzip and move consul-template
Get-ChocolateyUnzip  $sourcePath "$(Split-Path -parent $MyInvocation.MyCommand.Definition)"

Write-Host "Creating $env:PROGRAMDATA\consul-template\logs"
New-Item -ItemType directory -Path "$env:PROGRAMDATA\consul-template\logs" -ErrorAction SilentlyContinue | Out-Null
Write-Host "Creating $env:PROGRAMDATA\consul-template\config"
New-Item -ItemType directory -Path "$env:PROGRAMDATA\consul-template\config" -ErrorAction SilentlyContinue | Out-Null

# Create event log source
# User -Force to avoid "A key at this path already exists" exception. Overwrite not an issue since key is not further modified
$registryPath = 'HKLM:\SYSTEM\CurrentControlSet\services\eventlog\Application'
New-Item -Path $registryPath -Name consul-template -Force | Out-Null
# Set EventMessageFile value
Set-ItemProperty $registryPath\consul-template EventMessageFile "C:\Windows\Microsoft.NET\Framework64\v2.0.50727\EventLogMessages.dll" | Out-Null

# # Set up task scheduler for log rotation
# $logrotate = '%SYSTEMROOT%\System32\forfiles.exe /p \"%PROGRAMDATA%\consul-template\logs\" /s /m *.* /c \"cmd /c Del @path\" /d -7'
# SchTasks.exe /Create /SC DAILY /TN ""consul-templateLogrotate"" /TR ""$($logrotate)"" /ST 09:00 /F | Out-Null

# Set up task scheduler for log rotation. Only works for Powershell 4 or Server 2012R2 so this block can replace
# using SchTasks.exe for registering services once machines have retired the older version of PS or upgraded to 2012R2
#$command = '$now = Get-Date; dir "$env:PROGRAMDATA\consul-template\logs" | where {$_.LastWriteTime -le $now.AddDays(-7)} | del -whatif'
#$action = New-ScheduledTaskAction -Execute 'Powershell.exe' -Argument "-NoProfile -WindowStyle Hidden -command $($command)"
#$trigger = New-ScheduledTaskTrigger -Daily -At 9am
#Register-ScheduledTask -Action $action -Trigger $trigger -TaskName "consul-templateLogrotate" -Description "Log rotation for consul-template"

#Uninstall service if it already exists. Stops the service first if it's running
$service = Get-Service "consul-template" -ErrorAction SilentlyContinue
if ($service) {
  Write-Host "Uninstalling existing service"
  if ($service.Status -eq "Running") {
    Write-Host "Stopping consul-template process ..."
    net stop consul-template | Out-Null

  $service = Get-WmiObject -Class Win32_Service -Filter "Name='consul-template'"
  $service.delete() | Out-Null

Write-Host "Installing the consul-template service"
# Install the service
& $wrapperExe install consul-template $(Join-Path $toolsPath "consul-template.exe") -config=%PROGRAMDATA%\consul-template\config | Out-Null
& $wrapperExe set consul-template AppEnvironmentExtra GOMAXPROCS=$env:NUMBER_OF_PROCESSORS | Out-Null
& $wrapperExe set consul-template ObjectName NetworkService | Out-Null
& $wrapperExe set consul-template AppStdout "$env:PROGRAMDATA\consul-template\logs\consul-template-output.log" | Out-Null
& $wrapperExe set consul-template AppStderr "$env:PROGRAMDATA\consul-template\logs\consul-template-error.log" | Out-Null
# # NSSM built-in log rotation
# & $wrapperExe set consul-template AppRotateBytes 10485760 | Out-Null
# & $wrapperExe set consul-template AppRotateFiles 1 | Out-Null
# & $wrapperExe set consul-template AppRotateOnline 1 | Out-Null

# Restart service on failure natively via Windows sc. There is a memory leak if service restart is performed via NSSM
# The NSSM configuration will set the default behavior of NSSM to stop the service if
# consul-template fails (for example, unable to resolve cluster) and end the nssm.exe and consul-template.exe process.
# The sc configuration will set Recovery under the consul-template service properties such that a new instance will be started on failure,
# spawning new nssm.exe and consul-template.exe processes. In short, nothing changed from a functionality perspective (the service will
# still attempt to restart on failure) but this method kills the nssm.exe process thus avoiding memory hog.
& $wrapperExe set consul-template AppExit Default Exit | Out-Null
cmd.exe /c "sc failure consul-template reset= 0 actions= restart/60000" | Out-Null
$service = Get-Service "consul-template" -ErrorAction SilentlyContinue
if ($service) {
  if ($service.Status -eq "Running") {
    Write-Host "Stopping consul-template process ..."
    net stop consul-template | Out-Null
  $service = Get-WmiObject -Class Win32_Service -Filter "Name='consul-template'"
  $service.delete() | Out-Null
SchTasks.exe /Delete /F /TN "consul-templateLogrotate" 2>&1 | Out-Null
Write-Host "Removing C:\ProgramData\consul-template\ ..."
takeown /f "C:\ProgramData\consul-template\" /a /r /d Y | Out-Null
icacls "C:\ProgramData\consul-template" /grant administrators:F /t | Out-Null
Remove-Item -Path "C:\ProgramData\consul-template\" -Force -Recurse -ErrorAction SilentlyContinue | Out-Null
## Summary
How do I create packages? See

If you are submitting packages to the community feed (
always try to ensure you have read, understood and adhere to the create
packages wiki link above.

## Automatic Packages?
Consider making this package an automatic package, for the best 
maintainability over time. Read up at

## Shim Generation
Any executables you include in the package or download (but don't call 
install against using the built-in functions) will be automatically shimmed.

This means those executables will automatically be included on the path.
Shim generation runs whether the package is self-contained or uses automation 

By default, these are considered console applications. 

If the application is a GUI, you should create an empty file next to the exe 
named 'name.exe.gui' e.g. 'bob.exe' would need a file named 'bob.exe.gui'.

If you want to ignore the executable, create an empty file next to the exe 
named 'name.exe.ignore' e.g. 'bob.exe' would need a file named 

## Self-Contained? 
If you have a self-contained package, you can remove the automation scripts 
entirely and just include the executables, they will automatically get shimmed, 
which puts them on the path. Ensure you have the legal right to distribute 
the application though. See 

You should read up on the Shim Generation section to familiarize yourself 
on what to do with GUI applications and/or ignoring shims.

## Automation Scripts
You have a powerful use of Chocolatey, as you are using PowerShell. So you
can do just about anything you need. Choco has some very handy built-in 
functions that you can use, these are sometimes called the helpers.

### Built-In Functions

A note about a couple:
* Get-BinRoot - this is a horribly named function that doesn't do what new folks think it does. It gets you the 'tools' root, which by default is set to 'c:\tools', not the chocolateyInstall bin folder. 
* Install-BinFile - used for non-exe files - executables are automatically shimmed...
* Uninstall-BinFile - used for non-exe files - executables are automatically shimmed

### Getting package specific information
Use the package parameters pattern - see

### Need to mount an ISO?

### Environment Variables
Chocolatey makes a number of environment variables available (You can access any of these with $env:TheVariableNameBelow):

 * TEMP = Overridden to the CacheLocation, but may be the same as the original TEMP folder
 * ChocolateyInstall = Top level folder where Chocolatey is installed
 * chocolateyPackageName = The name of the package, equivalent to the id in the nuspec (0.9.9+)
 * chocolateyPackageVersion = The version of the package, equivalent to the version in the nuspec (0.9.9+)
 * chocolateyPackageFolder = The top level location of the package folder

#### Advanced Environment Variables
The following are more advanced settings:

 * chocolateyPackageParameters = (
 * CHOCOLATEY_VERSION = The version of Choco you normally see. Use if you are 'lighting' things up based on choco version. (0.9.9+)
    - Otherwise take a dependency on the specific version you need. 
 * chocolateyForceX86 = If available and set to 'true', then user has requested 32bit version. (0.9.9+)
    - Automatically handled in built in Choco functions. 
 * OS_PLATFORM = Like Windows, OSX, Linux. (0.9.9+)
 * OS_VERSION = The version of OS, like 6.1 something something for Windows. (0.9.9+)
 * OS_NAME = The reported name of the OS. (0.9.9+)
 * IS_PROCESSELEVATED = Is the process elevated? (0.9.9+)
#### Experimental Environment Variables
The following are experimental or use not recommended:

 * OS_IS64BIT = This may not return correctly - it may depend on the process the app is running under (0.9.9+)
 * CHOCOLATEY_VERSION_PRODUCT = the version of Choco that may match CHOCOLATEY_VERSION but may be different (0.9.9+)
    - it's based on git describe
 * IS_ADMIN = Is the user an administrator? But doesn't tell you if the process is elevated. (0.9.9+)
 * chocolateyInstallOverride = Not for use in package automation scripts. (0.9.9+)
 * chocolateyInstallArguments = the installer arguments meant for the native installer. You should use chocolateyPackageParameters intead. (0.9.9+)

Log in or click on link to see number of positives.

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

Chocolatey Pro provides runtime protection from possible malware.

Version Downloads Last Updated Status

Discussion for the consul-template (Install) Package

Ground Rules:

  • This discussion is only about consul-template (Install) and the consul-template (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 consul-template (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.
comments powered by Disqus