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.
• Update the instance settings in the Windmill instance to point to the hub.
• Optionally, you can restrict access to the hub by setting the API_SECRET environment variable in the .env file. Make sure to set it as well in the Windmill instance settings.

You can enable HTTPS handling by Caddy by adding the 443 port to the Caddy service in the docker-compose.yml file.

Required configuration on the Windmill instance for authentication

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). After setting the COOKIE_DOMAIN, make sure to logout and login again.

Debugging

• You can enable debug logs by setting DEBUG_LOG=true in the environment section of the hub service in the docker-compose.yml file.
• The hub exposes a debug page at /debug that displays the configuration and status of the hub.
• If you need more support, please share with us the logs and and the debug page output.

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.

Import scripts from the official Windmill hub

You can use the hub cli to pull scripts locally from the official Windmill hub and push them to your private hub.