apps/docs/api-reference/incident/get-incident:id.mdx apps/docs/api-reference/incident/get-incident-id.mdx

apps/docs/api-reference/incident/put-incident:id.mdx apps/docs/api-reference/incident/put-incident-id.mdx

apps/docs/api-reference/monitor/delete-monitor:id.mdx apps/docs/api-reference/monitor/delete-monitor-id.mdx

apps/docs/api-reference/monitor/get-monitor:id.mdx apps/docs/api-reference/monitor/get-monitor-id.mdx

apps/docs/api-reference/monitor/get-monitor:id/summary.mdx apps/docs/api-reference/monitor/get-monitor-id/summary.mdx

apps/docs/api-reference/monitor/put-monitor:id.mdx apps/docs/api-reference/monitor/put-monitor-id.mdx

apps/docs/api-reference/notification/get-notification:id.mdx apps/docs/api-reference/notification/get-notification-id.mdx

apps/docs/api-reference/page/post-page:id/update.mdx apps/docs/api-reference/page/post-page-id/update.mdx

apps/docs/api-reference/page/put-page:id.mdx apps/docs/api-reference/page/put-page-id.mdx

apps/docs/api-reference/status_report/delete-status_report:id.mdx apps/docs/api-reference/status_report/delete-status_report-id.mdx

apps/docs/api-reference/status_report/get-status_report:id.mdx apps/docs/api-reference/status_report/get-status_report-id.mdx

apps/docs/api-reference/status_report/post-status_report:id/update.mdx apps/docs/api-reference/status_report/post-status_report-id/update.mdx

apps/docs/api-reference/status_report_update/get-status_report_update:id.mdx apps/docs/api-reference/status_report_update/get-status_report_update-id.mdx

+7 -29

apps/docs/contributing/get-started.mdx

