From 4d0952cec63e66ec39446e5b3a63c1bb69ff8a4b Mon Sep 17 00:00:00 2001 From: yohamta Date: Mon, 25 Jul 2022 18:29:28 +0900 Subject: [PATCH] docs: Update explanation about default DAGs directory for `scheduler` and `server` command --- README.md | 5 +++-- 1 file changed, 3 insertions(+), 2 deletions(-) diff --git a/README.md b/README.md index bc150cad4..d2e7d10bb 100644 --- a/README.md +++ b/README.md @@ -110,7 +110,7 @@ Download the latest binary from the [Releases page](https://github.com/yohamta/d Start the server with `dagu server` and browse to `http://127.0.0.1:8080` to explore the Web UI. -Note: Dagu reads YAML files placed in the current directory by default. To change the DAGs directory please create a config file. See [Admin Configuration](#admin-configuration) for more detail. Will fix this behavior soon. +*Note: Dagu reads YAML files placed in `~/.dagu/dags` by default. To change the DAGs directory please create a config file. See [Admin Configuration](#admin-configuration) for more detail.* ### 2. Create a new DAG @@ -386,6 +386,7 @@ The global configuration file `~/.dagu/config.yaml` is useful to gather common s You can customize the admin web UI by environment variables. +- `DAGU__DAGS` - path to directory for DAG files (default : `~/.dagu/dags`) - `DAGU__DATA` - path to directory for internal use by dagu (default : `~/.dagu/data`) - `DAGU__LOGS` - path to directory for logging (default : `~/.dagu/logs`) - `DAGU__ADMIN_PORT` - port number for web URL (default : `8080`) @@ -399,7 +400,7 @@ Please create `~/.dagu/admin.yaml`. ```yaml host: # default value is 127.0.0.1 port: # default value is 8000 -dags: # default value is current working directory +dags: # [optional] default value is ~/.dagu/dags command: # [optional] required if the dagu command not in $PATH isBasicAuth: # [optional] basic auth config basicAuthUsername: # [optional] basic auth config