Octopus Deploy Documentation

Installation

Last updated

The Octopus Deploy server is available as a self-hosted instance that you install and manage on your infrastructure. This section walks you through installing the self-hosted Octopus Deploy server. If you're looking for Octopus Cloud, see Octopus Cloud.

Download the Octopus Installer

Download icon Download

Self-Hosted Octopus Deploy Server

When installed, the self-hosted Octopus Deploy server:

Before you install Octopus Deploy, review the software and hardware requirements, and make sure you have access to an instance of SQL Server Database that you can use with Octopus Deploy.

Install Octopus

  1. Start the Octopus Installer, click Next, accept the Terms in the License Agreement and click Next.
  2. Accept the default Destination Folder or choose a different location and click Next.
  3. Click Install, and give the app permission to make changes to your device.
  4. Click Finish to exit the installation wizard and launch the Getting started wizard to configure your Octopus Deploy Server.
  5. Click Get started... and either enter your details to start a free trial of Octopus Deploy or enter your license key and click Next.
  6. Accept the default Home Directory or enter a location of your choice and click Next.
  7. Decide whether to use a Local System Account or a Custom Domain Account.

Learn more about the permissions required for the Octopus Windows Service or using a Managed Service Account.

  1. On the Database page, click the dropdown arrow in the Server Name field to detect the SQL Server Database. Octopus will create the database for you which is the recommended process; however, you can also create your own database.
  2. Enter a name for the database, and click Next and OK to create the database.

Be careful not to use the name of an existing database as the setup process will install Octopus into that pre-existing database.

  1. Accept the default port and directory or enter your own and click Next.
  2. If youโ€™re using username and passwords stored in Octopus authentication mode, enter the username and password that will be used for the Octopus administrator. If you are using active directory, enter the active directory user details.

You can configure addition Authentication Providers for the Octopus Deploy server after the server has been installed.

  1. Click Install.

When the installation has completed, click Finish to launch the Octopus Manager.

Octopus Manager

Before you launch the Octopus Web Portal, it's worth taking note of the other settings such as controlling the Octopus Windows Service, importing and exporting the data Octopus stores in the SQL server, and viewing the master key.

You can launch the Octopus Web Portal from the Octopus Manager, by clicking Open in Browser.

Save Your Master Key

Under the storage section, you will see a link to View Master Key.

When Octopus is installed, it generates a master key which is a random string that is used to encrypt sensitive data in your Octopus database. You will need the master key if you ever need to restore Octopus.

Make a copy of the master key and save it in a secure location.

Warning

If you don't have a copy of your master key and your hardware fails, you will not be able to recover the encrypted data from the database. Make a copy of the master key and save it in a secure location. Hopefully you will never need it, but you'll glad you have it if you ever do. Learn about Recovering After Losing Your Octopus Server and Master Key.

Launch the Octopus Web Portal

Click Open in browser to launch the Octopus Web Portal and log in using the authentication details you set up during the configuration process.

The Octopus Web Portal is where you'll manage your infrastructure, projects, deployment process, access the built-in repository, and manage your deployments and releases.

Troubleshooting

If you've had any problems with the installation, review the troubleshooting page.

Next Steps

Welcome! We use cookies and data about how you use our website allow us to improve the website and your experience, and resolve technical errors. Our website uses cookies and shares some of your data with third party analytics companies for these purposes.

If you decline, we will respect your privacy. A single cookie will be used in your browser to remember your preference.