mirror/Checkmate
1
0
Fork 0
mirror of https://github.com/bluewave-labs/Checkmate.git synced 2026-01-13 21:29:46 -06:00
Code Issues Packages Projects Releases Wiki Activity

Update docs and docker-compose

Browse Source
This commit is contained in:
Alex Holliday
2024-11-14 11:33:55 +08:00
parent df36e4d1f6
commit f2243634cd
3 changed files with 33 additions and 8 deletions
Download Patch File Download Diff File Expand all files Collapse all files

2
Docker/dist/docker-compose.yaml vendored
View File

@@ -18,6 +18,8 @@ services:
environment:
- DB_CONNECTION_STRING=mongodb://mongodb:27017/uptime_db
- REDIS_HOST=redis
# volumes:
# - /var/run/docker.sock:/var/run/docker.sock:ro
redis:
image: bluewaveuptime/uptime_redis:latest
ports:

17
guides/users-guide/creating-a-new-monitor.md
View File

@@ -8,24 +8,25 @@ Creating a new monitor involves a few steps, mentioned below. 
### General settings
* **URL to monitor:** Enter the full URL of the website or service you want to monitor.
* **Display name:** Optionally, provide a custom name for your monitor. This helps identify it easily in your dashboard.
- **URL to monitor:** Enter the full URL of the website or service you want to monitor.
- **Display name:** Optionally, provide a custom name for your monitor. This helps identify it easily in your dashboard.
### Checks to perform
* **Website monitoring:** This option uses HTTP(s) to monitor your website or API endpoint. You can choose between HTTPS and HTTP protocols.
* **Ping monitoring:** Checks whether your server is available. This option is currently unselected.
- **Website monitoring:** This option uses HTTP(s) to monitor your website or API endpoint. You can choose between HTTPS and HTTP protocols.
- **Ping monitoring:** Checks whether your server is available. This option is currently unselected.
- **Docker monitoring:** Checks whether a Docker container is running
### Incident notifications 
When there's a new incident, you can choose how to be notified:
* Notify via SMS (coming soon)
* Notify via email (to the email address you logged in with)
* Notify via email to multiple addresses (coming soon)
- Notify via SMS (coming soon)
- Notify via email (to the email address you logged in with)
- Notify via email to multiple addresses (coming soon)
### Advanced settings
* **Check frequency:** Set how often the system should check your monitor. The current setting is 1 minute.
- **Check frequency:** Set how often the system should check your monitor. The current setting is 1 minute.
After configuring all settings, click the "Create monitor" button at the bottom right to set up your new monitor.

22
guides/users-guide/quickstart.md
View File

@@ -10,6 +10,17 @@ icon: sign-posts-wrench
2. Run `docker compose up` to start the application
3. Now the application is running at `http://localhost`
##### Optional Config:
- If you want to monitor Docker containers, uncomment this line in `docker-compose.yaml`:
```
# volumes:
# - /var/run/docker.sock:/var/run/docker.sock:ro
```
This gives the app access to your docker daemon via unix socket, please be aware of what you are doing.
---
## Quickstart for users (remote server) <a href="#user-quickstart" id="user-quickstart"></a>
@@ -19,6 +30,17 @@ icon: sign-posts-wrench
3. Run `docker compose up` to start the application
4. Now the application is running at `http://<remote_server_ip>`
##### Optional Config:
- If you want to monitor Docker containers, uncomment this line in `docker-compose.yaml`:
```
# volumes:
# - /var/run/docker.sock:/var/run/docker.sock:ro
```
This gives the app access to your docker daemon via unix socket, please be aware of what you are doing.
---
## Quickstart for developers <a href="#dev-quickstart" id="dev-quickstart"></a>