You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+10-8Lines changed: 10 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -13,9 +13,10 @@ Browse the [wiki pages](https://github.com/balis/hyperflow/wiki) to learn more a
13
13
### Installation
14
14
* Install Node.js (http://nodejs.org)
15
15
* Install Redis (http://redis.io)
16
-
* Install HyperFlow: <br>`npm install https://github.com/hyperflow-wms/hyperflow/archive/{version}.tar.gz` (where `{version}` is for example `v1.3.38`)
17
-
* For latest features, install from the master branch: <br>`npm install https://github.com/hyperflow-wms/hyperflow/archive/master.tar.gz`
18
-
* Add `<install_root>/node_modules/.bin` to your path
16
+
* Install HyperFlow:
17
+
* From npm package: `npm install -g @hyperflow/hyperflow`
18
+
* From github repository:<br>`npm install https://github.com/hyperflow-wms/hyperflow/archive/{version}.tar.gz`<br>(where `{version}` is for example `v1.5.0`)
19
+
* From the master branch: <br>`npm install https://github.com/hyperflow-wms/hyperflow/archive/master.tar.gz`
19
20
20
21
### Running locally
21
22
* Start the redis server: `redis-server`
@@ -40,7 +41,7 @@ docker run -a stdout -a stderr --rm --network container:redis \
*`hyperflowwms/soykb-workflow-worker` is the name of the workflow worker container ([Soykb](https://github.com/hyperflow-wms/soykb-workflow) in this case)
44
+
*`hyperflowwms/soykb-worker` is the name of the workflow worker container ([Soykb](https://github.com/hyperflow-wms/soykb-workflow) in this case)
44
45
* current directory contains `workflow.json`
45
46
* subdirectory `inputs` contains workflow input data
46
47
@@ -51,12 +52,13 @@ Outputs:
51
52
### Running in a Kubernetes cluster
52
53
See [HyperFlow Kubernetes deployment](https://github.com/hyperflow-wms/hyperflow-k8s-deployment) project for more information.
53
54
54
-
### Running in a distributed infrastructure using the RabbitMQ executor
55
+
### Running in a distributed infrastructure using the RabbitMQ executor (not maintained)
55
56
* Start the RabbitMQ container: `docker run -d --name rabbitmq rabbitmq:3`
56
57
* Add option `-e AMQP_URL=amqp://rabbitmq`
57
-
* 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
+
* More information in the [hyperflow-amqp-executor](https://github.com/hyperflow-wms/hyperflow-amqp-executor) project
59
+
***Warning**: currently not maintained and not tested with latest HyperFlow versions
58
60
59
-
###Local configuration files
61
+
## Local configuration files
60
62
You can provide workflow configuration through local configuration files:
61
63
*`workflow.config.json` -- main configuration file
62
64
*`workflow.config.{name}.json` -- any number of secondary configuration files
@@ -83,7 +85,7 @@ The following will be passed in `context.appConfig`:
83
85
}
84
86
```
85
87
86
-
###HyperFlow server
88
+
## HyperFlow server
87
89
The HyperFlow engine can be started in a server mode using command: ```hflow start-server```
88
90
89
91
If succesfully started, the server prints its URL:
0 commit comments