Tuto self-host & SSO (#313)

windmill-labs · Sep 22, 2023 · 1c8af4c · 1c8af4c
1 parent 96ea39e
commit 1c8af4c
Show file tree

Hide file tree

Showing 34 changed files with 439 additions and 203 deletions.
diff --git a/blog/2023-03-20-handler-slack-commands/0-header.png b/blog/2023-03-20-handler-slack-commands/0-header.png
diff --git a/blog/2023-03-20-handler-slack-commands/0-header.png.webp b/blog/2023-03-20-handler-slack-commands/0-header.png.webp
diff --git a/docs/advanced/1_self_host/adding_new_user.gif b/docs/advanced/1_self_host/adding_new_user.gif
diff --git a/docs/advanced/1_self_host/index.md → docs/advanced/1_self_host/index.mdx b/docs/advanced/1_self_host/index.md → docs/advanced/1_self_host/index.mdx
diff --git a/docs/advanced/1_self_host/self_hosted_windmill.png b/docs/advanced/1_self_host/self_hosted_windmill.png
diff --git a/docs/advanced/1_self_host/smtp_filled.png b/docs/advanced/1_self_host/smtp_filled.png
diff --git a/docs/advanced/1_self_host/superadmin_settings.png b/docs/advanced/1_self_host/superadmin_settings.png
diff --git a/docs/compared_to/airplane.mdx b/docs/compared_to/airplane.mdx
@@ -30,7 +30,7 @@ where users share useful and proven scripts, flows, and applications.
 		href="https://github.com/windmill-labs/windmill"
 	/>
     <DocCard
-		title="Self Host Windmill tutorial"
+		title="Self Host Windmill"
 		description="Self host Windmill in 2 minutes."
 		href="/docs/advanced/self_host/"
 	/>

diff --git a/docs/compared_to/prefect.md → docs/compared_to/prefect.mdx b/docs/compared_to/prefect.md → docs/compared_to/prefect.mdx
@@ -40,7 +40,7 @@ where users share useful and proven scripts, flows, and applications.
 		href="https://github.com/windmill-labs/windmill"
 	/>
     <DocCard
-		title="Self Host Windmill tutorial"
+		title="Self Host Windmill"
 		description="Self host Windmill in 2 minutes."
 		href="/docs/advanced/self_host/"
 	/>

diff --git a/docs/compared_to/retool.mdx b/docs/compared_to/retool.mdx
@@ -32,7 +32,7 @@ Unlike Retool, where you are limited to pre-written templates by the Retool team
 		href="https://github.com/windmill-labs/windmill"
 	/>
     <DocCard
-		title="Self Host Windmill tutorial"
+		title="Self Host Windmill"
 		description="Self host Windmill in 2 minutes."
 		href="/docs/advanced/self_host/"
 	/>

diff --git a/docs/core_concepts/15_authentification/add_user_to_workspace.png b/docs/core_concepts/15_authentification/add_user_to_workspace.png
diff --git a/docs/core_concepts/15_authentification/add_user_to_workspace.png.avif b/docs/core_concepts/15_authentification/add_user_to_workspace.png.avif
diff --git a/docs/core_concepts/15_authentification/add_user_to_workspace.png.webp b/docs/core_concepts/15_authentification/add_user_to_workspace.png.webp
diff --git a/docs/core_concepts/15_authentification/index.mdx b/docs/core_concepts/15_authentification/index.mdx
@@ -34,10 +34,30 @@ To manually add users:
 
 ![Manually Add Users](./add_global_users.png "Manually Add Users")
 
-If SMTP is configured, an email will be sent to the user with their account details and instructions for accessing Windmill.
+If [SMTP is configured](../../advanced/1_self_host/index.mdx#set-up-smtp-from-the-ui), an email will be sent to the user with their account details and instructions for accessing Windmill.
 
 By default, users are not invited to any workspace, unless auto-invite has been set-up.
 
+<iframe
+	width="560"
+	height="315"
+	src="https://www.youtube.com/embed/Wyq6d0bkuGo"
+	title="YouTube video player"
+	frameborder="0"
+	allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share"
+	allowfullscreen="true"
+></iframe>
+
+<br/>
+
+<div class="grid grid-cols-2 gap-6 mb-4">
+	<DocCard
+		title="Self Host Windmill"
+		description="Self host Windmill in 2 minutes."
+		href="/docs/advanced/self_host#authentication-and-user-management"
+	/>
+</div>
+
 ## Adding Users to a Workspace
 
 Once added to an instance, users can create their own workspace. However, by default they will not be invited to any workspace.
@@ -78,7 +98,7 @@ You can also choose to invite users instead of adding them directly. You only ne
 
 <br/>
 
-The invite will be sent even if no Windmill account is created yet. Once access is created to a Windmill account, an invite will be available from the "Select a workspace" menu.
+If [SMTP is configured](../../advanced/1_self_host/index.mdx#set-up-smtp-from-the-ui), the invite will be sent even if no Windmill account is created yet. Once access is created to a Windmill account, an invite will be available from the "Select a workspace" menu.
 
 ### Auto Invite
 

diff --git a/docs/core_concepts/15_authentification/invite_manually.png b/docs/core_concepts/15_authentification/invite_manually.png
diff --git a/docs/core_concepts/15_authentification/invite_manually.png.avif b/docs/core_concepts/15_authentification/invite_manually.png.avif
diff --git a/docs/core_concepts/15_authentification/invite_manually.png.webp b/docs/core_concepts/15_authentification/invite_manually.png.webp
diff --git a/docs/getting_started/00_how_to_use_windmill/index.mdx b/docs/getting_started/00_how_to_use_windmill/index.mdx
@@ -14,7 +14,7 @@ Run it at scale on kubernetes using our [helm charts](https://github.com/windmil
 
 <div class="grid grid-cols-2 gap-6 mb-4">
 	<DocCard
-		title="Self Host Windmill tutorial"
+		title="Self Host Windmill"
 		description="Self host Windmill in 2 minutes."
 		href="/docs/advanced/self_host/"
 	/>

diff --git a/docs/integrations/0_integrations_on_windmill.mdx b/docs/integrations/0_integrations_on_windmill.mdx
@@ -48,7 +48,7 @@ Just [reach out to us](../misc/6_getting_help/index.mdx), we'll be happy to list
 
 ### OAuth APIs
 
-On [self-hosted instances](../advanced/1_self_host/index.md), integrating OAuth APIs will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating OAuth APIs will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 | Service Provider                              | Description                                                                                                               |
 | --------------------------------------------- | ------------------------------------------------------------------------------------------------------------------------- |

diff --git a/docs/integrations/aws-s3.md b/docs/integrations/aws-s3.md
@@ -9,6 +9,12 @@
 
 <br/>
 
+:::info Self Host
+
+If you're looking for a way to self-host Windmill using AWS, see [Self-Host Windmill](../advanced/1_self_host/index.mdx).
+
+:::
+
 [Amazon S3](https://aws.amazon.com/s3/)'s API follows the same schema as any S3 compatible API.
 
 To integrate Amazon S3 to Windmill, you need to save the following elements as a [resource](../core_concepts/3_resources_and_types/index.mdx).

diff --git a/docs/integrations/aws.md b/docs/integrations/aws.md
@@ -2,6 +2,12 @@
 
 To integrate [AWS](https://aws.amazon.com/) to Windmill, you need to save the following elements as a [resource](../core_concepts/3_resources_and_types/index.mdx).
 
+:::info Self Host
+
+If you're looking for a way to self-host Windmill using AWS, see [Self-Host Windmill](../advanced/1_self_host/index.mdx).
+
+:::
+
 ![Add AWS Resource](../assets/integrations/add-aws.png.webp)
 
 | Property           | Type   | Description                        | Default | Required | Where to Find                                                             |

diff --git a/docs/integrations/gcal.md b/docs/integrations/gcal.md
@@ -13,7 +13,7 @@
 
 The [Google Calendar](https://calendar.google.com/) integration is done through OAuth. You just need to sign in from your Google account on your browser. The access will be automatically saved to the workspace as a [resource](../core_concepts/3_resources_and_types/index.mdx).
 
-On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 :::tip
 

diff --git a/docs/integrations/gcp.md b/docs/integrations/gcp.md
@@ -4,6 +4,12 @@ To integrate [GCP](https://cloud.google.com/gcp) to Windmill, you need to save t
 
 ![Add Google Cloud Platform Resource](../assets/integrations/add-gcp.png.webp)
 
+:::info Self Host
+
+If you're looking for a way to self-host Windmill using GCP, see [Self-Host Windmill](../advanced/1_self_host/index.mdx).
+
+:::
+
 | Property                    | Type   | Description                                          | Default | Required | Where to Find                                                                                     |
 | --------------------------- | ------ | ---------------------------------------------------- | ------- | -------- | ------------------------------------------------------------------------------------------------- |
 | type                        | string | Type of credentials object                           |         | false    | Google Cloud Console > APIs & Services > Credentials > Create service account key > JSON key file |

diff --git a/docs/integrations/gdrive.md b/docs/integrations/gdrive.md
@@ -13,7 +13,7 @@
 
 The [Google Drive](https://drive.google.com/drive/my-drive?hl=fr) integration is done through OAuth. You just need to sign in from your Google account on your browser. The access will be automatically saved to the workspace as a [resource](../core_concepts/3_resources_and_types/index.mdx).
 
-On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 :::tip
 

diff --git a/docs/integrations/github.mdx b/docs/integrations/github.mdx
@@ -15,7 +15,7 @@ import DocCard from '@site/src/components/DocCard';
 
 The [GitHub](https://github.com/) integration is done through OAuth. You just need to sign in from your GitHub account on your browser. The access will be automatically saved to the workspace as a [resource](../core_concepts/3_resources_and_types/index.mdx).
 
-On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 You might also look for how to [version control from GitHub / GitLab](../advanced/9_deploy_gh_gl/index.md).
 

diff --git a/docs/integrations/gitlab.mdx b/docs/integrations/gitlab.mdx
@@ -4,7 +4,7 @@ import DocCard from '@site/src/components/DocCard';
 
 The [GitLab](https://about.gitlab.com/) integration is done through OAuth. You just need to sign in from your GitLab account on your browser. The access will be automatically saved to the workspace as a [resource](../core_concepts/3_resources_and_types/index.mdx).
 
-On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 ![Add GitLab Resource](../assets/integrations/add-gitlab.png.webp)
 

diff --git a/docs/integrations/gmail.md b/docs/integrations/gmail.md
@@ -13,7 +13,7 @@
 
 The [Gmail](https://mail.google.com/mail/) integration is done through OAuth. You just need to sign in from your Google account on your browser. The access will be automatically saved to the workspace as a [resource](../core_concepts/3_resources_and_types/index.mdx).
 
-On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 :::tip
 

diff --git a/docs/integrations/gsheets.md b/docs/integrations/gsheets.md
@@ -13,7 +13,7 @@
 
 The [Google Sheets](https://www.google.com/sheets/about/) integration is done through OAuth. You just need to sign in from your Google account on your browser. The access will be automatically saved to the workspace as a [resource](../core_concepts/3_resources_and_types/index.mdx).
 
-On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 :::tip
 

diff --git a/docs/integrations/linkedin.md b/docs/integrations/linkedin.md
@@ -13,7 +13,7 @@
 
 The [LinkedIn](https://www.linkedin.com/) integration is done through OAuth. You just need to sign in from your LinkedIn account on your browser. The access will be automatically saved to the workspace as a [resource](../core_concepts/3_resources_and_types/index.mdx).
 
-On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 :::tip
 

diff --git a/docs/integrations/slack.mdx b/docs/integrations/slack.mdx
@@ -32,7 +32,7 @@ select the "Slack Command" tab. On there, click "Connect to Slack".
 
 :::info Self-hosted
 
-The Slack integration is done through OAuth. On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+The Slack integration is done through OAuth. On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 :::
 
@@ -186,7 +186,7 @@ back to Windmill, where you can name your Slack Resource and Save it.
 
 :::note
 
-On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
 
 :::
 

diff --git a/docs/intro.mdx b/docs/intro.mdx
@@ -1,5 +1,5 @@
 import DocCard from '@site/src/components/DocCard';
-import { Book, Pen } from 'lucide-react';
+import { Book, Pen, Home, Cloud } from 'lucide-react';
 
 # Introduction
 
@@ -28,6 +28,19 @@ Start building now using our **<a href="https://app.windmill.dev/" rel="nofollow
 		href="/docs/misc/note_of_intent"
 		Icon={Pen}
 	/>
+	<DocCard
+		title="Self Host Windmill"
+		description="Self host Windmill in 2 minutes."
+		href="/docs/advanced/self_host/"
+		Icon={Home}
+	/>
+	<DocCard
+		target="_blank"
+		title="Windmill Cloud"
+		description="Use Windmill's Cloud App (no credit card required)."
+		href="https://app.windmill.dev/"
+		Icon={Cloud}
+	/>
 </div>
 
 ## Quickstarts
@@ -79,6 +92,7 @@ However the 3 core layers of Windmill, namely Scripts, Flows and Apps are comple
 		title="Triggering Flows"
 		description="Trigger flows on-demand, by schedule or on external events."
 		href="/docs/getting_started/trigger_flows"
+		color="teal"
 	/>
 	<DocCard
 		title="Script Editor"

diff --git a/docs/misc/0_note_of_intent/index.md b/docs/misc/0_note_of_intent/index.md
@@ -130,8 +130,8 @@ You will find more details on our view over our space and competitors in the
 [Windmill compared to its peers](../../compared_to/peers.mdx) page.
 
 :::info About
-**[Windmill](https://www.windmill.dev/)** is an **[open-source](https://github.com/windmill-labs/windmill)** and **[self-hostable](../../advanced/1_self_host/index.md)** serverless runtime and platform combining the power of code with the velocity of low-code. We turn your scripts into internal apps and composable steps of flows that automate repetitive workflows.
+**[Windmill](https://www.windmill.dev/)** is an **[open-source](https://github.com/windmill-labs/windmill)** and **[self-hostable](../../advanced/1_self_host/index.mdx)** serverless runtime and platform combining the power of code with the velocity of low-code. We turn your scripts into internal apps and composable steps of flows that automate repetitive workflows.
 
-You can **[self-host](../../advanced/1_self_host/index.md)** Windmill using a `docker compose up`, our go with the **<a href="https://app.windmill.dev/" rel="nofollow">Cloud App</a>**.
+You can **[self-host](../../advanced/1_self_host/index.mdx)** Windmill using a `docker compose up`, our go with the **<a href="https://app.windmill.dev/" rel="nofollow">Cloud App</a>**.
 
 :::
-Original file line number
+Diff line change
@@ Expand Up / @@ -13,7 +13,7 @@ @@
     The [Google Calendar](https://calendar.google.com/) integration is done through OAuth. You just need to sign in from your Google account on your browser. The access will be automatically saved to the workspace as a [resource](../core_concepts/3_resources_and_types/index.mdx).
-    On [self-hosted instances](../advanced/1_self_host/index.md), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
+    On [self-hosted instances](../advanced/1_self_host/index.mdx), integrating an OAuth API will require [Setup OAuth and SSO](../misc/2_setup_oauth/index.md).
     :::tip
@@ Expand Down @@