Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/marteinn/cynomys
A lightweight website monitor that runs on Serverless/AWS.
https://github.com/marteinn/cynomys
dynamodb lamda nodejs serverless-framework
Last synced: about 1 month ago
JSON representation
A lightweight website monitor that runs on Serverless/AWS.
- Host: GitHub
- URL: https://github.com/marteinn/cynomys
- Owner: marteinn
- License: mit
- Created: 2019-06-16T10:37:49.000Z (over 5 years ago)
- Default Branch: develop
- Last Pushed: 2023-01-09T23:23:06.000Z (almost 2 years ago)
- Last Synced: 2023-04-26T15:40:58.813Z (over 1 year ago)
- Topics: dynamodb, lamda, nodejs, serverless-framework
- Language: JavaScript
- Homepage:
- Size: 1.87 MB
- Stars: 1
- Watchers: 1
- Forks: 0
- Open Issues: 20
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Cynomys
A lightweight website monitor that runs on Serverless/AWS.
## Features
- Supports multiple website endpoints
- Interprets non 200/201 status codes as errors
- Detects network/domain issues
- Reports errors to slack through a webhook
- Reports errors to sms using 46elks
## Requirements
- Node 12
- Serverless >= 1.60.0
- [A slack app and webhook](https://api.slack.com/incoming-webhooks#create_a_webhook)
- [A 46elks api user](https://46elks.com/docs/send-sms)
## Installation
1. `npm install -g serverless`
2. `make setup`
3. `cp example.env .env`
## Developing locally
1. `docker-compose up -d`
1. `cd src`
1. `cp offline.example.env offline.env`
1. `env $(cat offline.env | xargs) npm run start`
1. `open http://localhost:3000/create-local-db`
1. `open http://localhost:3000`
## Handling secrets
Secrets are stored in a encrypted external file, where $KEY is your encryption key.
- Encrypt `openssl aes-256-cbc -e -in .circlerc -out .circlerc-crypt -k $KEY`
- Decrypt `openssl aes-256-cbc -d -in .circlerc-crypt -out .circlerc -k $KEY`
## Versioning
This boilerplate uses [semantic versioning](http://semver.org/).
## Contributing
Want to contribute? Awesome. Just send a pull request.
## License
Cynomys is released under the [MIT License](http://www.opensource.org/licenses/MIT).