https://github.com/runnerty/executor-check-online-service
Runnerty module: Check Online Service Executor
https://github.com/runnerty/executor-check-online-service
check-online check-service checker executor runnerty site-audit
Last synced: about 1 year ago
JSON representation
Runnerty module: Check Online Service Executor
- Host: GitHub
- URL: https://github.com/runnerty/executor-check-online-service
- Owner: runnerty
- License: mit
- Created: 2017-04-15T12:19:41.000Z (almost 9 years ago)
- Default Branch: main
- Last Pushed: 2023-04-18T10:01:49.000Z (almost 3 years ago)
- Last Synced: 2025-02-28T14:11:18.961Z (about 1 year ago)
- Topics: check-online, check-service, checker, executor, runnerty, site-audit
- Language: JavaScript
- Size: 176 KB
- Stars: 2
- Watchers: 3
- Forks: 0
- Open Issues: 3
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
Smart Processes Management
[![NPM version][npm-image]][npm-url] [![Downloads][downloads-image]][npm-url] [![Dependency Status][david-badge]][david-badge-url]
# Check Online Service executor for [Runnerty]:
### Installation:
Through NPM
```bash
npm i @runnerty/executor-check-online-service
```
You can also add modules to your project with [runnerty]
```bash
npx runnerty add @runnerty/executor-check-online-service
```
This command installs the module in your project, adds example configuration in your [config.json] and creates an example plan of use.
If you have installed [runnerty] globally you can include the module with this command:
```bash
runnerty add @runnerty/executor-check-online-service
```
### Configuration sample:
Add in [config.json]:
```json
{
"id": "check_online_service_default",
"type": "@runnerty-executor-check-online-service"
}
```
### Plan sample:
Add in [plan.json]:
```json
{
"id":"check_online_service_default",
"hostname": "http://www.google.com/en",
"check_contains": "I'm Feeling Lucky"
}
```
### Plan advanced:
Add in [plan.json]:
```json
{
"id":"check_online_service_default",
"hostname": "http://www.google.com/en",
"check_contains": "I'm Feeling Lucky",
"method": "GET",
"auth":{
"user": "user",
"pass": "password",
}
}
```
```json
{
"id":"check_online_service_default",
"hostname": "http://www.myservice.com/api/health",
"headers": { "User-Agent": "runnerty", "Content-Type": "application/json" }
}
```
```json
{
"id":"check_online_service_default",
"hostname": "http://www.myservice.com/api/health",
"timeout": "5s"
}
```
[Runnerty]: https://www.runnerty.io
[downloads-image]: https://img.shields.io/npm/dm/@runnerty/executor-check-online-service.svg
[npm-url]: https://www.npmjs.com/package/@runnerty/executor-check-online-service
[npm-image]: https://img.shields.io/npm/v/@runnerty/executor-check-online-service.svg
[david-badge]: https://david-dm.org/runnerty/executor-check-online-service.svg
[david-badge-url]: https://david-dm.org/runnerty/executor-check-online-service
[config.json]: http://docs.runnerty.io/config/
[plan.json]: http://docs.runnerty.io/plan/