Skip to main content

Instance admin and God mode

Version

This feature is available beginning in version 0.14.

An instance is a single self-managed installation of Plane on a private cloud or server. A single instance can house multiple workspaces.

Instance admin is a role that permits you to administer and govern your Plane instance and workspaces. You can access the instance admin features by going to /god-mode on your self-hosted Plane instance.

Settings​

God Mode features a few screens as shown below.

General​

The General settings page allows you to view or configure core instance details and telemetry preferences. Here’s what you can manage:

  • Name of instance: Customize the name of your instance.
  • Email: Displays the instance admin email address.
  • Instance ID: Displays a unique identifier for your instance.
  • Chat with us: Enable or disable in-app chat support for users. Disabling telemetry automatically turns this off.
  • Let Plane collect anonymous usage data: Plane collects anonymized usage data (no PII) to help improve features and overall experience. You can turn this off anytime. See Telemetry for more info.

Workspaces​

The Workspaces section allows you to manage all workspaces within your Plane instance.

  • View all Workspaces: Access a complete list of workspaces on your instance.
  • Create Workspaces: You can create new workspaces directly from this section. If workspace creation is restricted, only the instance admin will have this ability.
  • Restrict Workspace creation: Toggle the Prevent anyone from creating a workspace option to prevent anyone else from creating workspaces. Once enabled, only you (the instance admin) can create new workspaces.

To add users to a workspace, you will need to invite them after creating it.

info

Workspace deletion is currently not supported.

Email​

Set up your SMTP server here so you can send essential emails like password resets, data exports, onboarding, and more, to your users. Learn more here.

Authentication​

Control what SSO and OAuth services your users can use to sign up and log in to your Plane instance. You can also toggle unique code and password logins on and off from here. Learn more here.

  • Allow anyone to sign up without an invite: Toggle this setting off if you want your users to join the instance only if they receive an invite.
tip

This is where you will see new SSO services and custom OAuth configs in the future.

Artificial Intelligence​

Plane supports the use of AI throughout your projects. For now, we support OpenAI’s APIs and keys. You can configure them here or leave them blank if you don’t wish to offer AI features to your users. Your Plane experience remains largely unchanged if you don’t set this up.

Images in Plane​

You can use your own third-party libraries to update images in project settings. Configure your Unsplash key here. When we add more image libraries, they will show up here.

Add Instance Admin​

To grant a user full administrative access (including God mode) to your self-hosted Plane instance, you'll need to assign them the Instance Admin role. Instance admins have unrestricted control over all configurations and settings within the instance.

To promote an existing user to Instance Admin, execute the following command in your terminal:

docker exec <backend_container_name> /bin/bash -c "python manage.py create_instance_admin <user_email>"

Ensure that the provided email matches the user's registered account. This command will instantly elevate their privileges to full administrative access.

FAQs​

How do you know who an Instance admin is?

Whoever spins up the instance or upgrades to v0.14, we assume, is the instance admin. When you see "Let's secure your instance," enter your email-password combo. If you are already using Plane with those credentials, you will be logged in and will see /god-mode features. If not, we will create a new user on your local instance and you will see /god-mode.

Our assumption is that users technical enough to upgrade to or bring up a new instance with v0.14 are instance admins. If there’s a case where this isn’t true, please reach out to us before you upgrade or set up your fresh instance.

What if I don’t complete secure instance set-up at the time of the upgrade?

We strongly recommend completing set-up at upgrade so your regular users can access Plane without trouble. Because we are introducing several sensitive admin features in God Mode, we will show an instance-not-set-up screen to your regular users until you complete the setup.

What has changed with how existing regular users of my instance log in?

All existing users will log in with their usual email address-password combos if they are already doing so. If they haven’t been using a password when not OAuthing into Plane, they will now need to. If OAuth is enabled, users can continue using your OAuth methods. New users will need to choose a password or OAuth into Plane.

What will happen to the default captain@plane.so account that you shipped so far?

For all new instances, there won’t be a captain@plane.so account. Instance set-up will allow you to set up a workspace and set workspace and project admins.

For existing instances, the instance admin’s email will be added to each project with the same permissions as captain@plane.so so you can remove that email completely from your workspaces and projects.

This is unreal, but I have an instance that has a /god-mode path already. I can’t access my Plane instance. Help!

That is unreal! Please reach out to us immediately on support or on our Discord and mark your message urgent. We will help you get your instance back pronto.

How will emails for password resets and onboarding be sent to users of my instance(s)?

We have always let you configure your own SMTP server to send emails from within your instance. It’s also why we are being deliberate about leading the instance admin of an existing instance to /god-mode first. After completing secure instance set-up now, you can configure your SMTP server on the UI instead of via .env variables. We strongly recommend you do that to avoid password-reset failures and failures in email delivery.

Please reach out to us on Discord if you haven’t set up SMTP and are facing troubles with your users logging in.

Why are you introducing passwords for app.plane.so users? What’s happening with unique links to sign up and sign in?

Unique links are secure and relatively easier, but we have heard from enough of our Cloud users that they would like to log in using a more permanent and easier method. Should you want to continue using unique codes, you are covered. We will keep that option alive for good.

While using Google or GitHub are good options already, not all of you would want to use them. For those that prefer a password and would like to do away with codes, we want to make that option available.

Is there a God Mode for Cloud admins, too?

Not now, but soon enough, there will be a God Mode for Cloud admins.