From b510d519740ed910f6f346a17155accc54b968a0 Mon Sep 17 00:00:00 2001 From: HugoCasa Date: Fri, 5 Apr 2024 21:26:47 +0200 Subject: [PATCH] Create README.md --- README.md | 18 ++++++++++++++++++ 1 file changed, 18 insertions(+) create mode 100644 README.md diff --git a/README.md b/README.md new file mode 100644 index 0000000..1b9b572 --- /dev/null +++ b/README.md @@ -0,0 +1,18 @@ +# Private Windmill Hub + +## Setup + +- Fill in the `.env` file with your desired database password, the url of your Windmill instance and your license key. +- Run `docker-compose up -d` to start the hub and database. + +You can enable HTTPS handling by Caddy by adding the 443 port to the Caddy service in the docker-compose.yml file. + +Authentication on the Hub is done through the Windmill instance. Both the Hub and the Windmill instances need to be running on the same domain for the authentication to work. +For instance, if the Windmill instance is available on `windmill.example.com`, the Hub should be accessible on a similar subdomain like `hub.example.com`. You will also need to set `COOKIE_DOMAIN` in the .env file of the Windmill instance (server container) to the root domain (e.g. `example.com`). + +## Usage + +As described above, logging in on the hub will redirect you to the Windmill instance you specified in the `.env` file. +Superadmins of the Windmill instance can approve resource types, scripts, flows, and apps on the Hub. +Only approved content will be available to users on the Windmill instance. +