diff --git a/blog/2023-11-24-data-pipeline-orchestrator/index.mdx b/blog/2023-11-24-data-pipeline-orchestrator/index.mdx
index 1110dfd5f..5dea86bcb 100644
--- a/blog/2023-11-24-data-pipeline-orchestrator/index.mdx
+++ b/blog/2023-11-24-data-pipeline-orchestrator/index.mdx
@@ -22,9 +22,9 @@ An ETL is nothing else than a [DAG](https://en.wikipedia.org/wiki/Directed_acycl
Windmill enables building fast, powerful, reliable, and easy-to-build data pipelines:
-- The DX in Windmill allows you to quickly [assemble flows](/docs/flows/flow_editor) that can process data step by step in a visual and easy-to-manage way ;
-- You can control [parallelism](/docs/flows/flow_branches#branch-all) between individual steps, and set [concurrency limits](/docs/flows/concurrency_limit) in case external resources need are fragile or rate limited ;
-- [Windmill flows can be restarted from any step](../2023-11-24-restartable-flows/index.mdx), making the iteration process of building a pipeline (or debugging one) smooth and efficient ;
+- The DX in Windmill allows you to quickly [assemble flows](/docs/flows/flow_editor) that can process data step by step in a visual and easy-to-manage way;
+- You can control [parallelism](/docs/flows/flow_branches#branch-all) between individual steps, and set [concurrency limits](/docs/flows/concurrency_limit) in case external resources need are fragile or rate limited;
+- [Windmill flows can be restarted from any step](../2023-11-24-restartable-flows/index.mdx), making the iteration process of building a pipeline (or debugging one) smooth and efficient;
- Monitoring is made easy with [error and recovery handlers](/docs/core_concepts/error_handling).
+
+
+
## Windmill integration with Polars and DuckDB for data pipelines
diff --git a/docs/core_concepts/38_object_storage_in_windmill/index.mdx b/docs/core_concepts/38_object_storage_in_windmill/index.mdx
index ef21ff42f..25e742d8d 100644
--- a/docs/core_concepts/38_object_storage_in_windmill/index.mdx
+++ b/docs/core_concepts/38_object_storage_in_windmill/index.mdx
@@ -20,7 +20,7 @@ Once you've created an [S3 or Azure Blob resource](../../integrations/s3.mdx) in
-From now on, Windmill will be connected to this bucket and you'll have easy access to it from the code editor and the job run details. If a script takes as input a `s3object`, you will see in the input form on the right a button helping you choose the file directly from the bucket.
+From now on, Windmill will be connected to this bucket and you'll have easy access to it from the code editor and the job run details. If a script [takes as input](#take-a-file-as-input) a `s3object`, you will see in the input form on the right a button helping you choose the file directly from the bucket.
Same for the result of the script. If you return an `s3object` containing a [key](../19_rich_display_rendering/index.mdx#s3) `s3` pointing to a file inside your bucket, in the result panel there will be a button to open the bucket explorer to visualize the file.
S3 files in Windmill are just pointers to the S3 object using its key. As such, they are represented by a simple JSON:
@@ -33,6 +33,8 @@ S3 files in Windmill are just pointers to the S3 object using its key. As such,
+### Resources permissions
+
The resource can be set to be public with toggle "S3 resource details can be accessed by all users of this workspace".
In this case, the [permissions](../16_roles_and_permissions/index.mdx#path) set on the resource will be ignored when users interact with the S3 bucket via Windmill. Note that when the resource is public, the users might be able to access all of its details (including access keys and secrets) via some Windmill endpoints.
@@ -61,7 +63,19 @@ export async function main() {
-### Read a file from S3 within a script
+### Read a file from S3 or object storage within a script
+
+`S3Object` is a type that represents a file in S3 or object storage.
+
+S3 files in Windmill are just pointers to the S3 object using its key. As such, they are represented by a simple JSON:
+
+```json
+{
+ "s3": "path/to/file"
+}
+```
+
+You can read a file from S3 or object storage within a script using the `loadS3File` and `loadS3FileStream` functions from the [TypeScript client](../../advanced/2_clients/ts_client.mdx) and the `wmill.load_s3_file` and `wmill.load_s3_file_stream` functions from the [Python client](../../advanced/2_clients/python_client.md).
@@ -71,16 +85,21 @@ export async function main() {
import * as wmill from 'windmill-client';
import { S3Object } from 'windmill-client';
-export async function main(input_file: S3Object) {
+export async function main() {
+
+ const example_file: S3Object = {
+ s3: 'path/to/file'
+ };
+
// Load the entire file_content as a Uint8Array
- const file_content = await wmill.loadS3File(input_file);
+ const file_content = await wmill.loadS3File(example_file);
const decoder = new TextDecoder();
const file_content_str = decoder.decode(file_content);
console.log(file_content_str);
// Or load the file lazily as a Blob
- let fileContentBlob = await wmill.loadS3FileStream(input_file);
+ let fileContentBlob = await wmill.loadS3FileStream(example_file);
console.log(await fileContentBlob.text());
}
```
@@ -91,18 +110,23 @@ export async function main(input_file: S3Object) {
```ts
import * as wmill from 'npm:windmill-client@1.253.7';
-import S3Object from 'npm:windmill-client@1.253.7';
+import { S3Object } from 'npm:windmill-client@1.253.7';
+
+export async function main() {
+
+ const example_file: S3Object = {
+ s3: 'path/to/file'
+ };
-export async function main(input_file: S3Object) {
// Load the entire file_content as a Uint8Array
- const file_content = await wmill.loadS3File(input_file);
+ const file_content = await wmill.loadS3File(example_file);
const decoder = new TextDecoder();
const file_content_str = decoder.decode(file_content);
console.log(file_content_str);
// Or load the file lazily as a Blob
- let fileContentBlob = await wmill.loadS3FileStream(input_file);
+ let fileContentBlob = await wmill.loadS3FileStream(example_file);
console.log(await fileContentBlob.text());
}
```
@@ -115,13 +139,16 @@ export async function main(input_file: S3Object) {
import wmill
from wmill import S3Object
-def main(input_file: S3Object):
- # Load the entire file_content as a bytes array
- file_content = wmill.load_s3_file(input_file)
+def main():
+
+ example_file = S3Object(s3='path/to/file')
+
+ # Load the entire file_content as a bytes array
+ file_content = wmill.load_s3_file(example_file)
print(file_content.decode('utf-8'))
# Or load the file lazily as a Buffered reader:
- with wmill.load_s3_file_reader(input_file) as file_reader:
+ with wmill.load_s3_file_reader(example_file) as file_reader:
print(file_reader.read())
```
@@ -130,11 +157,81 @@ def main(input_file: S3Object):
-:::info
Certain file types, typically parquet files, can be [directly rendered by Windmill](../19_rich_display_rendering/index.mdx).
-:::
-### Create a file in S3 within a script
+### Take a file as input
+
+Scripts can accept a S3Object as input.
+
+
+
+
+
+```ts
+import * as wmill from 'windmill-client';
+import { S3Object } from 'windmill-client';
+
+export async function main(input_file: S3Object) {
+
+// rest of the code
+
+}
+```
+
+
+
+
+
+```ts
+import * as wmill from 'npm:windmill-client@1.253.7';
+import { S3Object } from 'npm:windmill-client@1.253.7';
+
+export async function main(input_file: S3Object) {
+
+// rest of the code
+
+}
+```
+
+
+
+
+
+```python
+import wmill
+from wmill import S3Object
+
+def main(input_file: S3Object):
+
+# Rest of the code
+```
+
+
+
+
+The [auto-generated UI](../6_auto_generated_uis/index.mdx) will display a file uploader:
+
+
+
+or you can fill path manually if you enable 'Raw S3 object input':
+
+
+
+and access bucket explorer if [resource permissions](#resources-permissions) allow it:
+
+
+
+That's also the recommended way to [pass](../../flows/16_architecture.mdx) S3 files as input to steps within [flows](../../flows/1_flow_editor.mdx).
+
+
+
+
+
+
+
+### Create a file from S3 or object storage within a script
+
+You can create a file from S3 or object storage within a script using the `writeS3File` function from the [TypeScript client](../../advanced/2_clients/ts_client.mdx) and the `wmill.write_s3_file` function from the [Python client](../../advanced/2_clients/python_client.md).
@@ -162,7 +259,7 @@ export async function main(s3_file_path: string) {
```ts
import * as wmill from 'npm:windmill-client@1.253.7';
-import S3Object from 'npm:windmill-client@1.253.7';
+import { S3Object } from 'npm:windmill-client@1.253.7';
export async function main(s3_file_path: string) {
const s3_file_output: S3Object = {
@@ -200,7 +297,7 @@ def main(s3_file_path: str):
For more info on how to use files and S3 files in Windmill, see [Handling files and binary data](../18_files_binary_data/index.mdx).
-### Secondary S3 Storage
+### Secondary storage
Read and write from a storage that is not your main storage by specifying it in the S3 object as "secondary_storage" with the name of it.
@@ -212,7 +309,7 @@ Then from script, you can specify the secondary storage with an object with prop
const file = {s3: 'folder/hello.txt', storage: 'storage_1'}
```
-Here is an example of the [Create](#create-a-file-in-s3-within-a-script) then [Read](#read-a-file-from-s3-within-a-script) a file from S3 within a script with secondary storage named "storage_1":
+Here is an example of the [Create](#create-a-file-from-s3-or-object-storage-within-a-script) then [Read](#read-a-file-from-s3-or-object-storage-within-a-script) a file from S3 within a script with secondary storage named "storage_1":
```ts
import * as wmill from 'windmill-client';
@@ -259,7 +356,7 @@ Under [Enterprise Edition](/pricing), Instance object storage offers advanced fe
-### Large logs management with S3
+### Large job logs management
To optimize log storage and performance, Windmill leverages S3 for log management. This approach minimizes database load by treating the database as a temporary buffer for up to 5000 characters of logs per job.
@@ -267,7 +364,7 @@ For jobs with extensive logging needs, Windmill [Enterprise Edition](/pricing) u
This allows the handling of large-scale logs with minimal database impact, supporting more efficient and scalable workflows.
-For large logs storage (and display) and cache for distributed Python jobs, you can [connect your instance to a bucket](../20_jobs/index.mdx#large-logs-management-with-s3). This feature is at the Instance-level, and has no overlap with the Workspace object storage.
+For large logs storage (and display) and cache for distributed Python jobs, you can [connect your instance to a bucket](../20_jobs/index.mdx#large-job-logs-management). This feature is at the Instance-level, and has no overlap with the Workspace object storage.
### Instance object storage distributed cache for Python, Rust, Go
@@ -294,7 +391,7 @@ The first time a dependency is seen by a worker, if it is not cached locally, th
1. If it is not, install the dependency from pypi, then do a snapshot of installed dependency, tar it and push it to S3 (we call this a "piptar").
2. If it is, simply pull the "piptar" and extract it in place of installing from pypi. It is much faster than installing from pypi because that S3 is much closer to your workers than pypi and because there is no installation step to be done, a simple tar extract is sufficient which takes no compute.
-### Log storage
+### Service logs storage
[Logs are stored in S3](../36_service_logs/index.mdx) if S3 instance object storage is configured. This option provides more scalable storage and is ideal for larger-scale deployments or where long-term log retention is important.
diff --git a/docs/core_concepts/38_object_storage_in_windmill/s3_bucket_explorer.png b/docs/core_concepts/38_object_storage_in_windmill/s3_bucket_explorer.png
new file mode 100644
index 000000000..1bae67acc
Binary files /dev/null and b/docs/core_concepts/38_object_storage_in_windmill/s3_bucket_explorer.png differ
diff --git a/docs/core_concepts/38_object_storage_in_windmill/s3_file_input.png b/docs/core_concepts/38_object_storage_in_windmill/s3_file_input.png
new file mode 100644
index 000000000..370cdaa95
Binary files /dev/null and b/docs/core_concepts/38_object_storage_in_windmill/s3_file_input.png differ
diff --git a/docs/core_concepts/38_object_storage_in_windmill/s3_file_input_in_flow.png b/docs/core_concepts/38_object_storage_in_windmill/s3_file_input_in_flow.png
new file mode 100644
index 000000000..9b11ebce4
Binary files /dev/null and b/docs/core_concepts/38_object_storage_in_windmill/s3_file_input_in_flow.png differ
diff --git a/docs/core_concepts/38_object_storage_in_windmill/s3_file_input_in_flow_1.png b/docs/core_concepts/38_object_storage_in_windmill/s3_file_input_in_flow_1.png
new file mode 100644
index 000000000..98bf70968
Binary files /dev/null and b/docs/core_concepts/38_object_storage_in_windmill/s3_file_input_in_flow_1.png differ
diff --git a/docs/core_concepts/38_object_storage_in_windmill/s3_file_input_in_flow_2.png b/docs/core_concepts/38_object_storage_in_windmill/s3_file_input_in_flow_2.png
new file mode 100644
index 000000000..fe0949abd
Binary files /dev/null and b/docs/core_concepts/38_object_storage_in_windmill/s3_file_input_in_flow_2.png differ
diff --git a/docs/core_concepts/38_object_storage_in_windmill/s3_raw_object_input.png b/docs/core_concepts/38_object_storage_in_windmill/s3_raw_object_input.png
new file mode 100644
index 000000000..3c65eaf2a
Binary files /dev/null and b/docs/core_concepts/38_object_storage_in_windmill/s3_raw_object_input.png differ
diff --git a/docs/core_concepts/39_http_routing/index.mdx b/docs/core_concepts/39_http_routing/index.mdx
index e407e8946..2bdadb8ca 100644
--- a/docs/core_concepts/39_http_routing/index.mdx
+++ b/docs/core_concepts/39_http_routing/index.mdx
@@ -4,7 +4,7 @@ import TabItem from '@theme/TabItem';
# Custom HTTP routes
Windmill supports custom HTTP routes to trigger a script or flow.
-They can only be created by workspace admins.
+They can only be created by [admins workspace](../../advanced/18_instance_settings/index.mdx#admins-workspace).
All properties of the route apart from the http path can be modified by any user with write access to the route.
## How to use
@@ -39,7 +39,7 @@ Preprocessors can only be written in TypeScript (Bun/Deno) or Python.
In scripts, you need to export an additional `preprocessor` function. It takes a special argument called `wm_trigger` in addition to the request body arguments and should return the transformed arguments for the main function of the script.
The `wm_trigger` contains the kind of the trigger (http, email or webhook) and an http object with the details of the request when the script is triggered via an HTTP route.
-Here are examples of a preprocessor function in TypeScript and Python:
+Here are examples of a preprocessor function in [TypeScript](../../getting_started/0_scripts_quickstart/1_typescript_quickstart/index.mdx) and [Python](../../getting_started/0_scripts_quickstart/2_python_quickstart/index.mdx):
diff --git a/docs/core_concepts/index.mdx b/docs/core_concepts/index.mdx
index 518dd8f52..64a5ee223 100644
--- a/docs/core_concepts/index.mdx
+++ b/docs/core_concepts/index.mdx
@@ -122,6 +122,11 @@ On top of its editors to build endpoints, flows and apps, Windmill comes with a
description="Scripts and flows can be triggered by email messages sent to a specific email address."
href="/docs/advanced/email_triggers"
/>
+
diff --git a/docs/getting_started/8_trigger_scripts/index.mdx b/docs/getting_started/8_trigger_scripts/index.mdx
index f0944569a..b6eeab54c 100644
--- a/docs/getting_started/8_trigger_scripts/index.mdx
+++ b/docs/getting_started/8_trigger_scripts/index.mdx
@@ -2,7 +2,7 @@ import DocCard from '@site/src/components/DocCard';
# Triggering scripts
-Scripts can be triggered in 9 ways.
+Scripts can be triggered in the following ways.
On-demand triggers:
@@ -15,7 +15,9 @@ On-demand triggers:
Triggers from external events:
-- [API](#trigger-from-api) & [Webhooks](#webhooks), including from [Slack](#webhooks-trigger-scripts-from-slack) or [Emails](#webhooks-trigger-scripts-from-emails)
+- [API](#trigger-from-api) & [Webhooks](#webhooks), including from [Slack](#webhooks-trigger-scripts-from-slack)
+- [Emails](#emails)
+- [Custom HTTP routes](#custom-http-routes)
- [Scheduling + Trigger Scripts](#scheduling--trigger-scripts)
:::info Scripts in Windmill
@@ -224,37 +226,27 @@ Windmill uses Slack to trigger scripts and flows by establishing Slackbots and c
/>
-#### Webhooks: Trigger Scripts from Emails
-
-One use case of webhooks is [triggering scripts via inbound emails using Mailchimp](../../integrations/mailchimp_mandrill.md).
-
-
-
-
+### Emails
-You can leverage [Mailchimp Mandrill](https://mailchimp.com/en/features/transactional-email/)'s capabilities to initiate scripts and flows via email-triggered events. By parsing inbound emails and routing the content to Windmill through webhooks, scripts or flows are activated, enabling automation based on email content or just their arrival.
+Scripts and flows can be triggered by email messages sent to a specific email address, leveraging [SMTP](https://www.cloudflare.com/learning/email-security/what-is-smtp/).
-### Emails
+### Custom HTTP routes
-Scripts and flows can be triggered by email messages sent to a specific email address, leveraging [SMTP](https://www.cloudflare.com/learning/email-security/what-is-smtp/).
+Windmill allows you to define custom HTTP routes for your scripts and flows.
diff --git a/docs/getting_started/9_trigger_flows/index.mdx b/docs/getting_started/9_trigger_flows/index.mdx
index 9c8b415bf..4e3604674 100644
--- a/docs/getting_started/9_trigger_flows/index.mdx
+++ b/docs/getting_started/9_trigger_flows/index.mdx
@@ -2,7 +2,7 @@ import DocCard from '@site/src/components/DocCard';
# Triggering flows
-Flows can be triggered in 8 ways.
+Flows can be triggered in the following ways.
On-demand triggers:
@@ -14,8 +14,10 @@ On-demand triggers:
Triggers from external events:
+- [API](#trigger-from-api) and [Webhooks](#webhooks), including from [Slack](#webhooks-trigger-flows-from-slack)
+- [Emails](#emails)
+- [Custom HTTP routes](#custom-http-routes)
- [Scheduling + Trigger Scripts](#scheduling--trigger-scripts)
-- [API](#trigger-from-api) and [Webhooks](#webhooks), including from [Slack](#webhooks-trigger-flows-from-slack) or [Emails](#webhooks-trigger-flows-from-emails)
## On-demand Triggers
@@ -195,37 +197,27 @@ Windmill uses Slack to trigger scripts and flows by establishing Slackbots and c
/>
-#### Webhooks: Trigger Flows from Emails
-
-One use case of webhooks is [triggering scripts via inbound emails using Mailchimp](../../integrations/mailchimp_mandrill.md).
-
-
-
-
+### Emails
-You can leverage [Mailchimp Mandrill](https://mailchimp.com/en/features/transactional-email/)'s capabilities to initiate scripts and flows via email-triggered events. By parsing inbound emails and routing the content to Windmill through webhooks, scripts or flows are activated, enabling automation based on email content or just their arrival.
+Scripts and flows can be triggered by email messages sent to a specific email address, leveraging [SMTP](https://www.cloudflare.com/learning/email-security/what-is-smtp/).
-### Emails
+### Custom HTTP routes
-Scripts and flows can be triggered by email messages sent to a specific email address, leveraging [SMTP](https://www.cloudflare.com/learning/email-security/what-is-smtp/).
+Windmill allows you to define custom HTTP routes for your scripts and flows.
diff --git a/docs/integrations/aws-s3.mdx b/docs/integrations/aws-s3.mdx
index ce3d45900..c9a9ae51b 100644
--- a/docs/integrations/aws-s3.mdx
+++ b/docs/integrations/aws-s3.mdx
@@ -13,7 +13,7 @@ Additionally, for [instance integration](../core_concepts/38_object_storage_in_w
Windmill provides a unique [resource type](https://hub.windmill.dev/resource_types/42/) for any API following the typical S3 schema.
-:::info Self Host
+:::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).
diff --git a/docs/integrations/aws.md b/docs/integrations/aws.md
index 0839ebbc4..f4499bfea 100644
--- a/docs/integrations/aws.md
+++ b/docs/integrations/aws.md
@@ -4,7 +4,7 @@
To integrate AWS to Windmill, you need to save the following elements as a [resource](../core_concepts/3_resources_and_types/index.mdx).
-:::info Self Host
+:::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).
diff --git a/docs/integrations/gcp.md b/docs/integrations/gcp.md
index 1c411688f..50043294b 100644
--- a/docs/integrations/gcp.md
+++ b/docs/integrations/gcp.md
@@ -6,7 +6,7 @@ To integrate GCP to Windmill, you need to save the following elements as a [reso
-:::info Self Host
+:::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).
diff --git a/docs/integrations/mailchimp_mandrill.md b/docs/integrations/mailchimp_mandrill.md
index c1fad21c4..c1c57477c 100644
--- a/docs/integrations/mailchimp_mandrill.md
+++ b/docs/integrations/mailchimp_mandrill.md
@@ -149,8 +149,8 @@ def main(input_email):
At last, you may be in a situation where you want to extract the relevant details for both forwarded and directly routed e-mails. Meaning:
-- if A directly sent e-mail, treat contact details of A ;
-- if A forwarded e-mail from B, treat contact details of B.
+- if A directly sent e-mail, treat contact details of A
+- if A forwarded e-mail from B, treat contact details of B
Then you have two solutions:
diff --git a/docs/misc/14_saml_and_scim/index.md b/docs/misc/14_saml_and_scim/index.md
index 021d02c75..02cf89014 100644
--- a/docs/misc/14_saml_and_scim/index.md
+++ b/docs/misc/14_saml_and_scim/index.md
@@ -2,7 +2,7 @@
Setting up SAML and SCIM allows you to authenticate users using your identity provider.
-This feature is available under [Enterprise Edition](/pricing). Configuration is set from [Instance Settings](../../advanced/18_instance_settings/index.mdx#scimsaml)
+This feature is available under [Enterprise Edition](/pricing). Configuration is set from [Instance settings](../../advanced/18_instance_settings/index.mdx#scimsaml)
## SAML
@@ -12,9 +12,9 @@ ACS Url is `/api/saml/acs`
SCIM connector is `/api/scim`
Application username format is `Email`
-
+
-In the Instance Settings UI, pass the SAML Metadata URL (or content) containing the metadata URL (or XML content).
+In the Instance settings UI, pass the SAML Metadata URL (or content) containing the metadata URL (or XML content).
### Okta
@@ -22,9 +22,9 @@ Configure Okta with the following settings (and replace cf.wimill.xyz with your
-
+
-In the Instance Settings UI, pass the SAML Metadata URL (or content) containing the metadata URL (or XML content).
+In the Instance settings UI, pass the SAML Metadata URL (or content) containing the metadata URL (or XML content).
@@ -48,9 +48,9 @@ Edit the configuration to set the Entity ID to `windmill` and the ACS url to `
@@ -49,7 +49,7 @@ First, you need to create a Google OAuth Client:
- Click Create.
- Copy the **Client ID** and **Client Secret** from the "OAuth Client" modal.
-[Instance Settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - 'SSO' - Toggle "Google" and set client id, org and client secret.
+[Instance settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - 'SSO' - Toggle "Google" and set client id, org and client secret.
### Microsoft
@@ -64,7 +64,7 @@ Also set "Accounts in any organizational directory (Any Microsoft Entra ID tenan
Multitenant) and personal Microsoft accounts (e.g. Skype, Xbox)", you can restrict the
emails directly in Windmill using the "allowed_domains" setting.
-[Instance Settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "microsoft" and set client id, org and client secret.
+[Instance settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "microsoft" and set client id, org and client secret.
### Okta
@@ -92,14 +92,14 @@ From your Admin page, setup Windmill using the service flow:
- "Login initiated by" `App Only`
- "Initiate login URI" `https:///user/login`
-[Instance Settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "okta" and set client id, org and client secret.
+[Instance settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "okta" and set client id, org and client secret.
### GitHub
Redirect URI: `https:///user/login_callback/github`
Login: `https:///user/login`
-[Instance Settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "github" and set client id, org and client secret.
+[Instance settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "github" and set client id, org and client secret.
### GitLab
@@ -108,7 +108,7 @@ Login: `https:///user/login`
GitLab's Single Sign-On integration is supported by Windmill. Detailed steps for setting up GitLab as an OAuth SSO provider will be provided in the upcoming documentation but the entry for the oauth.json is as following:
-[Instance Settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "gitlab" and set client id, org and client secret.
+[Instance settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "gitlab" and set client id, org and client secret.
### Jumpcloud
@@ -126,13 +126,13 @@ Attribute Mapping, Standard Scopes: Check Email
Add the proper groups then click save. You should see your Client ID and Client Secret on the next screen then add the following entry "jumpcloud":
-[Instance Settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "jumpcloud" and set client id and client secret, and "Client Authentication Type" to "Client Secret Basic"
+[Instance settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' - Toggle "jumpcloud" and set client id and client secret, and "Client Authentication Type" to "Client Secret Basic"
### Keycloak
-Setup your realm in Keycloak and set Keycloak in [Instance Settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' and Keycloak
+Setup your realm in Keycloak and set Keycloak in [Instance settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' and Keycloak
### Authentik
@@ -147,7 +147,7 @@ To integrate Windmill with Authentik as an OAuth provider, follow these steps:
- **Grant Types**: Authorization Code, Refresh Token
- After saving the application, you will be provided with a **Client ID** and **Client Secret**.
-2. **Instance Settings in Windmill**:
+2. **Instance settings in Windmill**:
- Go to Windmill's admin settings under 'SSO OAuth' - 'SSO'.
- Toggle "authentik" and enter:
- **Authentik URL**: `https:///application/o/authorize/`
@@ -168,7 +168,7 @@ To integrate Windmill with Authelia as an OAuth provider, follow these steps:
- **Scopes**: OpenID, Email
- After saving, you will be given a **Client ID** and **Client Secret**.
-2. **Instance Settings in Windmill**:
+2. **Instance settings in Windmill**:
- Go to Windmill's admin settings under 'SSO OAuth' - 'SSO'.
- Toggle "authelia" and enter:
- **Authelia URL**: `https:///api/oidc/authorization`
@@ -187,7 +187,7 @@ To integrate Windmill with Kanidm as an OAuth provider, follow these steps:
- **Post-Logout Redirect URI**: `https:///user/login`
- After saving the client, you will receive a **Client ID** and **Client Secret**.
-2. **Instance Settings in Windmill**:
+2. **Instance settings in Windmill**:
- Go to Windmill's admin settings under 'SSO OAuth' - 'SSO'.
- Toggle "kanidm" and enter:
- **Kanidm URL**: `https:///ui/oauth2`
@@ -207,7 +207,7 @@ To integrate Windmill with Zitadel as an OAuth provider, follow these steps:
- **Post-Logout Redirect URI**: `https:///user/login`
- Once created, Zitadel will provide a **Client ID** and **Client Secret**.
-2. **Instance Settings in Windmill**:
+2. **Instance settings in Windmill**:
- Go to Windmill's admin settings under 'SSO OAuth' - 'SSO'.
- Toggle "zitadel" and enter:
- **Zitadel URL**: `https:///oauth/v2/authorize`
@@ -217,7 +217,7 @@ To integrate Windmill with Zitadel as an OAuth provider, follow these steps:
### Custom OAuth
-You can use other custom SSO clients from the [Instance Settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' and provide a client id to 'Add custom SSO client'.
+You can use other custom SSO clients from the [Instance settings](../../advanced/18_instance_settings/index.mdx#ssooauth) 'SSO OAuth' - - 'SSO' and provide a client id to 'Add custom SSO client'.
## OAuth
@@ -277,7 +277,7 @@ settings:
-Then from your [Instance Settings](../../advanced/18_instance_settings/index.mdx), fill with Client ID and Client Secret.
+Then from your [Instance settings](../../advanced/18_instance_settings/index.mdx), fill with Client ID and Client Secret.
@@ -299,7 +299,7 @@ Now users should be able to connect to Slack through OAuth:
- Authorization Callback URL: `https:///oauth/callback/github`
- Click "Register Application".
- Copy the **Client ID** and **Client Secret** from the application details.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "github" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "github" and set the client id and client secret.
### GitLab
@@ -311,7 +311,7 @@ Now users should be able to connect to Slack through OAuth:
- Scopes: Choose appropriate scopes like `api`, `read_user`, etc.
- Click "Save Application".
- Copy the **Application ID** and **Secret** from the application details.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gitlab" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gitlab" and set the client id and client secret.
### Bitbucket
@@ -322,7 +322,7 @@ Now users should be able to connect to Slack through OAuth:
- Redirect URI: `https:///oauth/callback/bitbucket`
- Select appropriate scopes.
- Copy the **Client ID** and **Client Secret** from the application details.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "bitbucket" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "bitbucket" and set the client id and client secret.
### Google Sheets
@@ -337,7 +337,7 @@ Now users should be able to connect to Slack through OAuth:
- Authorized Redirect URLs: `https:///oauth/callback/gsheets`
- Click Create.
- Copy the **Client ID** and **Client Secret** from the "OAuth Client" modal.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gsheet" and set client id and client secret
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gsheet" and set client id and client secret
The same steps apply to enable more APIs (**Gmail**, **Gdrive**, etc.) on your Google Account to set up the resources in Windmill.
@@ -346,42 +346,42 @@ The same steps apply to enable more APIs (**Gmail**, **Gdrive**, etc.) on your G
- Follow the instructions for Google Sheets OAuth, but search for and enable **Google Drive API** in the API services.
- Add the same Authorized Redirect URLs: `https:///oauth/callback/gdrive`.
- Use the created credentials in Windmill.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gdrive" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gdrive" and set the client id and client secret.
### Gmail
- Follow the instructions for Google Sheets OAuth, but search for and enable **Gmail API** in the API services.
- Add the same Authorized Redirect URLs: `https:///oauth/callback/gmail`.
- Use the created credentials in Windmill.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gmail" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gmail" and set the client id and client secret.
### Google Calendar (GCal)
- Follow the instructions for Google Sheets OAuth, but search for and enable **Google Calendar API** in the API services.
- Add the same Authorized Redirect URLs: `https:///oauth/callback/gcal`.
- Use the created credentials in Windmill.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gcal" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gcal" and set the client id and client secret.
### Google Forms (GForms)
- Google Forms API may use Google Drive, so follow the Google Drive API OAuth instructions.
- Add the same Authorized Redirect URLs: `https:///oauth/callback/gforms`.
- Use the created credentials in Windmill.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gforms" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gforms" and set the client id and client secret.
### Google Cloud (GCloud)
- Follow the instructions for Google Sheets OAuth, but search for and enable **Google Cloud APIs** in the API services.
- Add the same Authorized Redirect URLs: `https:///oauth/callback/gcloud`.
- Use the created credentials in Windmill.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gcloud" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gcloud" and set the client id and client secret.
### Google Workspace (GWorkspace)
- Follow the instructions for Google Sheets OAuth, but ensure you enable **Admin SDK API** in the API services.
- Add the same Authorized Redirect URLs: `https:///oauth/callback/gworkspace`.
- Use the created credentials in Windmill.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gworkspace" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "gworkspace" and set the client id and client secret.
### Basecamp
@@ -391,7 +391,7 @@ The same steps apply to enable more APIs (**Gmail**, **Gdrive**, etc.) on your G
- Name: Windmill
- Redirect URI: `https:///oauth/callback/basecamp`
- Copy the **Client ID** and **Client Secret** from the application details.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "basecamp" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "basecamp" and set the client id and client secret.
### LinkedIn
@@ -401,7 +401,7 @@ The same steps apply to enable more APIs (**Gmail**, **Gdrive**, etc.) on your G
- App Name: Windmill
- Authorized Redirect URLs: `https:///oauth/callback/linkedin`
- Copy the **Client ID** and **Client Secret**.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "linkedin" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "linkedin" and set the client id and client secret.
### QuickBooks
@@ -411,7 +411,7 @@ The same steps apply to enable more APIs (**Gmail**, **Gdrive**, etc.) on your G
- App Name: Windmill
- Redirect URL: `https:///oauth/callback/quickbooks`
- Copy the **Client ID** and **Client Secret**.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "quickbooks" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "quickbooks" and set the client id and client secret.
### Visma
@@ -421,7 +421,7 @@ The same steps apply to enable more APIs (**Gmail**, **Gdrive**, etc.) on your G
- Name: Windmill
- Redirect URI: `https:///oauth/callback/visma`
- Copy the **Client ID** and **Client Secret**.
-- [Instance Settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "visma" and set the client id and client secret.
+- [Instance settings](../../advanced/18_instance_settings/index.mdx) -> Resources -> Add OAuth "visma" and set the client id and client secret.
### Custom OAuth
diff --git a/docs/misc/7_plans_details/index.mdx b/docs/misc/7_plans_details/index.mdx
index 3145ab7e8..60f16114c 100644
--- a/docs/misc/7_plans_details/index.mdx
+++ b/docs/misc/7_plans_details/index.mdx
@@ -1,6 +1,6 @@
import DocCard from '@site/src/components/DocCard';
-# Plans & How to Upgrade
+# Plans & How to upgrade
Windmill provides a range of pricing plans for both Cloud and Self-hosted deployments. These plans are designed to accommodate individual users, small teams, and enterprise-level organizations, offering additional features, resources, enhanced capabilities, and premium support beyond the free tier. All details on the [Pricing page](/pricing).
@@ -12,7 +12,7 @@ Windmill provides a range of pricing plans for both Cloud and Self-hosted deploy
/>
-## Cloud Plans
+## Cloud plans
All Windmill Cloud plans (Community, Team, Enterprise) have most of the Enterprise features.
The only distinctions will be around the number of users, number of computations, audit logs retention period, support and some networks and security features.
@@ -32,7 +32,7 @@ All details on the [Pricing page](/pricing).
/>
-## Self-Hosted Plans
+## Self-hosted pagelans
Windmill is free and open source. If self-hosted, the number of executions will be unlimited. The Enterprise plan allows access to some useful features for the use of Windmill in a corporate use case, with technical and security specifics ([Audit logs](../../core_concepts/14_audit_logs/index.mdx), [Workspace & instance object storage](../../core_concepts/38_object_storage_in_windmill/index.mdx), [Git Sync](../../advanced/11_git_sync/index.mdx), [Worker Groups Management UI](../../core_concepts/9_worker_groups/index.mdx)).
@@ -50,7 +50,7 @@ We share our pricing grid and the features of each plan on the [Pricing page](/p
/>
-## White Labeling Windmill
+## White labeling Windmill
Windmill offers white labeling capabilities, allowing you to embed and customize the Windmill platform to align with your brand. We do provide a library to embed the entire Windmill app or specific components - such as the flow builder or the app builder - into your own application or website. This enables you to provide Windmill's services to your clients while maintaining your brand's identity.
@@ -64,7 +64,7 @@ For more information about white labeling and customization options, see:
/>
-## How to Upgrade to Each Plan
+## How to upgrade to each plan
### Upgrading to Team Edition
@@ -84,7 +84,7 @@ Team plans work at the workspace-level.
- Once you contact us, we will provide you with a secure payment link.
- Upon payment, you will get access to a dedicated Windmill instance on the cloud.
-- As an Enterprise user, you will have access to detailed usage information and invoices through the [Windmill billing portal](#windmill-customer-portal) where you can update plan usage and adjust the number of seats.
+- As an Enterprise user, you will have access to detailed usage information and invoices through the [Windmill customer portal](#windmill-customer-portal) where you can update plan usage and adjust the number of seats.
- To have a fully Enterprise Edition Windmill, we recommend also setting up:
- [SSO/SAML](../2_setup_oauth/index.mdx) for user management and authentification.
@@ -106,38 +106,39 @@ Team plans work at the workspace-level.
-- The subscription to the Enterprise Self-Host offer is done through a [secure payment link](https://billing.windmill.dev/b/8wMaFS51Y0Bl2VacMT), with a 1-month free trial.
-- You can reach out to us via contact@windmill.dev, [Discord](https://discord.com/invite/V7PM2YHsPB), or schedule a [meeting](https://www.windmill.dev/book-demo) for an introduction session.
+The subscription to the Enterprise Self-Host offer is done through a [secure payment link](https://billing.windmill.dev/b/8wMaFS51Y0Bl2VacMT), with a 1-month free trial. You can reach out to us via contact@windmill.dev, [Discord](https://discord.com/invite/V7PM2YHsPB), or schedule a [meeting](https://www.windmill.dev/book-demo) for an introduction session.
-- To have your instance switch from Free Edition to Enterprise Edition, you'll need to change the Windmill image:
- - [Docker](../../advanced/1_self_host/index.mdx#docker): in [docker-compose.yml](https://raw.githubusercontent.com/windmill-labs/windmill/main/docker-compose.yml) and [.env](https://raw.githubusercontent.com/windmill-labs/windmill/main/.env).
- - [Helm](../../advanced/1_self_host/index.mdx#enterprise-deployment-with-helm): see the [Helm chart repository README](https://github.com/windmill-labs/windmill-helm-charts).
+To have your instance switch from Free Edition to Enterprise Edition, you'll need to change the Windmill image:
+- [Docker](../../advanced/1_self_host/index.mdx#docker): in [docker-compose.yml](https://raw.githubusercontent.com/windmill-labs/windmill/main/docker-compose.yml) and [.env](https://raw.githubusercontent.com/windmill-labs/windmill/main/.env).
+- [Helm](../../advanced/1_self_host/index.mdx#enterprise-deployment-with-helm): see the [Helm chart repository README](https://github.com/windmill-labs/windmill-helm-charts).
-- If not done earlier, you can create your first workspace, but your instance will not have access to Enterprise features until the license key is passed.
-- Upon subscribing, you will receive a [license key](#using-the-license-key-self-host) to pass in the [Instance Settings](../../advanced/18_instance_settings/index.mdx#license-key). The key will self-update every day at 2 a.m CET as long as the subscription is valid (being paid). A key is valid for 35 days.
+If not done earlier, you can create your first workspace, but your instance will not have access to Enterprise features until the license key is passed.
-- To adjust the number of seats, you can update your usage on the subscription page at [Windmill billing portal](#windmill-customer-portal).
-- Windmill employs lightweight [telemetry](#usage-checks) to automatically [track and report](#usage-checks) the usage of vCPUs and seats for your subscription. We only count the vCPUs reported by your workers as being used. So you can simply set limits in the [docker-compose](https://github.com/windmill-labs/windmill/blob/main/docker-compose.yml).
+Upon subscribing, you will receive a [license key](#using-the-license-key-self-host) to pass in the [Instance settings](../../advanced/18_instance_settings/index.mdx#license-key). The key will self-update every day at 2 a.m CET as long as the subscription is valid (being paid). A key is valid for 35 days.
-- To have a fully Enterprise Edition Windmill, we recommend also setting up:
- - [SSO/SAML](../2_setup_oauth/index.mdx) for user management and authentification.
- - [S3 / Azure Blob storage integration](../../core_concepts/38_object_storage_in_windmill/index.mdx#workspace-object-storage) within a Windmill workspace to manage large data files.
- - [Instance object storage](../../core_concepts/38_object_storage_in_windmill/index.mdx#instance-object-storage) to have a dedicated S3 storage for large-scale log management and distributed dependency caching.
- - [Git Sync](../../advanced/11_git_sync/index.mdx) to have workspace synchronize with a Git repository for version control.
+To adjust the number of seats, you can update your usage on the subscription page at [Windmill customer portal](#windmill-customer-portal).
+
+Windmill employs lightweight [telemetry](#usage-checks) to automatically track and report the usage of vCPUs and seats for your subscription. We only count the vCPUs reported by your workers as being used. So you can simply set limits in the [docker-compose](https://github.com/windmill-labs/windmill/blob/main/docker-compose.yml#L50) to make sure you respect the terms of your subscription. Setting memory limits is enough.
+
+To have a fully Enterprise Edition Windmill, we recommend also setting up:
+- [SSO/SAML](../2_setup_oauth/index.mdx) for user management and authentification.
+- [S3 / Azure Blob storage integration](../../core_concepts/38_object_storage_in_windmill/index.mdx#workspace-object-storage) within a Windmill workspace to manage large data files.
+- [Instance object storage](../../core_concepts/38_object_storage_in_windmill/index.mdx#instance-object-storage) to have a dedicated S3 storage for large-scale log management and distributed dependency caching.
+- [Git Sync](../../advanced/11_git_sync/index.mdx) to have workspace synchronize with a Git repository for version control.
-- As an Enterprise user, you will have access to detailed usage information and invoices through the [Windmill billing portal](#windmill-customer-portal).
+As an Enterprise user, you will have access to detailed usage information and invoices through the [Windmill customer portal](#windmill-customer-portal).
-#### Using the License Key (Self-Host)
+#### Using the License Key (Self-host)
-To enable the license key, switch from the `windmill` image to the `windmill-ee` image in both the server and workers. From the [Instance Settings](../../advanced/18_instance_settings/index.mdx#license-key), pass the license key, "Test key" and save settings.
+To enable the license key, switch from the `windmill` image to the `windmill-ee` image in both the server and workers. From the [Instance settings](../../advanced/18_instance_settings/index.mdx#license-key), pass the license key, "Test key" and save settings.
@@ -146,7 +147,7 @@ To enable the license key, switch from the `windmill` image to the `windmill-ee`
As an [Enterprise](/pricing) user, you will have access to detailed usage information and invoices through the [Windmill Customer Portal](https://portal.windmill.dev/). You can update contact information, billing details and subscription (seats & vCPUs) from the portal.
Access to the portal is made through either:
-- From your [Instance Settings](../../advanced/18_instance_settings/index.mdx#license-key), in the "Core" tab. Where you can also renew your [license key](#self-host).
+- From your [Instance settings](../../advanced/18_instance_settings/index.mdx#license-key), in the "Core" tab. Where you can also renew your [license key](#self-host).
- Through a direct link: [portal.windmill.dev](https://portal.windmill.dev/), filling in the email address used for the subscription, and then accessing a link sent by email.
Email addresses can be added to the portal to allow multiple users to access it.
@@ -173,7 +174,7 @@ This comparison is made only for your instance of Prod, for which you can find t
/>
-## Usage Checks
+## Usage checks
Windmill employs lightweight [telemetry](/pricing#vcpu-reporting) to automatically track and report the usage of vCPUs and seats for your subscription. Even on self-hosted plans, telemetry associated to your license key is reported to Windmill.
diff --git a/sidebars.js b/sidebars.js
index 7415a8488..8ed3dc8cc 100644
--- a/sidebars.js
+++ b/sidebars.js
@@ -109,7 +109,7 @@ const sidebars = {
},
{
type: 'category',
- label: 'Examples',
+ label: 'Triggers',
collapsed: true,
items: [
{
@@ -734,7 +734,7 @@ const sidebars = {
{
type: 'category',
collapsed: false,
- label: 'Self Host',
+ label: 'Self-host',
link: {
type: 'doc',
id: 'advanced/self_host/index'
diff --git a/src/components/Pricing.js b/src/components/Pricing.js
index a9b27098d..83ff89911 100644
--- a/src/components/Pricing.js
+++ b/src/components/Pricing.js
@@ -26,7 +26,7 @@ const pricing = {
id: 'tier-free-selfhost',
href: '/docs/advanced/self_host',
price: {},
- description: 'Unlimited users & executions.',
+ description: 'Unlimited executions.',
customMessage: 'Self-host in minutes',
minPrice: 0,
features: [