forked from windmill-labs/windmill
-
Notifications
You must be signed in to change notification settings - Fork 0
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Updated README -> video to be updated after merge (windmill-labs#1592)
- Loading branch information
Showing
7 changed files
with
24 additions
and
11 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -1,25 +1,38 @@ | ||
<p align="center"> | ||
<a href="https://app.windmill.dev"><img src="./imgs/windmill-banner.png" alt="windmill.dev"></a> | ||
<a href="https://www.windmill.dev/"><img src="./imgs/windmill-banner.png" alt="windmill.dev"></a> | ||
</p> | ||
<p align="center"> | ||
<em>.</em> | ||
</p> | ||
<p align=center> | ||
Open-source developer infrastructure for internal tools. Self-hostable alternative to Airplane, Pipedream, Superblocks and a simplified Temporal with autogenerated UIsm and custom UIs to trigger workflows and scripts as internal apps. Scripts are turned into UIs and no-code modules, no-code modules can be composed into very rich flows, and script and flows can be triggered from internal UIs made with a low-code builder. The script languages supported are: Python, Typescript, Go, Bash, SQL. | ||
Open-source developer infrastructure for internal tools. Self-hostable alternative to Airplane, Pipedream, Superblocks and a simplified Temporal with autogenerated UIsm and custom UIs to trigger workflows and scripts as internal apps. | ||
|
||
<p align=center> | ||
Scripts are turned into UIs and no-code modules, no-code modules can be composed into very rich flows, and script and flows can be triggered from internal UIs made with a low-code builder. The script languages supported are: Python, Typescript, Go, Bash, SQL. | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://github.com/windmill-labs/windmill/blob/main/LICENSE-AGPL" target="_blank"> | ||
<img src="https://img.shields.io/badge/License-AGPLv3-blue.svg" alt="Package version"> | ||
</a> | ||
<a href="https://github.com/windmill-labs/windmill/actions/workflows/docker-image.yml" target="_blank"> | ||
<img src="https://github.com/windmill-labs/windmill/actions/workflows/docker-image.yml/badge.svg" alt="Docker Image CI"> | ||
</a> | ||
<a href="https://pypi.org/project/wmill" target="_blank"> | ||
<img src="https://img.shields.io/pypi/v/wmill?color=%2334D058&label=pypi%20package" alt="Package version"> | ||
</a> | ||
</p> | ||
|
||
<p align="center"> | ||
<a href="https://img.shields.io/github/commit-activity/m/windmill-labs/windmill" target="_blank"> | ||
<img src="https://img.shields.io/github/commit-activity/m/windmill-labs/windmill" alt="Commit activity"> | ||
</a> | ||
<a href="https://discord.gg/V7PM2YHsPB" target="_blank"> | ||
<img src="https://discordapp.com/api/guilds/930051556043276338/widget.png" alt="Discord Shield"/> | ||
</a> | ||
</p> | ||
|
||
|
||
<p align="center"> | ||
<a href="https://app.windmill.dev">Try it</a> - <a href="https://docs.windmill.dev/docs/intro/">Docs</a> - <a href="https://discord.gg/V7PM2YHsPB">Discord</a> - <a href="https://hub.windmill.dev">Hub</a> - <a href="https://docs.windmill.dev/docs/misc/contributing">Contributor's guide</a> | ||
</p> | ||
|
@@ -29,7 +42,7 @@ Open-source developer infrastructure for internal tools. Self-hostable alternati | |
Windmill is <b>fully open-sourced (AGPLv3)</b> and Windmill Labs offers | ||
dedicated instance and commercial support and licenses. | ||
|
||
 | ||
 | ||
|
||
https://user-images.githubusercontent.com/275584/218350457-bc2fdc3b-e667-4da5-a2bd-3bacc1f0ec79.mp4 | ||
|
||
|
@@ -61,7 +74,7 @@ https://user-images.githubusercontent.com/275584/218350457-bc2fdc3b-e667-4da5-a2 | |
## Main Concepts | ||
|
||
1. Define a minimal and generic script in Python, Typescript, Go or Bash that | ||
solves a specific task. Here sending an email with SMTP. The code can be | ||
solves a specific task. Here sending a POST request. The code can be | ||
defined in the provided Web IDE or synchronized with your own github repo: | ||
 | ||
|
||
|
@@ -116,7 +129,7 @@ export async function main( | |
We have a powerful CLI to interact with the windmill platform and sync your | ||
scripts from local files, github repos and to run scripts and flows on the | ||
instance from local commands. See | ||
[more details](https://github.com/windmill-labs/windmill/tree/main/cli) | ||
[more details](https://github.com/windmill-labs/windmill/tree/main/cli). | ||
|
||
 | ||
|
||
|
@@ -125,7 +138,7 @@ instance from local commands. See | |
You can run your script locally easily, you simply need to pass the right | ||
environment variables for the `wmill` client library to fetch resources and | ||
variables from your instance if necessary. See more: | ||
<https://docs.windmill.dev/docs/advanced/local_development/> | ||
<https://docs.windmill.dev/docs/advanced/local_development/>. | ||
|
||
## Stack | ||
|
||
|
@@ -152,7 +165,7 @@ variables from your instance if necessary. See more: | |
|
||
Windmill uses [nsjail](https://github.com/google/nsjail) on top of the deno | ||
sandboxing. It is production multi-tenant grade secure. Do not take our word for | ||
it, take [fly.io's one](https://fly.io/blog/sandboxing-and-workload-isolation/) | ||
it, take [fly.io's one](https://fly.io/blog/sandboxing-and-workload-isolation/). | ||
|
||
### Secrets, credentials and sensitive values | ||
|
||
|
@@ -182,7 +195,7 @@ back to the database is ~50ms. A typical lightweight deno job will take around | |
|
||
We only provide docker-compose setup here. For more advanced setups, like | ||
compiling from source or using without a postgres super user, see | ||
[documentation](https://docs.windmill.dev/docs/advanced/self_host) | ||
[documentation](https://docs.windmill.dev/docs/advanced/self_host). | ||
|
||
### Docker compose | ||
|
||
|
@@ -196,20 +209,20 @@ docker compose up -d --pull always | |
|
||
Go to http://localhost et voilà :) | ||
|
||
The default super-admin user is: [email protected] / changeme | ||
The default super-admin user is: [email protected] / changeme. | ||
|
||
From there, you can follow the setup app and creat other users. | ||
|
||
### Kubernetes (k8s) and Helm charts | ||
|
||
We publish helm charts at: | ||
<https://github.com/windmill-labs/windmill-helm-charts> | ||
<https://github.com/windmill-labs/windmill-helm-charts>. | ||
|
||
### Postgres without superuser | ||
|
||
If you do not want, or cannot (for instance, in AWS Aurora or Cloud sql) use a | ||
postgres superuser, you can run `./init-db-as-superuser.sql` to init the | ||
required users for windmill. | ||
required users for Windmill. | ||
|
||
### Commercial license | ||
|
||
|
Binary file not shown.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.