This documentation is for Octopus Deploy Version 2018.12. View other versions

Custom Installation Directory

Last updated

The Custom Installation Directory feature is one of the configuration features you can enable as you define the steps in your deployment process.

You can specify a custom installation directory for package and IIS steps. The custom installation directory feature deploys your package to a specific location on the target server. This feature helps when you are using an application that requires your files to be in specific locations, such as a Content Management System (CMS).

Only use the custom installation directory feature when you really need it.

The standard convention for deploying packages eliminates problems caused by file locks and stale files being left in the deployment folder. It also provides smoother deployments and less downtime for Windows Services and Web Applications, so before you configure a custom installation directory, review the package deployment convention and package deployment feature ordering to be certain that you really need to configure a custom installation directory.

Add a Custom Installation Directory

  1. From your Package Deploy or IIS step, click the Configure Features link.
  2. Check the Custom Installation Directory checkbox and click Ok.

Custom Installation Directory option

When you return to your deployment process, you will see the Custom Install Directory option has been added to the Features section of the deployment process.

  1. Add the step details:
  • Enter a name for the step.
  • Select the targets where the step should run.
  • Select the package feed where the package will be available.
  • Enter the package ID for the package to be deployed.
  1. Enter the path for the custom installation directory, or you can insert a variable if you have defined the path as a variable.

Defining a variable with the directory path, means you can scope different values to different environments. For instance:

Variable Name Value Scope
CustomInstallDirectory \path\to\test\directory\ Test
CustomInstallDirectory \path\to\production\directory\ Production

Read more about variables.

  1. If you would like to remove existing files from the custom installation directory before your deployed files are copied to it, check the Purge checkbox.
  2. If there are files you would like to exclude from the purge, add the files and directories you want to keep to the Exclude from purge list. This feature was introduced in Octopus 3.13.8.

The Exclude from purge list must be a newline-separated list of file or directory names, relative to the installation directory. To exclude an entire directory specify it by name without a wildcard. Extended wildcard syntax is supported. For instance:





  1. Add any conditions you need to specify for the step, and then click SAVE.

This will save and display the step you've just created. From here you can use the project overview menu to continue defining your deployment process, or click CREATE RELEASE to create a release and deploy your application.

Packages deployed to a custom installation directory are deployed in the same way as other package deploy steps. Read about how packages are deployed for more information.