mirror of
https://github.com/bluewave-labs/Checkmate.git
synced 2026-01-02 23:59:37 -06:00
GITBOOK-19: No subject
This commit is contained in:
committed by
gitbook-bot
parent
a9a34f8725
commit
bdeb33b8d3
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 9.28.27 AM.png
Normal file
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 9.28.27 AM.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 292 KiB |
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 9.30.30 AM.png
Normal file
BIN
docs/.gitbook/assets/Screenshot 2024-10-04 at 9.30.30 AM.png
Normal file
Binary file not shown.
|
After Width: | Height: | Size: 212 KiB |
@@ -4,15 +4,16 @@
|
||||
|
||||
## USER'S GUIDE
|
||||
|
||||
* [Installing Uptime Manager](users-guide/quickstart.md)
|
||||
* [Using Uptime Manager](users-guide/using-uptime-manager.md)
|
||||
* [Creating a new monitor](users-guide/creating-a-new-monitor.md)
|
||||
* [Pagespeed monitoring](users-guide/pagespeed-monitoring.md)
|
||||
* [Incidents page](users-guide/incidents-page.md)
|
||||
* [Server settings](users-guide/server-settings.md)
|
||||
* [User settings](users-guide/user-settings.md)
|
||||
* [Installing Uptime Manager](quickstart.md)
|
||||
* [Using Uptime Manager](using-uptime-manager.md)
|
||||
* [Creating a new monitor](creating-a-new-monitor.md)
|
||||
* [Pagespeed monitoring](pagespeed-monitoring.md)
|
||||
* [Incidents page](incidents-page.md)
|
||||
* [Server settings](server-settings.md)
|
||||
* [User settings](user-settings.md)
|
||||
|
||||
## DEVELOPER'S GUIDE
|
||||
|
||||
* [Contributing to the code](developers-guide/contributing-to-the-code.md)
|
||||
* [General project structure](developers-guide/general-project-structure.md)
|
||||
* [High level overview](developers-guide/high-level-overview.md)
|
||||
|
||||
27
docs/developers-guide/high-level-overview.md
Normal file
27
docs/developers-guide/high-level-overview.md
Normal file
@@ -0,0 +1,27 @@
|
||||
# High level overview
|
||||
|
||||
|
||||
|
||||
The figure below shows a high level architecture of the Uptime Manager.
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 9.28.27 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### Typical auth request overview
|
||||
|
||||
The following diagram describes a typical request to the /auth endpoints.
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 9.30.30 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
### Typical monitor request overview
|
||||
|
||||
The following diagram describes a typical request to the `/monitors` endpoints.
|
||||
|
||||
|
||||
|
||||
|
||||
|
||||
\
|
||||
\
|
||||
|
||||
|
||||
\
|
||||
@@ -6,7 +6,7 @@ icon: brake-warning
|
||||
|
||||
This page shows a list of incidents of all the servers you monitor. 
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-03 at 11.54.31 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src=".gitbook/assets/Screenshot 2024-10-03 at 11.54.31 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
Page includes a table where Monitor name, Status (down or cannot resolve), date and time of the incident, status code and corresponding message is shown.
|
||||
|
||||
@@ -6,7 +6,7 @@ icon: gauge-min
|
||||
|
||||
Under Dashboard > Pagespeed, you can see an overview of pagespeed monitors for different websites. This dashboard helps you view optimal website performance by providing clear, actionable insights into various aspects of your site's speed and user experience.
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-03 at 11.37.47 PM (1).png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src=".gitbook/assets/Screenshot 2024-10-03 at 11.37.47 PM (1).png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
When you add a new page speed monitor, it is added here. Click on the "Create new" button to add a new page speed. 
|
||||
|
||||
@@ -14,7 +14,7 @@ Here, both monitors are shown as "Live (Collecting Data)" with a green dot, indi
|
||||
|
||||
### Details of a pagespeed monitor
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-03 at 11.41.55 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src=".gitbook/assets/Screenshot 2024-10-03 at 11.41.55 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
When you click on a pagespeed card, you'll see an overview of data collected using Google's PageSpeed Monitor API. 
|
||||
|
||||
@@ -45,7 +45,7 @@ You'll see an overall score of your server's pagespeed. 
|
||||
|
||||
When you are on a pagespeed screen, click on the "Create pagespeed" button. You'll see a screen similar to this: 
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-03 at 11.47.41 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src=".gitbook/assets/Screenshot 2024-10-03 at 11.47.41 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
This page allows you to set up a new pagespeed monitor for your website. Follow these steps to configure your monitor:
|
||||
|
||||
@@ -8,7 +8,7 @@ This screen allows you to manage your personal information and account settings
|
||||
|
||||
### Profile section
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 12.17.57 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src=".gitbook/assets/Screenshot 2024-10-04 at 12.17.57 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
Enter your first name, last name and email here. You can also upload or delete a profile photo. If you want to delete an account, this can also be done here. Note that that this is irreversible and cannot be undone.
|
||||
|
||||
@@ -16,7 +16,7 @@ Enter your first name, last name and email here. You can also upload or delete a
|
||||
|
||||
This screen allows you to update your password for your account.
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 12.16.53 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src=".gitbook/assets/Screenshot 2024-10-04 at 12.16.53 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
In order to change your password, you need to enter your password, and the new password twice. The new password must meet the specified criteria (e.g., minimum length, uppercase letter, number, symbol).
|
||||
|
||||
@@ -29,7 +29,7 @@ In order to change your password, you need to enter your password, and the new p
|
||||
|
||||
This screen allows you to manage your team members within the application.
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-04 at 12.14.45 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src=".gitbook/assets/Screenshot 2024-10-04 at 12.14.45 AM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
Here you can see a list of all users in your system. A user can be either admin or a member, where an admin can create or delete a monitor, and a user can only view them. 
|
||||
|
||||
@@ -41,7 +41,7 @@ The dashboard offers a summary of your uptime monitors:
|
||||
|
||||
This section lists all the services being monitored, showing key details for each service:
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-03 at 10.56.43 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
<figure><img src=".gitbook/assets/Screenshot 2024-10-03 at 10.56.43 PM.png" alt=""><figcaption></figcaption></figure>
|
||||
|
||||
* **Host**: The name and URL of the service being monitored.
|
||||
* **Status**: The current status of the service, indicated by color-coded icons:
|
||||
@@ -68,7 +68,7 @@ The gear icon next to each monitored service allows for quick access to configur
|
||||
|
||||
### Table actions 
|
||||
|
||||
<figure><img src="../.gitbook/assets/Screenshot 2024-10-03 at 10.57.45 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
<figure><img src=".gitbook/assets/Screenshot 2024-10-03 at 10.57.45 PM.png" alt="" width="375"><figcaption></figcaption></figure>
|
||||
|
||||
When you click on the gear icon, you'll see a few options that correspond to that host: 
|
||||
|
||||
Reference in New Issue
Block a user