This addon sets up a n8n instance for your DDEV project. n8n is a free and open fair-code licensed node based Workflow Automation Tool.

1. Run ddev get netz98/ddev-n8n to install the addon in your exiting ddev project.
2. ddev restart to restart your project.

After installation, you can access the n8n instance by visiting https://<yourname>.ddev.site:5678 and using the username and password you set.

Run ddev describe to list your project's services and their URLs.

Settings are in general defined in the file .ddev/docker-compose.n8n.yaml via environment variables.

A list of all available environment variables can be found in the reference here: https://docs.n8n.io/hosting/environment-variables/environment-variables/

The timezone is set to "Europe/Berlin". Why? Because we are from Germany. Change the environment variable GENERIC_TIMEZONE to your timezone.

The n8n service uses the standard SQLite database. The SQLite database file will be created as file .ddev/n8n/database.sqlite during the n8n container startup.

We deliver the startup scripts to use the existing DDEV MySQL server (if configured). The n8n/startup-script.sh creates a new database named n8n during startup of the container.

To use MySQL you have to uncomment some configurations in the docker-compose.n8n.yaml file.

Please note that the mysql support was depprecated by n8n. It is recommended to use Postgres. The latest n8n version had also startup issues in the ddev setup.

n8n logs are directed to the container's stdout. You can view the logs with ddev logs -s n8n.

The n8n service can protected with basic authentication. It's disabled by default.

You can enable it by changing the variable N8N_BASIC_AUTH_ACTIVE in .ddev/docker-compose.n8n.yaml to true. The username and password can be configured in the same file.