Skip to content

docs: quick starter #37

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
merged 1 commit into from
Apr 18, 2023
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
32 changes: 30 additions & 2 deletions docs/getting_started.md
Original file line number Diff line number Diff line change
Expand Up @@ -103,9 +103,37 @@

## Quick Starter with Running in Your Laptop
- [Install and run Docker](https://docs.docker.com/engine/install/)
- Start a NGINX Lambda Gateway
- Stop a NGINX Lambda Gateway
- Start a NGINX Lambda Gateway container
```bash
make start
```

- Check if a NGINX Lambda Gateway container is running
```bash
make watch
```

![](./img/make-watch.png)

- Invoke a Lambda Function ARN via NGINX Lambda Gateway

```bash
curl --location 'http://localhost/2015-03-31/functions/foo/invocations' \
--header 'Content-Type: application/json' \
--data '{
"message": "This is a sample message"
}'
```

- Stop a NGINX Lambda Gateway container
```bash
make down
```

- Clean a NGINX Lambda Gateway Container Image
```bash
make clean
```

## Running as a Systemd Service
- TBD
Expand Down
Binary file added docs/img/make-watch.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.