You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: self-hosting/govern/instance-admin.mdx
+66-18Lines changed: 66 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -17,35 +17,79 @@ This role lets instance admins access `/god-mode`, a route for features that hel
17
17
New instances allow skipping going to God Mode and setting up your workspace instead. Whatever you choose after secure instance set-up, we highly recommend coming quickly to /god-mode to set up at least your SMTP server so your users can start getting invite emails to projects.
18
18
</Tip>
19
19
20
+
## Settings
21
+
20
22
God Mode features a few screens as shown below.
21
23
22
-
-**General**
24
+
### General
25
+
The General settings page allows you to view or configure core instance details and telemetry preferences.
26
+
Here’s what you can manage:
23
27
24
-
Your instance name, admin’s email address, and the provision to add other instance admins show up on this screen. There’s also an option to report anonymous usage data so we can learn from how you use Plane and ship better product.
28
+
-**Name of instance**
29
+
Customize the name of your instance.
25
30
26
-
-**Email**
27
-
Set up your SMTP server here so you can send essential emails—password resets, exports, changes to your instance—and Plane-enabled emails—onboarding, tips and tricks, new features— to all your users. [Learn more here](/self-hosting/govern/communication).
Enable or disable in-app chat support for users. Disabling telemetry automatically turns this off.
33
39
34
-
Control what SSO and OAuth services your users can use to log into their Plane account. You can also toggle magic links on and off from here. [Learn more here](/self-hosting/govern/authentication).
40
+
-**Let Plane collect anonymous usage data**
41
+
Plane collects anonymized usage data (no PII) to help improve features and overall experience. You can turn this off anytime. See [Telemetry](/self-hosting/telemetry) for more info.
35
42
36
-
<Note>
37
-
This is where you will see new SSO services and custom OAuth configs in the future.
The Workspaces section allows you to manage all workspaces within your Plane instance.
41
47
42
-
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.
48
+
-**View all Workspaces**
49
+
Access a complete list of workspaces on your instance.
43
50
44
-
-**Images in Plane**
51
+
-**Create Workspaces**
52
+
You can create new workspaces directly from this section. If workspace creation is restricted, only the instance admin will have this ability.
45
53
46
-
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.
54
+
-**Restrict Workspace creation**
55
+
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.
47
56
48
-
Soon, we will introduce God Mode for our Cloud users as well so they can manage their workspaces better. To get notified about this, [sign up here](https://ece39166.sibforms.com/serve/MUIFANgaMWIARsq1n0lMNrch19pdY2HJm9FkSXAeq1DrCoXJBmO9Yq6SPgtzu7rL0lQBmCvvz2A2arVl5WaDxYu6YhNW4PKNAis0DMXmpRnwm5633BvXqIYILqZuyqYiGS7_QjJ0Ozh4R2uctd8RwiiTLSHWpnV2njQt6DPV5cVr8FH3K-TouNAlBScOJxbCpjj8fYo2ULsEJeAL).
57
+
To add users to a workspace, you will need to [invite them](https://docs.plane.so/core-concepts/workspaces/members#add-member) after creating it.
Set up your SMTP server here so you can send essential emails—password resets, exports, changes to your instance—and Plane-enabled emails—onboarding, tips and tricks, new features— to all your users. [Learn more here](/self-hosting/govern/communication).
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](/self-hosting/govern/authentication).
72
+
73
+
-**Allow anyone to sign up without an invite**
74
+
Toggle this setting off if you want your users to join the instance only if they receive an invite.
75
+
76
+
<Note>
77
+
This is where you will see new SSO services and custom OAuth configs in the future.
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.
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.
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.
@@ -56,16 +100,20 @@ To promote an existing user to Instance Admin, execute the following command in
56
100
```
57
101
Ensure that the provided email matches the user's registered account. This command will instantly elevate their privileges to full administrative access.
58
102
103
+
--------
104
+
105
+
Soon, we will introduce God Mode for our Cloud users as well so they can manage their workspaces better. To get notified about this, [sign up here](https://ece39166.sibforms.com/serve/MUIFANgaMWIARsq1n0lMNrch19pdY2HJm9FkSXAeq1DrCoXJBmO9Yq6SPgtzu7rL0lQBmCvvz2A2arVl5WaDxYu6YhNW4PKNAis0DMXmpRnwm5633BvXqIYILqZuyqYiGS7_QjJ0Ozh4R2uctd8RwiiTLSHWpnV2njQt6DPV5cVr8FH3K-TouNAlBScOJxbCpjj8fYo2ULsEJeAL).
106
+
59
107
## FAQs
60
108
<AccordionGroup>
61
109
<Accordiontitle="How do you know who an Instance admin is?">
62
110
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.
63
111
64
-
Our shrewd guess right now is 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.
112
+
Our shrewd guess right now is users are 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 setup your fresh instance.
65
113
</Accordion>
66
114
67
115
<Accordiontitle="What if I don’t complete secure instance set-up at the time of the upgrade?">
68
-
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 such a time that you can complete set-up.
116
+
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 such a time that you can complete the setup.
0 commit comments