This guide will walk you through upgrading your Sourcebot deployment from v3 to v4.

Please note that the following features are no longer supported in v4:

  • Multi-tenancy mode
  • Unauthenticated access to a Sourcebot deployment - authentication is now built in by default. Unauthenticated access to a organization can be enabled with an unlimited seat enterprise license

​
If your deployment doesn’t have authentication enabled

1

Spin down deployment

2

Set AUTH_URL environment variable if needed

If your Sourcebot instance is deployed behind a domain (ex. https://sourcebot.yourcompany.com) you must set the AUTH_URL environment variable to your deployment domain.

3

Spin up v4 deployment and create owner account

When you visit your new deployment you’ll be presented with a sign-in page. Sourcebot now requires authentication, and all users must register and sign-in to the deployment.

The first account that’s registered will be made the owner. By default, you can register using basic credentials which will be stored encrypted within the postgres DB connected to Sourcebot. Check out the auth docs to setup additional auth providers.

4

(Optional) Configure transactional emails

Emails can be sent on organization join request/approval by configuring transactional emails

5

Approve additional users onto your deployment

After the first account is created, all new account registrations must be approved by the owner. When new users register onto the deployment they’ll be presented with the following request approval page:

The owner can view and approve join requests by navigating to Settings -> Members. Automatic provisioning of accounts is supported when using SSO/Oauth providers, check out the auth docs for more info

6

You're done!

Congrats, you’ve successfully migrated to v4! Please let us know what you think of the new features by reaching out on our discord or GitHub discussion

​
If your deployment has authentication enabled

The only change that’s required if your deployment has authentication enabled is to unset the SOURCEBOT_AUTH_ENABLED environment variable. New user registrations will now submit a request to join the organization which can be approved by the owner by navigating to Settings -> Members. Emails can be sent on organization join request/approval by configuring transactional emails

​
If your deployment uses multi-tenancy mode

Unfortunately, multi-tenancy mode is no longer officially supported in v4. To upgrade to v4, you’ll need to unset the SOURCEBOT_TENANCY_MODE environment variable and wipe your Sourcebot cache. You can then follow the instructions above to finish upgrading to v4 in single-tenant mode.

​
Troubleshooting

  • If you’re hitting issues with signing into your Sourcebot instance, make sure you’re setting AUTH_URL correctly to your deployment domain (ex. https://sourcebot.yourcompany.com)

Having troubles migrating from v3 to v4? Reach out to us on discord or GitHub discussion and we’ll try our best to help