Octopus Deploy Documentation

Service

Last updated

Use this to configure and manage your Octopus service.

Service options

Usage: octopus.server service [<options>]

Where [<options>] is any of:

      --start                Start the Windows Service if it is not already
                               running
      --stop                 Stop the Windows Service if it is running
      --restart              Restart the Windows Service if it is running
      --reconfigure          Reconfigure the Windows Service
      --install              Install the Windows Service
      --username, --user=VALUE
                             Username to run the service under
                               (DOMAIN\Username format). Only used when --
                               install or --reconfigure are used.  Can also be
                               passed via an environment variable
                               OCTOPUS_SERVICE_USERNAME.
      --uninstall            Uninstall the Windows Service
      --password=VALUE       Password for the username specified with --
                               username. Only used when --install or --
                               reconfigure are used. Can also be passed via an
                               environment variable OCTOPUS_SERVICE_PASSWORD.
      --dependOn=VALUE
      --instance=VALUE       Name of the instance to use, or * to use all
                               instances

Or one of the common options:

      --help                 Show detailed help for this command

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.