First Runbook Run

This tutorial will help you complete your first runbook run using a sample script on one or more of your servers. The only prerequisite is a running Octopus Deploy instance, either in Octopus Cloud or self-hosted. The tutorial will walk through configuring deployment targets.

This tutorial will take between 15-25 minutes to complete, with each step taking between 2-3 minutes to complete.

  1. Configure environments
  2. Create a project
  3. Create a runbook
  4. Define a runbook process to run on workers
  5. Running a runbook
  6. Defining and using runbook variables
  7. Adding deployment targets
  8. Update runbook process to run on deployment targets
  9. Publishing a runbook

Before starting the tutorial, if you havenโ€™t set up an Octopus Deploy instance, please do so by selecting one of the following options:

When you have an instance running, go to the configure runbook environments page to get started.

Further Reading

This tutorial will run a sample script, first on the default worker or your server; then, it will move onto running that script on your servers. If you prefer to skip that and start configuring Octopus Deploy runbooks to meet your requirements, please see:

Help us continuously improve

Please let us know if you have any feedback about this page.

Send feedback

Page updated on Sunday, January 1, 2023