Path | Documentation and Support

Set the file paths that Octopus will use for storage

path options

Usage: octopus.server path [<options>]

Where [<options>] is any of:

      --instance=VALUE       Name of the instance to use
      --config=VALUE         Configuration file to use
      --skipDatabaseCompatibilityCheck
                             Skips the database compatibility check
      --skipDatabaseSchemaUpgradeCheck
                             Skips the database schema upgrade checks. Use
                               with caution
      --cacheDirectory=VALUE Directory to use for temporary files and cachin-
                               g, e.g. downloaded packages. The data in this
                               directory can be removed when the Octopus Server
                               is not running. This directory should not be
                               shared between nodes.
      --clusterShared=VALUE  Set the root path where shared files will be
                               stored for Octopus clusters. Set to blank to
                               clear it, so that relative paths resolve under
                               the Home directory again.
      --executionsClusterShared=VALUE
                             Set the root path where transient execution
                               files will be stored for Octopus clusters.

                               When configured, Octopus stores transient
                               execution data (DataStreams, PackageCache, and
                               DataBus) here instead of in the Cluster Shared
                               directory. This data is generated during tasks
                               like deployments and runbooks and is not long-
                               lived. As with Cluster Shared, this path must
                               be on a shared volume accessible to all nodes
                               in the cluster.

                               Configuration is typically not required, as
                               Octopus automatically falls back to the
                               Cluster Shared directory or the Home directory
                               if no path is specified.

                               Note: Before changing this setting, ensure
                               that no tasks are running on the Octopus
                               Servers. Additionally, the previously used
                               directories (DataBus, DataStreams,
                               PackageCache) in the ClusterShared directory or
                               the Home directory will no longer be used and
                               can be manually deleted since they will not be
                               cleaned up automatically.

                               Set to blank to clear it, so that transient
                               execution data falls back to the Cluster
                               Shared or Home directory.
      --nugetRepository=VALUE
                             Set the package path for the built-in package
                               repository
      --artifacts=VALUE      Set the path where artifacts are stored
      --imports=VALUE        Set the path where imported zip files are stored
      --taskLogs=VALUE       Set the path where task logs are stored
      --eventExports=VALUE   Set the path where event audit logs are exported
      --telemetry=VALUE      Set the path where telemetry is stored

Or one of the common options:

      --help                 Show detailed help for this command

Basic examples

This example configures all paths (artifacts, task logs, packages, imports, and telemetry) to a network share:

octopus.server path --clusterShared \\OctoShared\OctopusData

octopus.server path --artifacts Artifacts
octopus.server path --taskLogs TaskLogs
octopus.server path --nugetRepository Packages
octopus.server path --imports Imports
octopus.server path --eventExports EventExports
octopus.server path --telemetry Telemetry

This example configures the paths for the different components individually:

octopus.server path --artifacts \\Octoshared\OctopusData\Artifacts
octopus.server path --taskLogs \\Octoshared\OctopusData\TaskLogs
octopus.server path --nugetRepository \\Octoshared\OctopusData\Packages
octopus.server path --imports \\Octoshared\OctopusData\Imports
octopus.server path --eventExports \\Octoshared\OctopusData\EventExports
octopus.server path --telemetry \\Octoshared\OctopusData\Telemetry

This example stores transient execution data, such as data streams for multi-node support for Polling Tentacles, on separate shared storage:

octopus.server path --executionsClusterShared \\OctoFastShared\OctopusExecutions

This example clears the executions cluster shared directory, so transient execution data is stored in the cluster shared directory again:

octopus.server path --executionsClusterShared=