GITBOOK-12: No subject

docs/README.md

@@ -0,0 +1,63 @@
+---
+icon: hand-wave
+cover: .gitbook/assets/Group 3763.png
+coverY: 0
+layout:
+  cover:
+    visible: true
+    size: full
+  title:
+    visible: true
+  description:
+    visible: false
+  tableOfContents:
+    visible: true
+  outline:
+    visible: true
+  pagination:
+    visible: true
+---
+
+# Welcome to Uptime Manager
+
+BlueWave Uptime Manager is an open source server monitoring application used to track the operational status and performance of servers and websites. 
+
+It regularly checks whether a server/website is accessible and performs optimally, providing real-time alerts and reports on the monitored services' availability, downtime, and response time.
+
+## Demo
+
+We have a [demo](https://uptime-demo.bluewavelabs.ca/) where you can test how the Uptime Manager works. The username is [uptimedemo@demo.com](mailto:uptimedemo@demo.com) and the password is Demouser1!
+
+## Questions & ideas
+
+If you have a question, head over to GitHub's [discussions](https://github.com/bluewave-labs/bluewave-uptime/discussions) page.
+
+## Features
+
+* [x] Completely open source, deployable on your servers
+* [x] Website monitoring
+* [x] Port monitoring
+* [x] Ping monitoring
+* [x] Incidents at a glance
+* [x] Page speed monitoring
+* [x] E-mail notifications
+* [ ] Scheduled maintenance (in the works)
+
+## **Roadmap (short term)**
+
+* [ ] Memory, disk and CPU monitoring
+* [ ] 3rd party integrations
+* [ ] DNS monitoring
+* [ ] SSL monitoring
+
+## **Roadmap (long term)**
+
+* [ ] Status pages
+
+## Tech stack
+
+* [ReactJs](https://react.dev/)
+* [MUI (React framework)](https://mui.com/)
+* [Node.js](https://nodejs.org/en)
+* [MongoDB](https://mongodb.com)
+

docs/SUMMARY.md

@@ -0,0 +1,10 @@
+# Table of contents
+
+* [Welcome to Uptime Manager](README.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)

docs/creating-a-new-monitor.md

@@ -0,0 +1,31 @@
+---
+icon: plus
+---
+
+# Creating a new monitor
+
+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.
+
+### 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.
+
+### 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)
+
+### Advanced settings
+
+* **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.

docs/incidents-page.md

@@ -0,0 +1,13 @@
+---
+icon: brake-warning
+---
+
+# Incidents page
+
+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>
+
+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.
+
+By default, the page shows all incidents from all servers. There is also a dropdown button above the table where you can select a server name.

docs/pagespeed-monitoring.md

@@ -0,0 +1,89 @@
+---
+icon: gauge-min
+---
+
+# Pagespeed monitoring
+
+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>
+
+When you add a new page speed monitor, it is added here. Click on the "Create new" button to add a new page speed.&#x20;
+
+Here, both monitors are shown as "Live (Collecting Data)" with a green dot, indicating they are actively monitoring. Each monitor has a small graph, representing recent pagespeed performance over time.
+
+### Details of a pagespeed monitor
+
+<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.&#x20;
+
+### Score history graph
+
+Shows performance trends over the past 24 hours. Four colored lines represent different metrics:
+
+* Accessibility (blue)
+* Best Practices (orange)
+* Performance (green)
+* Search Engine Optimization (purple)
+
+You can toggle these metrics on/off using the checkboxes on the right
+
+### Performance report
+
+You'll see an overall score of your server's pagespeed.&#x20;
+
+### Performance metrics
+
+* **Cumulative Layout Shift:** Measures visual stability
+* **Speed Index:** How quickly content is visually displayed
+* **First Contentful Paint:** Time until the first content is rendered
+* **Largest Contentful Paint:** Time until the largest content element is rendered
+* **Total Blocking Time:** Sum of all time periods between FCP and Time to Interactive
+
+### Creating a new pagespeed&#x20;
+
+When you are on a pagespeed screen, click on the "Create pagespeed" button. You'll see a screen similar to this:&#x20;
+
+<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:
+
+#### General settings
+
+* **URL to monitor:** Enter the full URL of the website you want to monitor (e.g., [https://google.com](https://google.com)).
+* **Display name (optional):** Enter a custom name for your monitor to easily identify it in your dashboard.
+
+#### Checks to perform
+
+Here, you can choose between HTTPS (recommended for secure sites) or HTTP protocols.
+
+#### Incident notifications&#x20;
+
+Select how you want to be notified when there's a new incident:
+
+* Notify via SMS (coming soon)
+* Notify via email (to your email address)
+* Also notify via email to multiple addresses (coming soon)
+
+#### Advanced settings
+
+**Check frequency:** Choose how often you want the system to check your website's pagespeed. The default is set to 3 minutes.
+
+After configuring all settings, click the "Create monitor" button at the bottom right of the page.
+
+#### Tips
+
+* Ensure the URL you enter is correct and accessible.
+* Choose a descriptive display name if you're monitoring multiple sites.
+* Consider the trade-off between check frequency and resource usage. More frequent checks provide more data but may use more resources.
+* Remember to enable your preferred notification methods to stay informed about incidents.
+
+After creating the monitor, you'll be able to view its performance data in your dashboard. This will help you track your website's pagespeed and optimize its performance over time.
+
+
+
+
+
+
+

docs/quickstart.md

@@ -0,0 +1,176 @@
+---
+icon: sign-posts-wrench
+---
+
+# Installing Uptime Manager
+
+
+
+## Quickstart for users (quick method) <a href="#user-quickstart" id="user-quickstart"></a>
+
+1. Download our [Docker compose file](https://github.com/bluewave-labs/bluewave-uptime/blob/develop/Docker/dist/docker-compose.yaml)
+2. Run `docker compose up` to start the application
+3. Now the application is running at `http://localhost`
+
+## Quickstart for developers <a href="#dev-quickstart" id="dev-quickstart"></a>
+
+{% hint style="info" %}
+Make sure you change the directory to the specified directories, as paths in commands are relative.
+{% endhint %}
+
+### Cloning and initial setup
+
+1. Clone this repository.
+2. Checkout the `develop` branch `git checkout develop`
+
+### Setting up Docker images
+
+3. Change directory to the `Docker/dev` directory
+4. Run `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
+5. Run `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
+
+### Server setup
+
+6. CD to `Server` directory, and run `npm install`
+7. While in `Server` directory, create a `.env` file with the required environmental variables
+8. While in the `Server` directory, run `npm run dev`
+
+### Client setup
+
+9. CD to `Client` directory `run npm install`
+10. While in the `Client` directory, create a `.env` file with the required environmental variables
+11. While in the `Client` cirectory run `npm run dev`
+
+### Access the application
+
+12. Client is now running at `localhost:5173`
+13. Server is now running at `localhost:5000`
+
+## Manual installation <a href="#manual-install" id="manual-install"></a>
+
+### Client installation <a href="#install-client" id="install-client"></a>
+
+1. Change directory to the `Client` directory
+2. Install all dependencies by running `npm install`
+
+#### Environment variables <a href="#env-vars-client" id="env-vars-client"></a>
+
+| ENV Variable Name         | Required/Optional | Type      | Description        | Accepted Values                    |
+| ------------------------- | ----------------- | --------- | ------------------ | ---------------------------------- |
+| VITE\_APP\_API\_BASE\_URL | Required          | `string`  | Base URL of server | {host}/api/v1                      |
+| VITE\_APP\_LOG\_LEVEL     | Optional          | `string`  | Log level          | `"none"`\|`"error"` \| `"warn"` \| |
+| VITE\_APP\_DEMO           | Optional          | `boolean` | Demo server or not | `true`\|`false` \|                 |
+
+#### Starting the development server <a href="#start-client" id="start-client"></a>
+
+1. Run `npm run dev` to start the development server.
+
+### Server Installation <a href="#install-server" id="install-server"></a>
+
+1. Change the directory to the `Server` directory
+2. Install all dependencies by running `npm install`
+
+#### Environment variables <a href="#env-vars-server" id="env-vars-server"></a>
+
+Configure the server with the following environmental variables:
+
+<table><thead><tr><th width="239">ENV Variable Name</th><th width="149">Required/Optional</th><th width="116">Type</th><th>Description</th><th>Accepted Values</th></tr></thead><tbody><tr><td>CLIENT_HOST</td><td>Required</td><td><code>string</code></td><td>Frontend Host</td><td></td></tr><tr><td>JWT_SECRET</td><td>Required</td><td><code>string</code></td><td>JWT secret</td><td></td></tr><tr><td>DB_TYPE</td><td>Optional</td><td><code>string</code></td><td>Specify DB to use</td><td><code>MongoDB | FakeDB</code></td></tr><tr><td>DB_CONNECTION_STRING</td><td>Required</td><td><code>string</code></td><td>Specifies URL for MongoDB Database</td><td></td></tr><tr><td>PORT</td><td>Optional</td><td><code>integer</code></td><td>Specifies Port for Server</td><td></td></tr><tr><td>LOGIN_PAGE_URL</td><td>Required</td><td><code>string</code></td><td>Login url to be used in emailing service</td><td></td></tr><tr><td>REDIS_HOST</td><td>Required</td><td><code>string</code></td><td>Host address for Redis database</td><td></td></tr><tr><td>REDIS_PORT</td><td>Required</td><td><code>integer</code></td><td>Port for Redis database</td><td></td></tr><tr><td>TOKEN_TTL</td><td>Optional</td><td><code>string</code></td><td>Time for token to live</td><td>In vercel/ms format https://github.com/vercel/ms</td></tr><tr><td>PAGESPEED_API_KEY</td><td>Optional</td><td><code>string</code></td><td>API Key for PageSpeed requests</td><td></td></tr><tr><td>SYSTEM_EMAIL_HOST</td><td>Required</td><td><code>string</code></td><td>Host to send System Emails From</td><td></td></tr><tr><td>SYSTEM_EMAIL_PORT</td><td>Required</td><td><code>number</code></td><td>Port for System Email Host</td><td></td></tr><tr><td>SYSTEM_EMAIL_ADDRESS</td><td>Required</td><td><code>string</code></td><td>System Email Address</td><td></td></tr><tr><td>SYSTEM_EMAIL_PASSWORD</td><td>Required</td><td><code>string</code></td><td>System Email Password</td><td></td></tr></tbody></table>
+
+***
+
+#### Databases <a href="#databases" id="databases"></a>
+
+This project requires two databases:
+
+1. **Main application database:** The project uses MongoDB for its primary database, with a MongoDB Docker image provided for easy setup.
+2. **Redis for queue management:** A Redis database is used for the PingService’s queue system, and a Redis Docker image is included for deployment.
+
+You may use the included Dockerfiles to spin up databases quickly if you wish.
+
+**(Optional) Dockerised databases**
+
+Dockerfiles for the server and databases are located in the `Docker` directory
+
+<details>
+
+<summary>MongoDB Image</summary>
+
+Location: `Docker/mongoDB.Dockerfile`
+
+The `Docker/mongo/data` directory should be mounted to the MongoDB container in order to persist data.
+
+From the `Docker` directory run
+
+1. Build the image: `docker build -f mongoDB.Dockerfile -t uptime_database_mongo .`
+2. Run the docker image: `docker run -d -p 27017:27017 -v $(pwd)/mongo/data:/data/db --name uptime_database_mongo uptime_database_mongo`
+
+</details>
+
+<details>
+
+<summary>Redis Image</summary>
+
+Location `Docker/redis.Dockerfile`
+
+the `Docker/redis/data` directory should be mounted to the Redis container in order to persist data.
+
+From the `Docker` directory run
+
+1. Build the image: `docker build -f redis.Dockerfile -t uptime_redis .`
+2. Run the image: `docker run -d -p 6379:6379 -v $(pwd)/redis/data:/data --name uptime_redis uptime_redis`
+
+</details>
+
+***
+
+#### Starting the development derver <a href="#start-server" id="start-server"></a>
+
+* run `npm run dev` to start the development server
+
+or,
+
+* run `node index.js` to start server
+
+***
+
+### API documentation <a href="#api-documentation" id="api-documentation"></a>
+
+Our API is documented in accordance with the [OpenAPI spec](https://www.openapis.org/).
+
+You can see the documentation on your local development server at http://localhost:{port}/api-docs
+
+You can also view the documentation on our demo server at [https://uptime-demo.bluewavelabs.ca/api-docs](https://uptime-demo.bluewavelabs.ca/api-docs)
+
+### Error handling
+
+Errors are returned in a standard format:
+
+`{"success": false, "msg": "No token provided"}`
+
+Errors are handled by error handling middleware and should be thrown with the following parameters
+
+| Name    | Type      | Default                | Notes                                |
+| ------- | --------- | ---------------------- | ------------------------------------ |
+| status  | `integer` | 500                    | Standard HTTP codes                  |
+| message | `string`  | "Something went wrong" | An error message                     |
+| service | `string`  | "Unknown Service"      | Name of service that threw the error |
+
+Example:
+
+```
+const myRoute = async(req, res, next) => {
+  try{
+    const result = myRiskyOperationHere();
+  }
+  catch(error){
+    error.status = 404
+    error.message = "Resource not found"
+    error.service = service name
+    next(error)
+    return;
+  }
+}
+
+```
+
+Errors should not be handled at the controller level and should be left to the middleware to handle.

docs/server-settings.md

@@ -0,0 +1,35 @@
+---
+icon: screwdriver-wrench
+---
+
+# Server settings
+
+Under the Settings page, you can configure the server's behaviour. 
+
+### General settings
+
+Display timezone: The timezone of the dashboard you publicly display.
+
+### History and monitoring
+
+Define here for how long you want to keep the data. You can also remove all past data. You can also clear all stats. This is irreversible.
+
+### Demo monitors
+
+Here you can add and remove demo monitors. It will load roughly 300 demo monitors at the same time so you can test your server.
+
+### Advanced settings 
+
+Here you can setup the following: 
+
+**Client settings:** The URL of the APIs and debug level. The more verbose the debug level, the more log is written on the server.
+
+**Email settings:** Set your host email settings here. These settings are used for sending system emails.
+
+Server settings: Several server settings can be done here. Alternatively, you can add a pagespeed API key to bypass Google's limitations (albeit they are generous about it)
+
+
+
+
+
+\

docs/user-settings.md

@@ -0,0 +1,45 @@
+---
+icon: user-pen
+---
+
+# User settings
+
+This screen allows you to manage your personal information and account settings within the application.
+
+### Profile section
+
+<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.
+
+### Password section
+
+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>
+
+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).
+
+**Additional notes:**
+
+* Your new password will take effect immediately.
+* For security reasons, it is recommended to choose a strong password that is difficult to guess.
+
+### Team section
+
+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>
+
+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.&#x20;
+
+To invite a team member,&#x20;
+
+* Click the "Invite a team member" button.
+* Enter the email address of the person you want to invite.
+* Select their desired role (Administrator or Member).
+* Click "Invite" to send the invitation.
+
+The invited team member will receive an email invitation to join your team.
+
+Admin also has the option to edit or remove existing team members.

docs/using-uptime-manager.md

@@ -0,0 +1,80 @@
+---
+description: >-
+  This user guide helps new users navigate and understand the Uptime Manager
+  dashboard layout and functionality.
+icon: computer-mouse
+---
+
+# Using Uptime Manager
+
+## **General Overview**
+
+The Uptime Manager is an open-source server monitoring tool designed to track the uptime, downtime, and performance of servers, websites, or web applications. 
+
+It provides real-time alerts, status updates, and detailed response time metrics.
+
+### **Sidebar menu** 
+
+The sidebar on the left contains the following sections:
+
+* **Dashboard**: The main section that shows an overview of your monitored services, including their status and performance. It includes "Monitors" and "Pagespeed"
+* **Incidents**: A section where alerts and incidents regarding the monitored services are logged. This helps users investigate issues and track downtime history.
+* **Account**: User-related settings and account information are accessible here.
+* **Support**: Links to customer support or documentation to help troubleshoot or ask for assistance.
+* **Settings**: Provides customization options for the application’s behavior, monitoring frequency, and notification preferences.
+
+**User info section**
+
+At the bottom of the sidebar, you’ll see the current logged-in user alongside with the role.
+
+### **Dashboard content**
+
+The main section of the dashboard displays an overview of the monitored services, including their current status and key performance indicators.
+
+The dashboard offers a summary of your uptime monitors:
+
+* **Up**: The number of monitored services that are currently operational.
+* **Down**: The number of monitored services that are currently experiencing issues.
+* **Paused**: The number of services that have their monitoring paused.
+
+**Actively monitoring table**
+
+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>
+
+* **Host**: The name and URL of the service being monitored.
+* **Status**: The current status of the service, indicated by color-coded icons:
+  * Green: **Up** (operational)
+  * Red: **Down** (non-operational)
+  * Yellow: **Paused** (monitoring paused for this service)
+* **Response time**: A visual graph showing the performance trends of the service over time. Each bar represents the response time of the service at a given interval. Green bars indicate a healthy response time, while red bars indicate slower or problematic performance.
+* **Type**: Indicates the type of service being monitored (either Ping or HTTP).
+* **Actions**: This column has settings icons that allow the user to configure the monitoring details of the specific service.
+
+At the top-right corner of the dashboard, there’s a button labeled **Create monitor**. This allows users to add a new server or website to monitor.
+
+A search bar is available above the list of monitored services, enabling users to quickly locate specific services by name or URL.
+
+**Status indicators**
+
+* **Green**: Indicates the service is currently up and operational.
+* **Red**: Indicates the service is down or experiencing problems.
+* **Yellow**: Indicates that monitoring for this service is paused.
+
+Each service has a graph in the **Response Time** column that displays its performance history over time. This allows you to easily visualize any spikes or drops in performance.
+
+The gear icon next to each monitored service allows for quick access to configuration settings or additional monitoring options.
+
+### Table actions&#x20;
+
+<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:&#x20;
+
+1. **Open site**: Opens the monitored website or server in a new browser tab.
+2. **Details**: Displays historical uptime and performance metrics for the service.
+3. **Incidents**: Shows a log of all incidents related to the service, including downtime and performance issues.
+4. **Configure**: Allows modification of monitoring parameters like check frequency and alert preferences.
+5. **Clone**: Duplicates the current service’s monitoring settings for a new service.
+6. **Remove**: Removes the service from the monitored list and stops all monitoring activities.