Skip to content

Commit

Permalink
Update README and add Contact Point (#4)
Browse files Browse the repository at this point in the history
  • Loading branch information
mikhail-vl authored Jan 15, 2024
1 parent 8459f92 commit 6a4e7cd
Show file tree
Hide file tree
Showing 2 changed files with 26 additions and 5 deletions.
31 changes: 26 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
@@ -1,13 +1,17 @@
# SMS Alert Channel Notifications for Grafana

## Getting Started
## Requirements

- Docker, Docker Compose or Node v18 for host installation.
- Twilio account.

1. Create `.env` file based on `.env.example`
2. Install Docker
## Getting Started

## Run
1. Create `.env` file based on `.env.example`.
2. Start a container or run as a standalone.
3. Create a Contact Point in Grafana Alerting.

Run the command `npm run start` to start the server.
![Contact Point](https://github.com/VolkovLabs/grafana-sms-webhook/raw/main/img/contact.png)

## Docker Compose

Expand All @@ -23,6 +27,10 @@ services:
- 8080:3000
```

## Run as standalone

Run the command `npm install` and `npm run start` to start the server.

## REST API

```
Expand All @@ -36,3 +44,16 @@ fetch('http://localhost:3000/sendsms?number=1234567890', {
})
})
```

## Feedback

We're looking forward to hearing from you. You can use different ways to get in touch with us.

- Ask a question, request a new feature, and file a bug with [GitHub issues](https://github.com/volkovlabs/grafana-sms-webhook/issues/new/choose).
- Subscribe to our [YouTube Channel](https://www.youtube.com/@volkovlabs) and add a comment.
- Sponsor our open-source plugins for Grafana at [GitHub Sponsor](https://github.com/sponsors/VolkovLabs).
- Support our project by starring the repository.

## License

Apache License Version 2.0, see [LICENSE](https://github.com/volkovlabs/grafana-sms-webhook/blob/main/LICENSE).
Binary file added img/contact.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 6a4e7cd

Please sign in to comment.