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
+6-8Lines changed: 6 additions & 8 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,7 +1,7 @@
1
-
# serverless-step-functions-local
1
+
# serverless-step-functions-local-docker
2
2
Run AWS step functions offline with Serverless!
3
3
4
-
This is a plugin for the [Serverless Framework](https://serverless.com/). It uses [stepfunctions-localhost](https://www.npmjs.com/package/stepfunctions-localhost) to emulate step functions with AWS' provided tool for local development.
4
+
This is a plugin for the [Serverless Framework](https://serverless.com/). It uses [stepfunctions-localhost](https://www.npmjs.com/package/stepfunctions-localhost) to emulate step functions with AWS' provided tool for local development. Alternatively you can run your own emulator such as [aws-stepfunctions-local](https://hub.docker.com/r/amazon/aws-stepfunctions-local) docker container.
5
5
6
6
## Requirements
7
7
@@ -11,7 +11,7 @@ This is a plugin for the [Serverless Framework](https://serverless.com/). It us
@@ -21,8 +21,7 @@ You'll need to add this plugin to your `serverless.yml`. The plugins section sh
21
21
plugins:
22
22
...
23
23
- serverless-step-functions
24
-
- serverless-step-functions-local
25
-
- serverless-offline-lambda
24
+
- serverless-step-functions-local-docker
26
25
- serverless-offline
27
26
...
28
27
```
@@ -38,7 +37,7 @@ custom:
38
37
39
38
Although not neccessary, it's strongly recomended to add the folder with the downloaded step function executables to `.gitignore`. By default, this path is `./.step-functions-local`.
40
39
41
-
The plugin binds to port 8083, this cannot be changed.
40
+
If you decide to start the emulator automatically through `startStepFunctionsLocalApp: true` the plugin binds to port 8083, this cannot be changed.
42
41
43
42
It also adds an environment variable for each created state machine that contains the ARN for it. These variables are prefixed by `OFFLINE_STEP_FUNCTIONS_ARN_`, so the ARN of a state machine named 'WaitMachine', for example could be fetched by reading `OFFLINE_STEP_FUNCTIONS_ARN_WaitMachine`.
0 commit comments