Skip to content

Commit 3a74c33

Browse files
committed
Add environment variables explain to README
1 parent eb0cc28 commit 3a74c33

File tree

2 files changed

+15
-4
lines changed

2 files changed

+15
-4
lines changed

README.md

Lines changed: 10 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -26,5 +26,15 @@ Run serverless-offline:
2626
docker-compose up
2727
```
2828

29+
## Environment variables
30+
If you need access aws resources, you can add environment variables. Follow example: [docker-compose.yml](./docker-compose.yml)
31+
Available variables:
32+
```yml
33+
HTTP_PORT: 3001 # [OPTIONAL] Default is 3000. If you change http port, you should change your port routing in docker-compose.yml
34+
SERVERLESS_ACCESS_KEY: <SERVERLESS_ACCESS_KEY> # [OPTIONAL] Used to access resources of serverless framework
35+
AWS_ACCESS_KEY_ID: <AWS_ACCESS_KEY_ID> # [OPTIONAL] Is required if you need use aws resources, e.g.: DynamoDB
36+
AWS_SECRET_ACCESS_KEY: <AWS_SECRET_ACCESS_KEY> # [OPTIONAL] Is required if you need use aws resources, e.g.: DynamoDB
37+
```
38+
2939
## Contribute
3040
Help me to write a better image to python-serverless-offline

docker-compose.yml

Lines changed: 5 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,10 +5,11 @@ services:
55
container_name: python_serverless
66
image: lucasfrancaid/python-serverless-offline
77
environment:
8-
SERVERLESS_ACCESS_KEY: <SERVERLESS_ACCESS_KEY> # Optional
9-
AWS_ACCESS_KEY_ID: <AWS_ACCESS_KEY_ID> # Required if you need use aws resources
10-
AWS_SECRET_ACCESS_KEY: <AWS_SECRET_ACCESS_KEY> # Required if you need use aws resources
8+
HTTP_PORT: 3001
9+
SERVERLESS_ACCESS_KEY: <SERVERLESS_ACCESS_KEY>
10+
AWS_ACCESS_KEY_ID: <AWS_ACCESS_KEY_ID>
11+
AWS_SECRET_ACCESS_KEY: <AWS_SECRET_ACCESS_KEY>
1112
ports:
12-
- '3000:3000'
13+
- '3001:3001'
1314
volumes:
1415
- .:/usr/app

0 commit comments

Comments
 (0)