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

Installation

Last updated

This section walks you through installing the Octopus Deploy server.

Once installed, the Octopus Deploy server:

  • Runs as a Windows Service.
  • Stores its data in a¬†SQL Server database.
  • Has an embedded HTTP server which serves the Octopus REST API and the Octopus Web Portal that you will use to manage your deployments.

Upgrading

If Octopus is already installed, and you want to upgrade to a new version, please follow the steps in the upgrade guide.

Requirements

To successfully install the Octopus server you need:

  • A Microsoft SQL Server instance which can be accessed by your Octopus Server (more details).
  • .NET Framework:
  • Any of the following Windows servers:
    • Windows Server 2008 SP2
    • Windows Server 2008 R2
    • Windows Server 2012
    • Windows Server 2012 R2
    • Windows Server 2016

Windows Server Core

Whilst Octopus Server will run on "Windows Server Core", the easiest installation path is to use "Windows Server with a GUI" and run our installation wizard. If you want to use "Windows Server Core" you will need to add some missing Windows Features and configure Octopus server yourself. Learn about automating installation.

Hardware Requirements

There is no "one size fits all" approach for Octopus server. The best approach is to start with a working Octopus server, start deploying your applications, monitor your server statistics, and scale from there.

  • Absolute minimum to make it run: 512MB RAM, 1GHz CPU, 2GB free disk space.
  • Recommended starting point for smaller deployments (less than 30 deployment targets for example): 2GB RAM, dual-core CPU, 10GB free disk space.
  • Recommended starting point for larger deployments: 4GB RAM, dual-core, 20GB free disk space.

Learn about Octopus Server performance.

Downloads

The latest Octopus Deploy MSI can always be downloaded from the Octopus Deploy downloads page. You can also download any previous releases from our archive.

If you are writing a script or utility to automatically download the latest version of one of our products, you can use the following permanent links:

Installation

This three minute video will walk you through the installation process:

Using a Managed Service Account (MSA)

You can run the Octopus Server using a Managed Service Account (MSA):

  1. Install the Octopus Server and make sure it is running correctly using one of the built-in Windows Service accounts or a Custom Account.
  2. Reconfigure the Octopus Server Windows Service to use the MSA, either manually using the Service snap-in, or using sc.exe config "OctopusDeploy" obj= Domain\Username$
  3. Restart the Octopus Server Windows Service.

Learn about using Managed Service Accounts.

Troubleshooting

In a few cases a bug in a 3rd party component causes the installer to display an "Installation directory must be on a local hard drive" error. If this occurs, run the install again from an elevated command prompt using the following command (replacing Octopus.3.3.4-x64.msi with the name of the installer you are using):

msiexec /i Octopus.3.3.4-x64.msi WIXUI_DONTVALIDATEPATH="1"

Deploying applications to an Azure website?
If you get the following error it means you have a local copy of Web Deploy and that is being used. You will either need to upgrade your local version of Web Deploy to 3.5 or greater, or uninstall the local copy so Octopus can reference the embedded copy.

In This Section

The rest of this section covers these topics in some more detail, and explains how to implement them.