Skip to content

Commit deb39c9

Browse files
Dancia ClaraDancia Clara
Dancia Clara
authored and
Dancia Clara
committed
new-self-hosting-layout
1 parent b2afe70 commit deb39c9

23 files changed

+1330
-745
lines changed

‎images/upgrade-to-paid-plan/activate-license-key.webp‎

30.2 KB
Loading

‎images/upgrade-to-paid-plan/billing-plane-one.webp‎

25 KB
Loading

‎images/upgrade-to-paid-plan/license-activate-one.webp‎

55.1 KB
Loading

‎images/upgrade-to-paid-plan/manage-licenses.webp‎

43.6 KB
Loading

‎images/upgrade-to-paid-plan/purchase-plan.webp‎

79.2 KB
Loading

‎images/upgrade-to-paid-plan/workspace-settings.webp‎

10.6 KB
Loading

‎mint.json‎

Lines changed: 42 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -40,10 +40,6 @@
4040
{
4141
"name": "API Reference",
4242
"url": "api-reference"
43-
},
44-
{
45-
"name": "Plane One",
46-
"url":"plane-one"
4743
}
4844
],
4945
"navigation": [
@@ -59,23 +55,48 @@
5955
"pages": [
6056
"self-hosting/overview",
6157
{
62-
"group":"Methods",
58+
"group":"Install Plane",
6359
"pages":[
6460
"self-hosting/methods/docker-compose",
6561
"self-hosting/methods/kubernetes"
6662
]
6763
},
6864
{
69-
"group" : "Govern",
65+
"group" : "Configure instance",
7066
"pages": [
7167
"self-hosting/govern/instance-admin",
72-
"self-hosting/govern/authentication",
68+
{
69+
"group": "Authentication",
70+
"pages": [
71+
"self-hosting/govern/authentication",
72+
"self-hosting/govern/google-oauth",
73+
"self-hosting/govern/github-oauth",
74+
"self-hosting/govern/oidc-sso",
75+
"self-hosting/govern/saml-sso"
76+
]
77+
},
7378
"self-hosting/govern/communication",
7479
"self-hosting/govern/custom-domain",
75-
"self-hosting/govern/reset-password"
80+
"self-hosting/govern/reset-password",
81+
"self-hosting/telemetry"
7682
]
7783
},
78-
"self-hosting/telemetry"
84+
{
85+
"group" : "Manage instance",
86+
"pages": [
87+
"self-hosting/manage/backup-restore",
88+
"self-hosting/manage/upgrade-plane",
89+
"self-hosting/manage/view-logs"
90+
]
91+
},
92+
{
93+
"group" : "Manage plans",
94+
"pages": [
95+
"self-hosting/manage-plans/prime-client",
96+
"self-hosting/manage-plans/prime-cli",
97+
"self-hosting/manage-plans/upgrade-from-community"
98+
]
99+
}
79100
]
80101
},
81102
{
@@ -273,45 +294,6 @@
273294
{
274295
"group": "Webhooks",
275296
"pages": ["webhooks/intro-webhooks"]
276-
},
277-
{
278-
"group": "Plane One",
279-
"pages":[
280-
"plane-one/introduction"
281-
]
282-
},
283-
{
284-
"group": "Self-host",
285-
"pages":[
286-
"plane-one/self-host/overview",
287-
{
288-
"group":"Methods",
289-
"pages":[
290-
"plane-one/self-host/methods/docker",
291-
"plane-one/self-host/methods/kubernetes"
292-
293-
]
294-
}
295-
]
296-
},
297-
{
298-
"group": "Manage",
299-
"pages":[
300-
"plane-one/manage/prime-cli",
301-
"plane-one/manage/prime-client"
302-
]
303-
},
304-
{
305-
"group": "Govern",
306-
"pages":[
307-
{
308-
"group":"Authentication",
309-
"pages":[
310-
"plane-one/governance/authentication/custom-sso"
311-
]
312-
},
313-
"plane-one/governance/workspaces-and-teams"
314-
]
315297
}
316298
],
317299
"footerSocials": {
@@ -478,6 +460,18 @@
478460
{
479461
"source": "/plane-one/self-host/methods/one-command",
480462
"destination": "/plane-one/self-host/methods/docker"
463+
},
464+
{
465+
"source": "/plane-one/self-host/methods/docker",
466+
"destination": "/self-hosting/methods/docker-compose"
467+
},
468+
{
469+
"source": "/plane-one/self-host/methods/kubernetes",
470+
"destination": "/self-hosting/methods/kubernetes"
471+
},
472+
{
473+
"source": "/plane-one/self-host/overview",
474+
"destination": "/self-hosting/overview"
481475
}
482476
],
483477
"analytics": {

‎self-hosting/govern/authentication.mdx‎

Lines changed: 1 addition & 67 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
---
2-
title : Authentication
2+
title : Overview
33
description: Plane offers several methods you can choose from to let your users log in to your Plane instance. Configure these methods in `Authentication` on `/god-mode` of your instance.
44
---
55
{/* ## Restrict sign-ups to invited users
@@ -15,69 +15,3 @@ Plane lets your users log in with codes sent over email. This is disabled if SMT
1515
### Passwords
1616

1717
Your users can log in with passwords that they or you set for them. This is toggled on when SMTP isn't configured for your instance. Disable it if you would like to use another authentication method below.
18-
19-
### Google OAuth
20-
21-
Plane already ships with out-of-the-box support for Google OAuth. This is the easiest option to configure for Google Workspace users.
22-
23-
#### Configure Plane as an app on Google API Console
24-
25-
First, you will need to identify Plane as an approved OAuth app to Google.
26-
27-
1. Go to the [Google API console](https://console.cloud.google.com/apis) and create a new project.
28-
2. Navigate to the **OAuth consent screen** under **APIs & Services**. Choose how you want to configure and register the Plane app, including your target users, and click **Create**.
29-
<Frame>![](/images/authentication/google/google-auth-1.png)</Frame>
30-
3. Configure the OAuth consent screen with information about the app.
31-
<Frame>![](/images/authentication/google/google-auth-2.png)</Frame>
32-
4. Navigate to the **Credentials** screen, click **Create Credentials**, and select **OAuth client ID** from the options given.
33-
<Frame>![](/images/authentication/google/google-auth-3.png)</Frame>
34-
5. Select **Web application** under the **Application type** dropdown list. Update the following fields.
35-
1. **Authorized JavaScript origins**\
36-
The HTTP origins that host your web application, e.g., `https://app.plane.so`
37-
2. **Authorized redirect URIs**\
38-
Append the path that users should be redirected to after they have authenticated with Google, e.g., `https://app.plane.so/auth/google/callback`
39-
3. Click **Create**.
40-
4. Get the Client ID and Client secret under **OAuth 2.0 Client IDs** on the **Credentials** screen.
41-
<Frame>![](/images/authentication/google/google-auth-4.png)</Frame>
42-
43-
#### Configure Plane
44-
45-
1. Go to `Google` on the Authentication screen of `/god mode`.
46-
2. Add the client ID + the client secret from Google API Console.
47-
3. Click `Save `.
48-
<Frame>![](/images/instance-admin/authentication-instance-settings.png)</Frame>
49-
50-
51-
Your Plane instance should now work with `Sign in with Google`.
52-
53-
54-
<Note>We don't restrict domains in with Google OAuth yet. It's on our roadmap.</Note>
55-
56-
## Github OAuth
57-
58-
Plane also supports GitHub OAuth so your users can sign-in with GitHub instead.
59-
60-
### Configure Plane as an OAuth app on GitHub
61-
62-
1. Log in to your [GitHub account](https://github.com/).
63-
2. Click your profile's avatar and navigate to **Settings.**
64-
3. Click **Developer Settings** and then **OAuth Apps**.
65-
<Frame>![](/images/authentication/github/github-auth-1.png)</Frame>
66-
4. Click **Register a new application**.
67-
5. Configure the following OAuth credentials for your Plane app.
68-
1. **Homepage URL**\
69-
The domain, with HTTPS, on which you host Plane, e.g., `https://app.plane.so`
70-
2. **Authorization Callback URL**\
71-
Append `/auth/github/callback/ `to the Homepage URL, e.g., `https://app.plane.so//auth/github/callback/`
72-
6. Click `Register application` to save it.
73-
<Frame>![](/images/authentication/github/github-auth-2.png)</Frame>
74-
7. Find the app you just registered and click through to find the client ID and the client secret. You will need this for the next steps.
75-
76-
### Configure Plane
77-
78-
1. Go to `GitHub` on the Authentication screen of `/god mode`.
79-
2. Add the client ID + the client secret from the GitHub app you just registered.
80-
3. Click `Save `.
81-
<Frame>![](/images/instance-admin/authentication-instance-settings.png)</Frame>
82-
83-
Your Plane instance should now work with GitHub sign-in.

‎self-hosting/govern/github-oauth.mdx‎

Lines changed: 30 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,30 @@
1+
---
2+
title: Github OAuth
3+
---
4+
5+
Plane also supports GitHub OAuth so your users can sign-in with GitHub instead.
6+
7+
## Configure Plane as an OAuth app on GitHub
8+
9+
1. Log in to your [GitHub account](https://github.com/).
10+
2. Click your profile's avatar and navigate to **Settings.**
11+
3. Click **Developer Settings** and then **OAuth Apps**.
12+
<Frame>![](/images/authentication/github/github-auth-1.png)</Frame>
13+
4. Click **Register a new application**.
14+
5. Configure the following OAuth credentials for your Plane app.
15+
1. **Homepage URL**\
16+
The domain, with HTTPS, on which you host Plane, e.g., `https://app.plane.so`
17+
2. **Authorization Callback URL**\
18+
Append `/auth/github/callback/ `to the Homepage URL, e.g., `https://app.plane.so//auth/github/callback/`
19+
6. Click `Register application` to save it.
20+
<Frame>![](/images/authentication/github/github-auth-2.png)</Frame>
21+
7. Find the app you just registered and click through to find the client ID and the client secret. You will need this for the next steps.
22+
23+
## Configure Plane
24+
25+
1. Go to `GitHub` on the Authentication screen of `/god mode`.
26+
2. Add the client ID + the client secret from the GitHub app you just registered.
27+
3. Click `Save `.
28+
<Frame>![](/images/instance-admin/authentication-instance-settings.png)</Frame>
29+
30+
Your Plane instance should now work with GitHub sign-in.

‎self-hosting/govern/google-oauth.mdx‎

Lines changed: 38 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,38 @@
1+
---
2+
title: Google OAuth
3+
---
4+
5+
Plane already ships with out-of-the-box support for Google OAuth. This is the easiest option to configure for Google Workspace users.
6+
7+
## Configure Plane as an app on Google API Console
8+
9+
First, you will need to identify Plane as an approved OAuth app to Google.
10+
11+
1. Go to the [Google API console](https://console.cloud.google.com/apis) and create a new project.
12+
2. Navigate to the **OAuth consent screen** under **APIs & Services**. Choose how you want to configure and register the Plane app, including your target users, and click **Create**.
13+
<Frame>![](/images/authentication/google/google-auth-1.png)</Frame>
14+
3. Configure the OAuth consent screen with information about the app.
15+
<Frame>![](/images/authentication/google/google-auth-2.png)</Frame>
16+
4. Navigate to the **Credentials** screen, click **Create Credentials**, and select **OAuth client ID** from the options given.
17+
<Frame>![](/images/authentication/google/google-auth-3.png)</Frame>
18+
5. Select **Web application** under the **Application type** dropdown list. Update the following fields.
19+
1. **Authorized JavaScript origins**\
20+
The HTTP origins that host your web application, e.g., `https://app.plane.so`
21+
2. **Authorized redirect URIs**\
22+
Append the path that users should be redirected to after they have authenticated with Google, e.g., `https://app.plane.so/auth/google/callback`
23+
3. Click **Create**.
24+
4. Get the Client ID and Client secret under **OAuth 2.0 Client IDs** on the **Credentials** screen.
25+
<Frame>![](/images/authentication/google/google-auth-4.png)</Frame>
26+
27+
## Configure Plane
28+
29+
1. Go to `Google` on the Authentication screen of `/god mode`.
30+
2. Add the client ID + the client secret from Google API Console.
31+
3. Click `Save `.
32+
<Frame>![](/images/instance-admin/authentication-instance-settings.png)</Frame>
33+
34+
35+
Your Plane instance should now work with `Sign in with Google`.
36+
37+
38+
<Note>We don't restrict domains in with Google OAuth yet. It's on our roadmap.</Note>

0 commit comments

Comments
 (0)