Please enter search terms in the box below to search the docs.
Help us continuously improve
Please let us know if you have any feedback about this page.
Page updated on Saturday, September 17, 2022
- Introduction
Getting started
- Overview
- First Kubernetes deployment
Best Practices
- Best Practices
- Installation Guidelines
- Partition Octopus with Spaces
- Environments, Deployment Targets, and Target Tags
- Lifecycles and Environments
- Offload Work to Workers
- Projects and Project Groups Structure
- Variable Recommendations
- Step Templates and Script Modules
- Users, Roles, and Teams
- Deployment and Runbook Processes
- Releases and Deployments
- Notifications
- Ongoing Maintenance
- Configuring Microsoft DFS with Octopus Server
- Managing Octopus subscriptions
- Samples
Reference architectures
- Glossary
Infrastructure
- Overview
Deployment targets
- Deployment targets
Octopus Tentacle
- Octopus Tentacle
Windows Tentacle
- Windows Tentacle
Tentacle installation requirements
- Permissions required for the Tentacle Windows Service
- Running Tentacle under a specific user account
- Clustered Listening Tentacles
- Automating Tentacle installation
- Polling Tentacles over WebSockets
Azure virtual machines
- Azure virtual machines
- Installing the Tentacle via DSC in an ARM template
- Installing the Tentacle VM extension via the Azure Portal
- Installing the Tentacle VM extension via the classic Azure Portal
- Installing the Tentacle VM extension via PowerShell
- Installing the Tentacle VM extension via the Azure CLI
- Installing the Tentacle VM extension via an ARM template
- Tentacle VM extension configuration structure
- Diagnosing Tentacle VM extension issues
- Linux Tentacle
- Tentacle communication modes
- Octopus Tentacle in a Container
- Polling Tentacles over Standard HTTPS Port
- Troubleshooting Tentacles
- Amazon ECS cluster
Kubernetes cluster
- Offline package drop
- Cloud regions
- Cloud Target Discovery
Dynamic infrastructure
- Dynamic infrastructure
- Create AWS account command
- Create Azure Service Principal account command
- Create token account command
- Create username/password command
- Create Azure Web App target command
- Create Azure Service Fabric target command
- Create Azure Cloud Service target command
- Create Kubernetes Target Command
- New Octopus Target Command
- Remove Octopus Target Command
- Machine policies
- Proxy support
Environments
- Signing Keys
Packaging applications
- Overview
Create packages
Build server integration
Package repositories
Projects
- Overview
Deployment process
- Setting up projects and project groups
- Project recommendations
Steps
- Exporting and Importing Projects
- Community step templates
- Custom step templates
- Update step templates
Variables
- Variables
- Variable substitutions
- Variable filters
- System variables
- Output variables
- Prompted variables
- Sensitive variables
- Certificate variables
- Worker Pool variables
- Google cloud account variables
- Azure account variables
- AWS account variables
- Username and password account variables
- Tenant variables
- Library variable sets
Tenants
Coordinating multiple projects
Configuration as Code
- Configuration as Code
Converting projects to Git
- Configuration as Code reference
- Editing a project with version control enabled
- GitHub integration
- Creating and deploying releases on a version-controlled project
- Creating releases from a build server plugin on a version-controlled project
- Unsupported Configuration as Code Scenarios
- Moving version control
- OCL Syntax for Config as Code
Tenants
- Overview
- Tenant types
Tenant creation
- Tenant variables
- Tenant tags
- Tenant infrastructure
- Tenant lifecycles
- Tenant roles and security
Multi-tenant deployment guides
- Multi-tenant deployments FAQ
- Troubleshooting multi-tenant deployments
Deployments
- Overview
Google Cloud
Azure
.NET deployments
Certificates
- Certificates
- Add a certificate to Octopus
- Certificate chains
- Import certificate to Windows certificate store
- Import certificates into Tomcat
- Import certificates into WildFly and JBoss EAP
- Export a certificate
- Export a certificate to a Java KeyStore
- Replace a certificate
- Archive and delete certificates
- Troubleshooting invalid certificates
Databases
Node deployments
Custom scripts
- Custom scripts
- Run a script step
Scripts in packages
- Using variables in scripts
- Passing parameters to scripts
- Logging messages from scripts
- Error handling
- Output variables
- Raw scripting
- Azure CLI and PowerShell Scripts
- AWS CLI and PowerShell scripts
- Service Fabric PowerShell scripts
- PowerShell Core
Debugging PowerShell scripts
- Script modules
- HTML and JavaScript applications
- Bulk deployment creation
- Deployment freezes
Patterns and practices
Runbooks
- Overview
- Runbooks vs Deployments
- Runbooks permissions
- Runbook variables
- Runbooks publishing
- Scheduled runbook triggers
Runbooks examples
- Runbooks examples
Routine operations
Octopus REST API
- Overview
- Getting started with the Octopus REST API
- How to Create an API Key
Octopus Command Line (CLI)
- Octopus Command Line (CLI)
- octopus
- octopus account
- octopus account aws
- octopus account aws create
- octopus account aws list
- octopus account azure
- octopus account azure create
- octopus account azure list
- octopus account azure-oidc
- octopus account azure-oidc create
- octopus account azure-oidc list
- octopus account create
- octopus account delete
- octopus account gcp
- octopus account gcp create
- octopus account gcp list
- octopus account list
- octopus account ssh
- octopus account ssh create
- octopus account ssh list
- octopus account token
- octopus account token create
- octopus account token list
- octopus account username
- octopus account username create
- octopus account username list
- octopus config
- octopus config get
- octopus config list
- octopus config set
- octopus deployment-target
- octopus deployment-target azure-web-app
- octopus deployment-target azure-web-app create
- octopus deployment-target azure-web-app list
- octopus deployment-target azure-web-app view
- octopus deployment-target cloud-region
- octopus deployment-target cloud-region create
- octopus deployment-target cloud-region list
- octopus deployment-target cloud-region view
- octopus deployment-target delete
- octopus deployment-target kubernetes
- octopus deployment-target kubernetes create
- octopus deployment-target kubernetes list
- octopus deployment-target kubernetes view
- octopus deployment-target list
- octopus deployment-target listening-tentacle
- octopus deployment-target listening-tentacle create
- octopus deployment-target listening-tentacle list
- octopus deployment-target listening-tentacle view
- octopus deployment-target polling-tentacle
- octopus deployment-target polling-tentacle list
- octopus deployment-target polling-tentacle view
- octopus deployment-target ssh
- octopus deployment-target ssh create
- octopus deployment-target ssh list
- octopus deployment-target ssh view
- octopus deployment-target view
- octopus environment
- octopus environment delete
- octopus environment list
- octopus login
- octopus logout
- octopus package
- octopus package list
- octopus package nuget
- octopus package nuget create
- octopus package upload
- octopus package versions
- octopus package zip
- octopus package zip create
- octopus project
- octopus project branch
- octopus project branch create
- octopus project branch list
- octopus project clone
- octopus project connect
- octopus project convert
- octopus project create
- octopus project delete
- octopus project disconnect
- octopus project list
- octopus project variables
- octopus project variables create
- octopus project variables delete
- octopus project variables exclude
- octopus project variables include
- octopus project variables list
- octopus project variables update
- octopus project variables view
- octopus project view
- octopus project-group
- octopus project-group create
- octopus project-group delete
- octopus project-group list
- octopus project-group view
- octopus release
- octopus release create
- octopus release delete
- octopus release deploy
- octopus release list
- octopus runbook
- octopus runbook list
- octopus runbook run
- octopus space
- octopus space create
- octopus space delete
- octopus space list
- octopus space view
- octopus task
- octopus task wait
- octopus tenant
- octopus tenant clone
- octopus tenant connect
- octopus tenant create
- octopus tenant delete
- octopus tenant disconnect
- octopus tenant list
- octopus tenant tag
- octopus tenant variables
- octopus tenant variables list
- octopus tenant variables update
- octopus tenant view
- octopus user
- octopus user delete
- octopus user list
- octopus worker
- octopus worker delete
- octopus worker list
- octopus worker listening-tentacle
- octopus worker listening-tentacle create
- octopus worker listening-tentacle list
- octopus worker listening-tentacle view
- octopus worker polling-tentacle
- octopus worker polling-tentacle list
- octopus worker polling-tentacle view
- octopus worker ssh
- octopus worker ssh create
- octopus worker ssh list
- octopus worker ssh view
- octopus worker view
- octopus worker-pool
- octopus worker-pool delete
- octopus worker-pool dynamic
- octopus worker-pool dynamic create
- octopus worker-pool dynamic view
- octopus worker-pool list
- octopus worker-pool static
- octopus worker-pool static create
- octopus worker-pool static view
- octopus worker-pool view
Using OpenID Connect with the Octopus API
API examples
- API examples
Channels
Deployment targets
- Deployment targets
- Add an Azure Web App
- Add a target role
- Add Tenants to targets
- Change target's machine policy
- Check Tentacles for available upgrades
- Delete targets by name
- Delete targets by role
- Enable/disable machine
- Find target usage
- Find unused targets
- Register Listening Tentacle
- Register Polling Tentacle
- Register SSH target
- Upgrade targets
Environments
Lifecycles
Project Groups
Step Templates
Tag sets
Users and Teams
- Users and Teams
- Add Azure Active Directory login to users
- Add domain teams
- Add an environment to a team
- Change users domain
- Create an API Key
- Find teams with role
- List users with editing roles
- List users with role
- List users
- Remove a project from team
- Swap AD group with LDAP group
- Change users AD domain to LDAP
Octopus.Server.exe command line
- Octopus.Server.exe command line
- Admin
- Check services
- Configure
- Create instances
- Database
- Delete instances
- Export certificates
- Import certificates
- License
- List instances
- Lost Master Key
- Rotate Master Key
- Set Master Key
- Metrics
- New certificate
- Node
- Built-in Worker
- Path
- External Worker
- Proxy
- Regenerate certificates
- Run
- Service
- Show configuration
- Show Master Key
- Show thumbprint
- SSL certificate
- Version
- Watchdog
Tentacle.exe command line
- Tentacle.exe command line
- Agent
- Check services
- Configure
- Create instance
- Delete instance
- Deregister from
- Deregister Worker
- Extract
- Import certificate
- List instances
- New certificate
- Poll server
- Polling proxy
- Proxy
- Register with
- Register Worker
- Server comms
- Service
- Show configuration
- Show thumbprint
- Update trust
- version
- watchdog
- Calamari
Octopus.Migrator.exe command line
- Migration API
Octo Command Line (CLI) (Deprecated)
- Octo Command Line (CLI) (Deprecated)
- Octopus CLI Global Tool
- JSON formatted output
- Allow release progression
- Build information
- Clean environments
- Clean Worker pool
- Complete
- Create auto deployment override
- Create channel
- Create environment
- Create project
- Create release
- Create Worker pool
- Delete auto deploy override
- Delete package
- Delete project
- Delete releases
- Deploy release
- Disable project
- Dump deployments
- Export
- Import
- Install autocomplete
- List deployments
- List environments
- List latest deployments
- List machines
- List projects
- List releases
- List tenants
- List Worker pools
- List Workers
- Pack
- Prevent release progression
- Promote release
- Push metadata
- Push
- Run a runbook
- Version
Administration
- Overview
High Availability
- Spaces
Upgrading Octopus
- Sync multiple instances
Managing infrastructure
- Managing infrastructure
- Maintenance Mode
- Applying Operating System upgrades
- Recovering after losing your Octopus Server and Master Key
- Rotating the Master Key
- Run multiple processes on a target simultaneously
- Managing multiple instances
- Automating infrastructure with DSC
- Script Console
Server configuration and file storage
Tentacle configuration and file storage
Subscriptions
- Show configuration
- Service watchdog
- Diagnostics
- Private cloud migration
Managing licenses
Retention policies
Security
- Overview
- Script integrity in Octopus Deploy
- Hardening Octopus
Outbound requests
- HTTP Security Headers
Authentication providers
- Authentication providers
- Authentication provider compatibility
- Username and Password
- Azure Active Directory authentication
- GoogleApps authentication
- LDAP Authentication
- Okta authentication
- Octopus ID authentication
- Guest login
- Automatic user creation
- Authentication automation with OctopusDSC
- Troubleshooting authentication problems
- Data encryption
- Built-in Worker
- FIPS and Octopus Deploy
- PCI compliance and Octopus Deploy
Common security vulnerabilities and exploits
- Common security vulnerabilities and exploits
- Cross-Site Request Forgery (CSRF) and Octopus Deploy
- SHA1 "Shattered" collision and Octopus Deploy
- Spectre (Speculative Execution Side-Channel Vulnerabilities), Meltdown, and Octopus Deploy
- Cross-Site Scripting (XSS) and Octopus Deploy
- ZipBombs and Octopus Deploy
- Security Self Assessment Questionnaire (CAIQ - Lite)
Support
- Overview
- Get the Raw Output From a Task
- Debug problems with Octopus variables
- Get the raw output from a deployment process
- Log files
- Copy the working directory
- Troubleshooting AWS transport level errors
- Troubleshooting failed or hanging tasks
- Troubleshooting Access Denied Starting Http Listener
- Capture a crash dump
- Process dumps
- Send a secret to Octopus
- Capture and export a HAR file
- How to turn on variable logging and export the task log
- How to get a database backup and encrypt your Master Key
- Record a problem with Octopus Deploy in your web browser
- Call the Jenkins REST API from PowerShell
- Compatibility
- Increase the Octopus Server task cap
- Credits
- GitHub Organizations
- Deprecations
- Search