Setup


Setup Key

Once installation is finished, a setup key will be output to the console. Copy this, you will need it for the initial web setup.
This setup key is used to prevent any random internet stranger setting up your deployment before you do.

Choose a Setup Method

Github

Setting up with Github creates a Github App to act on behalf of your installation. This means authentication will use Github OAuth, and information about your repositories can be automatically fetched via the Github API.

The app is created using a manifest - you can view the configuration here. You can choose to install the app on your account, or for an organisation.

Organisation Install

If you install on behalf of an organisation, all members of the organisation will be able to authenticate and use Shokku. There is currently no role-based access, so ensure you trust your fellow org members as admins!

Username/Password

You can also use username/password authentication. Currently this is limited to a single user.

TOTP 2FA

Use of TOTP is strongly recommended. A QR code/secret will be generated, along with a recovery code to be used should you lose access to your account. If you choose not to enable this during installation, it can be configured later in Settings.