This documentation is for Octopus Deploy Version 3.12. View the latest version.

Installation

Last updated

This section walks you through installing the central Octopus Deploy server.

Once installed, the Octopus Deploy server:

  • Runs as a Windows Service.
  • Stores its data in an 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.

Before you install Octopus Deploy, please 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.

You need to download the latest version of the Octopus Installer.

Installation

  1. Start the Octopus Installer and follow the onscreen prompts.

Accept the License Agreement, and either accept the default Destination Folder or choose a different location.

  1. Click Install, and give the app permission to make changes to your device.
  2. Click finish to exit the installation wizard and launch the Getting started wizard to configure your Octopus Deploy server.
  3. Click Get Started and either enter your details to start a free trial of Octopus or enter your license key.
  4. Accept the default Home Directory or enter a location of your choice.
  5. Decide whether to use a Local System Account or a Custom Domain Account.

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

  1. On the Database page, click the dropdown arrow in the Server Name field to detect the SQL Server Database.
  2. Enter a name for the database, and click 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.
  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.
  3. Click Install.

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

Octopus Manager

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

Before you do, 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.

Save the Master Key

Under the storage section, you will see a link to View Master Key. The 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 to the master key if you ever need to restore an Octopus backup.

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

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.

Troubleshooting

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

Next Steps

Now that you've installed the Octopus Deploy server, it's time to configure your Infrastructure.

In This Section

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