··· 24 24 25 25 If you are on a mac install it with [Homebrew](https://brew.sh/) 26 26 27 27 - ```sh 28 28 - brew tap chiselstrike/tap 29 29 - brew install turso 30 30 - ``` 31 31 - 32 32 - then run it locally with 33 33 - 34 34 - ```sh 35 35 - turso dev --db-file openstatus.db 36 36 - ``` 37 27 38 28 Here is the official Turso 39 29 [installation guide](https://docs.turso.tech/reference/turso-cli) 40 30 41 41 - 4. Run the database migration 31 31 + 4. Install Bun 32 32 + All the up to date information are on the official [Bun website](https://bun.sh/) 42 33 43 43 - In the `packages/db` folder run 34 34 + 4. Set up the dev environment 44 35 45 36 ```sh 46 46 - pnpm migrate 37 37 + pnpm dx 47 38 ``` 48 48 - 49 49 - 5. Set up your .env file 50 50 - 51 51 - from `apps/web` and `packages/db` you will find .env.example. Please create your 52 52 - own. 53 53 - 54 54 - 6. Start the web app locally 39 39 + 5. Start the development server 55 40 56 41 ```sh 57 57 - pnpm dev 42 42 + pnpm dev:web 58 43 ``` 59 44 60 60 - > 💡 If you are getting this error - 61 61 - > `ERROR run failed: error preparing engine: Invalid persistent task configuration: You have 15 persistent tasks but`turbo`is configured for concurrency of 10. Set --concurrency to at least 16` 62 62 - > Then `cd` into web directory and then start the web app 63 63 - > 64 64 - > ```sh 65 65 - > cd apps/web 66 66 - > pnpm dev 67 67 - > ``` 45 45 + 6. Open your browser and navigate to [http://localhost:3000](http://localhost:3000)

-19

apps/docs/contributing/requirements.mdx

··· 64 64 To install brew, it is recommended to use brew.sh from 65 65 [https://brew.sh/](https://brew.sh/) and follow its instructions. 66 66 67 67 - ### Installing sqld 68 68 - 69 69 - Once you have installed it and performed updates with 70 70 - `brew update --auto-update`, you can install "sqld" as follows: 71 71 - 72 72 - ```bash 73 73 - brew tap libsql/sqld 74 74 - brew install sqld-beta 75 75 - sqld --help 76 76 - ``` 77 77 - 78 78 - > _Note: Please ensure to add sqld to you system PATH_ 79 79 - 80 80 - This will allow you to work with the local database without modifying the ".env" 81 81 - file. 82 82 - 83 83 - Please note that these optional requirements are only necessary if you want to 84 84 - use a local database. Otherwise, you can continue with the rest of the 85 85 - configuration as mentioned previously. 86 67 87 68 ### Installing Turso 88 69

+1 -2

apps/docs/contributing/setup-env.mdx

··· 6 6 7 7 The `.env` file contains various environment variables that need to be properly 8 8 configured for the application to work correctly. Below, I will explain how to 9 9 - obtain the values for some of these variables, focusing on the section related 10 10 - to Cleark Auth. 9 9 + obtain the values for some of these variables. 11 10 12 11 ## Setting up Resend for sending emails 13 12

-64

apps/docs/contributing/setup.mdx

··· 1 1 - --- 2 2 - title: Setup 3 3 - --- 4 4 - 5 5 - Follow these steps for setup: 6 6 - 7 7 - ### Clone the repository 8 8 - 9 9 - To get started, clone the OpenStatus repository by running the following command 10 10 - in your terminal or command prompt: 11 11 - 12 12 - ```bash 13 13 - git clone https://github.com/openstatusHQ/openstatus.git 14 14 - ``` 15 15 - 16 16 - ### Install dependencies 17 17 - 18 18 - Once the repository is cloned, navigate to the `openstatus` directory using the 19 19 - command: 20 20 - 21 21 - ```bash 22 22 - cd openstatus 23 23 - ``` 24 24 - 25 25 - Next, use pnpm to install the required dependencies. Execute the following 26 26 - command: 27 27 - 28 28 - ```bash 29 29 - pnpm install 30 30 - ``` 31 31 - 32 32 - ### Configure .env files 33 33 - 34 34 - To configure the application, you need to set certain environment variables in a 35 35 - `.env` file. You will find an example file named `.env.example` in the 36 36 - `apps/web` and `packages/db` directories. Copy this file and rename it to 37 37 - `.env`. Then, edit the `.env` file with specific values required for your 38 38 - configuration. 39 39 - 40 40 - You can use any text editor, or manually copy it into an empty .env file or 41 41 - whatever you want to do. 42 42 - 43 43 - For example, you can use a text editor (nano) to open the `.env` file: 44 44 - 45 45 - ```bash 46 46 - # apps/web 47 47 - cp apps/web/.env.example apps/web/.env 48 48 - nano apps/web/.env 49 49 - 50 50 - # packages/db 51 51 - cp packages/db/.env.example packages/db/.env 52 52 - nano packages/db/.env 53 53 - ``` 54 54 - 55 55 - Make sure to provide appropriate values for each variable defined in the `.env` 56 56 - file. These variables may include configurations related to the database, API 57 57 - credentials, etc. 58 58 - 59 59 - ⚠️ Keep in mind that the `.env` file should be kept **private** and should not 60 60 - be shared publicly as it may contain sensitive information such as passwords or 61 61 - access keys. 62 62 - 63 63 - Once you have completed these steps, you will have finished the setup and 64 64 - configuration of OpenStatus, and you'll be ready to start the application.

+14 -15

apps/docs/mint.json

··· 122 122 "pages": [ 123 123 "contributing/requirements", 124 124 "contributing/get-started", 125 125 - "contributing/setup-env", 126 126 - "contributing/setup" 125 125 + "contributing/setup-env" 127 126 ] 128 127 }, 129 128 { ··· 134 133 { 135 134 "group": "Incident", 136 135 "pages": [ 137 137 - "api-reference/incident/get-incident:id", 136 136 + "api-reference/incident/get-incident-id", 138 137 "api-reference/incident/get-incident", 139 139 - "api-reference/incident/put-incident:id" 138 138 + "api-reference/incident/put-incident-id" 140 139 ] 141 140 }, 142 141 { 143 142 "group": "Monitor", 144 143 "pages": [ 145 145 - "api-reference/monitor/get-monitor:id", 144 144 + "api-reference/monitor/get-monitor-id", 146 145 "api-reference/monitor/get-monitor", 147 147 - "api-reference/monitor/delete-monitor:id", 146 146 + "api-reference/monitor/delete-monitor-id", 148 147 "api-reference/monitor/post-monitor", 149 149 - "api-reference/monitor/put-monitor:id" 148 148 + "api-reference/monitor/put-monitor-id" 150 149 ] 151 150 }, 152 151 { 153 152 "group": "Notification", 154 153 "pages": [ 155 154 "api-reference/notification/get-notification", 156 156 - "api-reference/notification/get-notification:id", 155 155 + "api-reference/notification/get-notification-id", 157 156 "api-reference/notification/post-notification" 158 157 ] 159 158 }, ··· 161 160 "group": "Page", 162 161 "pages": [ 163 162 "api-reference/page/get-page", 164 164 - "api-reference/page/get-page:id", 163 163 + "api-reference/page/get-page-id", 165 164 "api-reference/page/post-page", 166 166 - "api-reference/page/put-page:id", 167 167 - "api-reference/page/post-page:id/update" 165 165 + "api-reference/page/put-page-id", 166 166 + "api-reference/page/post-page-id/update" 168 167 ] 169 168 }, 170 169 { 171 170 "group": "Status Report", 172 171 "pages": [ 173 173 - "api-reference/status_report/get-status_report:id", 172 172 + "api-reference/status_report/get-status_report-id", 174 173 "api-reference/status_report/get-status_report", 175 175 - "api-reference/status_report/delete-status_report:id", 174 174 + "api-reference/status_report/delete-status_report-id", 176 175 "api-reference/status_report/post-status_report", 177 177 - "api-reference/status_report/post-status_report:id/update" 176 176 + "api-reference/status_report/post-status_report-id/update" 178 177 ] 179 178 }, 180 179 { 181 180 "group": "Status Report Udpate", 182 181 "pages": [ 183 183 - "api-reference/status_report_update/get-status_report_update:id", 182 182 + "api-reference/status_report_update/get-status_report_update-id", 184 183 "api-reference/status_report_update/post-status_report_update" 185 184 ] 186 185 },

+1 -1

apps/docs/synthetic/overview.mdx

··· 3 3 description: "How does OpenStatus' synthetic monitoring work?" 4 4 --- 5 5 6 6 - With our synthetic monitoring, you can track the availability and performance of 6 6 + With our synthetic monitoring, you can monitor the availability and performance of 7 7 your website or API from various global locations. 8 8 9 9 We will monitor your website or API on a regular schedule and record the