Skip to content

Commit

Permalink
Merge pull request #75 from sooraj-sky/main
Browse files Browse the repository at this point in the history
Readme settings update
  • Loading branch information
sooraj-sky authored Jan 8, 2023
2 parents fa81780 + 5bc4d92 commit 6646df5
Show file tree
Hide file tree
Showing 5 changed files with 44 additions and 222 deletions.
63 changes: 44 additions & 19 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -33,30 +33,55 @@ Currenly we have two environment variables.
- You can export the **PORT** variable to set the http port of the server

## Add URLs to check
To add a URL to minitoring is pertty simple. Create **input.json** to add your endpoints to monitor. See an example of **input.json** below
To add a URL to minitoring is pertty simple. Create **settings.yml** to add your endpoints to monitor. See an example of **settings.yml** below
```sh
[
{
"url": "https://github.com",
"timeout": 1200,
"skip_ssl": false,
"frequency" : 5,
"group": "prod"
},
{
"url": "https://stackoverflow.com",
"timeout": 1200,
"skip_ssl": false,
"frequency" : 30,
"group": "prod"
}
]
opegenie:
- enabled: false
email:
- enabled: true
server: smtp.gmail.com
port: 587
sender: [email protected]
groups:
- name: prod
emails:
- [email protected]
- [email protected]
- name: dev
emails:
- [email protected]
- [email protected]
domains:
- name: https://skywalks.in
enabled: true
timeout: 10
skip_ssl: false
frequency: 10
group: dev
- name: https://sky-meter.skywalks.in
enabled: true
timeout: 10
skip_ssl: false
frequency: 60
group: dev
- name: https://github.com
enabled: true
timeout: 10
skip_ssl: false
frequency: 60
group: prod

- name: https://githcccubs.com
enabled: true
timeout: 10
skip_ssl: false
frequency: 60
group: prod
```
> _url_ : url to monitor (string)
> _timeout_ : Timeout of request in Millisecond (int)
> _skip_ssl_ : set flase if you want to skip the ssl verification (bool)
> _frequency_ : frequency of health check in secont (int)
> _group_ : Add group properties (string)
> _group_ : Group settings
## Run the Code
Clone the code
Expand Down
20 changes: 0 additions & 20 deletions docs/.editorconfig

This file was deleted.

3 changes: 0 additions & 3 deletions docs/.eslintrc

This file was deleted.

172 changes: 0 additions & 172 deletions docs/.gitignore

This file was deleted.

8 changes: 0 additions & 8 deletions docs/.stylelintrc

This file was deleted.

0 comments on commit 6646df5

Please sign in to comment.