Skip to content

Commit

Permalink
Update README.md
Browse files Browse the repository at this point in the history
- update: screenshot
- update: checks.yaml
  • Loading branch information
harsxv authored Oct 24, 2024
1 parent f0b0856 commit ac1e6f8
Showing 1 changed file with 23 additions and 16 deletions.
39 changes: 23 additions & 16 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ Check out an online demo https://status.harry.id

| Light Mode | Dark Mode |
|-|-|
| ![Light](https://github.com/user-attachments/assets/28227221-d1e1-442e-89a4-2a0a09615514) | ![Dark](https://github.com/user-attachments/assets/8bbfc364-319a-417d-898d-3e0807b782bf) |
| ![Light](https://github.com/user-attachments/assets/3ea7b55e-397f-4f7c-8189-64b74a03594b) | ![Dark](https://github.com/user-attachments/assets/92072f9e-1031-4f07-8392-1111df57453a) |


## Features
Expand Down Expand Up @@ -60,21 +60,28 @@ Check out an online demo https://status.harry.id
2. Edit the `checks.yaml` file to add or modify the services you want to monitor.
Example:
```yaml
- name: GitHub Home
type: http
host: https://github.com
url: https://github.com # (optional: URL review/clickable)
ssc: True # (optional: if the server uses a self-signed certificate)
expected_code: 200

- name: Google DNS
type: ping
host: 8.8.8.8

- name: Database
type: port
host: db.example.com
port: 5432
- title: 'Group 1'
checks:
- name: GitHub Home
type: http
host: https://github.com
url: https://docs.github.com/en
expected_code: 200

- name: Google Public DNS
type: ping
host: 8.8.8.8

- name: Dummy MySQL Database
type: port
host: db.example.com
port: 3306

- name: Home Server with Self-Signed Certs
type: http
host: https://homeserver.local
ssc: True
expected_code: 200
```
3. (Optional) Customize the `incidents.md` file to add any known incidents or maintenance schedules.
Expand Down

0 comments on commit ac1e6f8

Please sign in to comment.