Documentation menu

Your first runbook run in Octopus Deploy

Use Octopus docs with AI

Create a project for your Octopus runbook

Create an Octopus Deploy project to hold your runbook. Follow the step-by-step guide to name the project, pick a lifecycle, and get ready to add a runbook.

Getting Started - Add Projects And Project Groups

Projects are used to collect all the assets that make up your deployment processes. To deploy our simple hello world script, we first need a project.

The projects page in the Octopus Web Portal

  1. Navigate to the Projects tab, and click ADD PROJECT.
  2. Give the project a name, for instance, Hello, world, and click Save.

Optional

By default, Octopus Deploy will store the deployment process, runbook process, and variables in the back-end SQL Server. From Octopus 2022.1, you have the option to store the deployment process in a git repository.

The ability to store runbook processes and variables will be added in future versions.

To configure the project to use version control:

  1. Select the option Use Version Control for this project
  2. Click Save and Configure VCS
  3. Enter the git repository URL and credentials.
  4. Click Test to verify the connection.
  5. Click Save to save the VCS information.

Learn more about config as code.

The next step will create a runbook in the newly created project.

Further Reading:

For further reading on Runbooks and projects please see: