Octopus Deploy Documentation

Username and Password

Last updated

Username and Password authentication can only be configured for Octopus Server. For Octopus Cloud, authentication using this provider is supported through Octopus ID. See our authentication provider compatibility section for further information.

Octopus provides a Username and Password authentication provider allowing you to create user accounts in Octopus manually without requirement for an external authentication provider.

The Username and Password provider is available out-of-the-box as one of a number of custom Server extensions provided as part of the Octopus Deploy installation. It is an open-source project and the source code is available on GitHub.

When Username and Password authentication is enabled, the sign in page for the Octopus Web Portal will present users with the option to sign in with an Octopus account:

Username and Password login screen

Enable username and password authentication via UI

You can enable Username and Password authentication from the Octopus Web Portal by navigating to Configuration ➜ Settings ➜ Username / Password. From there you can click the Is Enabled checkbox to enable or disable the Username and Password provider.

Username and Password settings Enable Username and Password checkbox

The Username and Password provider will now be activated and available for Octopus users.

Configuring username and password login

Octopus Server can be configured to enable or disable username and password authentication via the command line, as follows:

Octopus.Server.exe configure --instance=[your_instance_name] --usernamePasswordIsEnabled=true

Managing user permissions

When a new Octopus user is created, they are automatically added to the Everyone team. To manage Octopus users, this can be done by navigating to Configuration ➜ Users.

Managing users

With any Octopus user, you can assign user accounts to different teams to give them permissions to view projects or environments, or any additional permissions they may need:

User permissions

Need support? We're here to help.