···11+---
22+title: Status page
33+description: "How to create your first status page ๐ฅ"
44+---
55+66+In order to create your status page, you need to create at least one monitor.
77+88+<Frame caption="Create your status page">
99+ <img
1010+ src="/images/status-page/status-page-empty.png"
1111+ alt="Create your status page"
1212+ />
1313+</Frame>
···11-import { Callout } from "nextra/components";
22-33-# Auth Token
11+---
22+title: Authentication
33+---
4455In your Settings, you can create and later revoke your API token. Once created,
66it will be shown only once so keep it safe.
-31
apps/docs/pages/api-server/openapi.mdx
···11-import dynamic from "next/dynamic";
22-import { Callout } from "nextra/components";
33-import { useData } from "nextra/data";
44-55-export const getStaticProps = async ({ params }) => {
66- const res = await fetch("https://api.openstatus.dev/v1/openapi");
77- const spec = await res.json();
88- return {
99- props: {
1010- // We add an `ssg` field to the page props,
1111- // which will be provided to the Nextra `useData` hook.
1212- ssg: { spec },
1313- },
1414- // The page will be considered as stale and regenerated every 60 seconds.
1515- revalidate: 60,
1616- };
1717-};
1818-1919-export const Swagger = () => {
2020- // Get the data from SSG, and render it as a component.
2121- const SwaggerUI = dynamic(import("swagger-ui-react"), { ssr: false });
2222- const { spec } = useData();
2323- console.log(spec);
2424- return <SwaggerUI spec={spec} />;
2525-};
2626-2727-# OpenAPI
2828-2929-<Callout emoji="๐ง">Work in progress</Callout>
3030-3131-<Swagger />
···11+---
22+title: Get Started
33+---
44+15## Setup
26371. Clone the repository and open the created directory
···444845495. Set up your .env file
46504747-from `apps/web` and `packages/db` you will find .env.example. Please create your own.
5151+from `apps/web` and `packages/db` you will find .env.example. Please create your
5252+own.
485349546. Start the web app locally
50555156```sh
5257pnpm dev
5358```
5454-> ๐ก If you are getting this error - ` ERROR run failed: error preparing engine: Invalid persistent task configuration:
5555-You have 15 persistent tasks but `turbo` is configured for concurrency of 10. Set --concurrency to at least 16
5656-`
5757-Then `cd` into web directory and then start the web app
5959+6060+> ๐ก If you are getting this error -
6161+> `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`
6262+> Then `cd` into web directory and then start the web app
6363+>
5864> ```sh
5965> cd apps/web
6066> pnpm dev
6161-> ```
6767+> ```
626863697. Clerk Authentication
6470
···11+---
22+title: Requirements
33+---
44+15## System Requirements
2633-Before you start, make sure you have the following applications and their minimum versions installed,
44-in addition to Node.js and pnpm (as mentioned earlier):
77+Before you start, make sure you have the following applications and their
88+minimum versions installed, in addition to Node.js and pnpm (as mentioned
99+earlier):
510611- [Node.js 18.0.0](https://nodejs.org/) or later.
712- [pnpm 8.6.2](https://nodejs.org/) or later.
···6974brew install sqld-beta
7075sqld --help
7176```
7272-> *Note: Please ensure to add sqld to you system PATH*
7777+7878+> _Note: Please ensure to add sqld to you system PATH_
73797480This will allow you to work with the local database without modifying the ".env"
7581file.
···11+---
22+title: Setup environment files
33+---
44+15# Configuration of the .env file
2637The `.env` file contains various environment variables that need to be properly
···260264and save the changes to the `.env` file once you have completed all the
261265configurations.
262266263263-264267## **Connect datasource using tinybird-cli**
265268266266-1. Log in to your tinybird account at https://www.tinybird.co/ or create a new account if you don't have one yet.
269269+1. Log in to your tinybird account at https://www.tinybird.co/ or create a new
270270+ account if you don't have one yet.
267271268268-2. Once logged in, go to your dashboard and copy the auth token and paste inside `.env`
269269-> Please make sure you chose the admin token otherwise it may give an error like auth token invalid
272272+2. Once logged in, go to your dashboard and copy the auth token and paste inside
273273+ `.env`
270274271271-3. Then download this file [ping_response__v3](https://docs.openstatus.dev/dummy/ping_response__v3.csv)
275275+ > Please make sure you chose the admin token otherwise it may give an error
276276+ > like auth token invalid
277277+278278+3. Then download this file
279279+ [ping_response\_\_v3](https://docs.openstatus.dev/dummy/ping_response__v3.csv)
2722802732814. install the tinybird-cli
274282···280288281289```
282290283283-5. Create a datasource from this file
284284-> Please make sure while importing you edit the table header fields in camelcase .
291291+5. Create a datasource from this file
285292286286-6. Create pipe from the datasource name as a `response_list__v0` and `monitor_list__v0`
293293+ > Please make sure while importing you edit the table header fields in
294294+ > camelcase .
287295288288-7. Inside `response_list__v0` pipe, create a endpoint by running a following query :
296296+6. Create pipe from the datasource name as a `response_list__v0` and
297297+ `monitor_list__v0`
298298+299299+7. Inside `response_list__v0` pipe, create a endpoint by running a following
300300+ query :
289301290302```
291303%
···308320 LIMIT {{Int32(limit, 1000)}}
309321```
310322311311-8. Inside `monitor_list__v0` pipe , create a endpoint by running a following query :
323323+8. Inside `monitor_list__v0` pipe , create a endpoint by running a following
324324+ query :
312325313326```
314327%
···324337 GROUP BY cronTimestamp
325338 ORDER BY cronTimestamp DESC
326339 LIMIT {{Int32(limit, 1000)}}
327327-340340+328341```
329329-330342331343## Conclusion
332344
···11+---
22+title: Setup
33+---
44+15Follow these steps for setup:
2637### Clone the repository
···5256file. These variables may include configurations related to the database, API
5357credentials, etc.
54585555-โ ๏ธ Keep in mind that the `.env` file should be kept **private** and should not be
5656-shared publicly as it may contain sensitive information such as passwords or
5959+โ ๏ธ Keep in mind that the `.env` file should be kept **private** and should not
6060+be shared publicly as it may contain sensitive information such as passwords or
5761access keys.
58625963Once you have completed these steps, you will have finished the setup and
···11-{
22- "monitor": "Create your first monitor",
33- "heartbeat": "Create your first heartbeat",
44- "alerting": "Create your first alert",
55- "status-page": "Create your status page"
66-}
···11-# Create your first alert
11+---
22+title: Alert
33+description: "How to create your first alert with OpenStatus.dev"
44+---
2536## What is an alert? ๐จ
47···710to ping your website.
811912## Configure your alert ๐
1010-1111-๐ง Coming soon ๐ง
···11-# Create your first heartbeat
11+---
22+title: Heartbeat
33+description: "How to create your first heartbeat with OpenStatus.dev"
44+---
2536## What is a heartbeat? ๐
47
···11-# Create your first monitor
11+---
22+title: Monitor
33+description: "How to create your first monitor with OpenStatus.dev"
44+---
2536## What is a monitor? ๐งโ๐ซ
47···710811## Configure your monitor ๐
9121010-
1313+<Frame caption="Create your first monitor">
1414+ <img src="/images/monitor/monitor.png" alt="Create your first monitor" />
1515+</Frame>
11161217A monitor requires a few things to be configured:
1318
-5
apps/docs/pages/getting-started/status-page.mdx
···11-# Create your status page ๐ฅ
22-33-In order to create your status page, you need to create at least one monitor.
44-55-
···11+---
22+title: Incident Automation
33+description: "How to use incident automation"
44+---
55+16# What is incident automation? ๐ค
2738When you have an incident, you might need to perform a series of actions to
···11-# What is OpenStatus? ๐ค
11+---
22+title: What is OpenStatus?
33+---
2433-OpenStatus is an open-source alternative to your current monitoring service with a beautiful
44-status page.
55+OpenStatus is an open-source alternative to your current monitoring service with
66+a beautiful status page.
5768## Getting Started
79
···11-# Discord
11+---
22+title: Discord
33+---
2435When a monitor is down you can set up a webhook to send a message to a Discord
46channel. You can set up a webhook in the Discord settings. The webhook URL
···11-# Slack
11+---
22+title: Slack
33+---
2435When a monitor is down, a message can be sent to a Slack channel. To enable this
46feature, you need to create a Slack webhook. You can do this by following the