Skip to content

Commit a624ffd

Browse files
authored
Add info about local configuration files
1 parent fad6f42 commit a624ffd

File tree

1 file changed

+28
-0
lines changed

1 file changed

+28
-0
lines changed

README.md

Lines changed: 28 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -55,3 +55,31 @@ See [HyperFlow Kubernetes deployment](https://github.com/hyperflow-wms/hyperflow
5555
* Start the RabbitMQ container: `docker run -d --name rabbitmq rabbitmq:3`
5656
* Add option `-e AMQP_URL=amqp://rabbitmq`
5757
* More information in the [hyperflow-amqp-executor](https://github.com/hyperflow-wms/hyperflow-amqp-executor) project (warning: currently not maintained and not tested with latest HyperFlow versions)
58+
59+
### Local configuration files
60+
You can provide workflow configuration through local configuration files:
61+
* `workflow.config.json` -- main configuration file
62+
* `workflow.config.{name}.json` -- any number of secondary configuration files
63+
64+
The content from all configuration files will be merged and passed to workflow functions via `context.appConfig`. For example for files:
65+
```
66+
workflow.config.json:
67+
{
68+
"main": "mainValue"
69+
}
70+
71+
workflow.config.foo.json:
72+
{
73+
"secondary": "secondaryValue"
74+
}
75+
```
76+
The following will be passed in `context.appConfig`:
77+
```
78+
{
79+
"main": "mainValue",
80+
"foo": {
81+
"secondary": "secondaryValue"
82+
}
83+
}
84+
```
85+

0 commit comments

Comments
 (0)