https://github.com/kevincobain2000/aketemite
Monitor website for up status. Zero dependency uptime monitoring tool for websites, APIs with crawling capabilities.
https://github.com/kevincobain2000/aketemite
monitoring-tool ping pingdom website-monitoring
Last synced: about 1 year ago
JSON representation
Monitor website for up status. Zero dependency uptime monitoring tool for websites, APIs with crawling capabilities.
- Host: GitHub
- URL: https://github.com/kevincobain2000/aketemite
- Owner: kevincobain2000
- Created: 2023-11-07T10:27:22.000Z (over 2 years ago)
- Default Branch: master
- Last Pushed: 2024-04-10T07:21:07.000Z (about 2 years ago)
- Last Synced: 2025-01-28T22:30:53.235Z (over 1 year ago)
- Topics: monitoring-tool, ping, pingdom, website-monitoring
- Language: TypeScript
- Homepage:
- Size: 248 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
Simple tool written in Go, to ping urls and get the status code.
Monitor up status for websites, api and URLs, with automatic crawling capability.
**Quick Setup:** One command to ping multiple urls and monitor result.
**Monitor periodically:** Monitor the urls periodically and get the status code.
**Crawling capability:** Crawls entire page, finds the links and obtains the status code.
**Beautiful:** Beautiful and simple dashboard.
# Build Status
## Getting Started
**Step 1)** Install aketemite
```sh
curl -sLk https://raw.githubusercontent.com/kevincobain2000/aketemite/master/install.sh | sh
```
**Step 2)** Prepare config.yml
```yml
# config.yml
urls:
- name: https://kevincobain2000.github.io
timeout: 2000
crawl: false
- name: https://kevincobain2000.github.io/404
timeout: 2000
crawl: true
- name: https://coveritup.app
timeout: 2000
crawl: true
- name: https://github.com
timeout: 2000
crawl: false
```
**Step 3)** Start application
```sh
./aketemite --config=path=config.yml
```
**Step 4)** Confirm application
**UI:** localhost:3000/aketemite
**API:** localhost:3000/aketemite/api
**Logs:** `tail -f logs/aketemite.log`
## Screenshots
## Advanced Options
```sh
Usage of ./aketemite:
Example ./aketemite --config-path=config.yml --port=3000 --delete-cache --cache-dir=/tmp/aketemite
-cache-dir string
cache dir (default "/tmp/aketemite")
-config-path string
config path (default "config.yml")
-delete-cache
delete cache
-ping-freq uint
ping frequency (default 300)
-port string
port to serve (default "3001")
```
## Development Notes
**API**
```sh
#starts api on port localhost:3001/aketemite/api
air
```
**UI**
```sh
cd ui/
npm install
#starts ui on port localhost:3001/aketemite
npm run dev
```