This page is for Octopus Deploy 3.0 and newer versions. You can view this page for Octopus 2.0

Skip to end of metadata
Go to start of metadata

Welcome! This section will guide you through the process of setting up Octopus Deploy and completing your first deployment. 

Octopus in your delivery process

Octopus Deploy is an automated deployment server, which you install yourself, much like you would install SQL Server, Team Foundation Server or JetBrains TeamCity. Octopus makes it easy to automate deployment of ASP.NET web applications and Windows Services into development, test and production environments.

Along with the Octopus Deploy server, you'll also install a lightweight agent service on each of the machines that you plan to deploy to, for example your web and application servers. We call this the Tentacle agent; the idea being that one Octopus server controls many Tentacles, potentially a lot more than 8! With Octopus and Tentacle, you can easily deploy to your own servers, or virtual machines in the cloud from infrastructure as a service providers like Amazon EC2 or Windows Azure virtual machines. 



We designed Octopus to fit into teams that follow agile delivery practices. Octopus compliments your existing delivery pipeline:

  • Developers commit their code into your existing source control system
    You might be using Git, Team Foundation Server, Subversion or Mercurial; the choice is up to you. 
  • Your CI/build server compiles the code and runs unit tests
    Again, you might be using TeamCity, Jenkins, Bamboo, Team Foundation Server or CruiseControl.NET; the choice is up to you. 
  • Your application is packaged into a NuGet package
    When the build is done, your CI/build server bundles all of the files – the binaries, images, scripts, configuration files and so on – needed to deploy your application into a NuGet package

The job of Octopus, then, is to take these packages and push them to the machines that they will be deployed to. As a release manager, you define the process for deploying the software, including any environment-specific configuration variables. The Octopus web based dashboard then allows other members of your team to queue deployments; for example, you might enable testers to deploy applications to a test environment, but not to production. This approach means that even if different people are triggering the deployments, the deployment process is still consistent.

Install the Octopus server

Download the latest Octopus Deploy MSI installer from the Octopus Deploy website, and follow the instructions. 


For more information, including a video walkthrough, see the Installing Octopus section.

When the MSI installer completes, a wizard will take you through the process of configuring your Octopus Deploy server. 

When your Octopus server is configured, the Octopus Manager UI will appear. This is an administrator-only interface designed for configuring your Octopus server.

Open the Octopus Web Portal in your browser and sign in, using the address and credentials you specified during the setup wizard. 

Create environments

Next, you'll need to add environments to deploy to. Environments are really just groups of machines that you deploy to; for example, Test, Staging or Production


Learn more on the Environments page.

Add machines to your environments

On each of the web or application servers that you plan to deploy software to, you'll need to install the Tentacle agent, and then register the machines in your environments. 


See how on the Installing Tentacles page. Depending on network/firewall configuration, Tentacles can be installed in listening (Octopus calls Tentacle) or polling (Tentacle polls Octopus) mode. If you have many machines to manage, you can install Tentacles automatically.

Package your applications for deployment

Whenever you want to deploy applications with Octopus, you'll need to package them into NuGet packages. There are three ways to do this:

Your packages need to be placed into a package repository. 

Create a project

Projects define a set of deployment steps that you want Octopus to perform, and their configuration variables. 


Learn more about creating projects.

Define your deployment process

The Process tab within your project defines how your project will be deployed. You can add different steps to the process depending on what you plan to deploy:

Chances are, you'll need to configure your application differently depending on the what you are deploying to (for example, different connection strings in staging vs. production). Octopus has advanced support for managing these variables and scoping them, and can even manage passwords securely. Octopus can also take care of automatically updating your .NET configuration files, and running configuration file transforms

Create a release and deploy it

Next, create a release. Click the Create release button on any page of your project.

Enter an overall release version number for the release, and select the NuGet package versions that you want to include in the release. You can also add release notes to tell your team what the release contains. 

Now that you have a release, you can deploy and promote it between environments. On the release page, use the green Deploy to <environment> button to promote it.

The deployment page shows you a log of all the activity that happens during the deployment, on both the Octopus server and any Tentacles, including the output of any custom scripts.

Next steps

Congratulations, you've deployed a release! You might want to look at:


  • No labels