Skip to content

Open-source status page, incident response and uptime monitoring

✍️ add more docs (#859)

Thibault Le Ouay39b00b094173
diff --git a/Docker/clickhouse/docker-compose.yaml b/Docker/clickhouse/docker-compose.yaml
deleted file mode 100644
index 98514d399..000000000
--- a/Docker/clickhouse/docker-compose.yaml
+++ /dev/null
@@ -1,30 +0,0 @@
-version: "3"
-
-services:
- ch:
- image: clickhouse/clickhouse-server:22.8.21.38-alpine
- ports:
- # enable whichever ports you need. prob just 9000 for starters
- # tcp
- - 127.0.0.1:9000:9000
- # http
- - 127.0.0.1:8123:8123
- # postgresql
- - 127.0.0.1:9005:9005
- volumes:
- # optional to persist data locally
- - ./data:/var/lib/clickhouse/
- # optional to add own config
- - ./extra-config.xml:/etc/clickhouse-server/config.d/extra-config.xml
- # optional to add users or enable settings for a default user
- # - ./user.xml:/etc/clickhouse-server/users.d/user.xml
- # qol to mount own sql scripts to run them from inside container with
- # clickhouse client < /sql/myquery.sql
- - ../../packages/db/clickhouse:/docker-entrypoint-initdb.d
- # adjust mem_limit and cpus to machine
- mem_limit: 2G
- cpus: 1
- ulimits:
- nofile:
- soft: 262144
- hard: 262144
diff --git a/apps/docs/images/monitor/public-monitor.png b/apps/docs/images/monitor/public-monitor.png
new file mode 100644
index 000000000..4636e404d
Binary files /dev/null and b/apps/docs/images/monitor/public-monitor.png differ
diff --git a/apps/docs/images/monitor/setting-public-monitor.png b/apps/docs/images/monitor/setting-public-monitor.png
new file mode 100644
index 000000000..d1b0f8281
Binary files /dev/null and b/apps/docs/images/monitor/setting-public-monitor.png differ
diff --git a/apps/docs/mint.json b/apps/docs/mint.json
index e87653edd..83e74af2b 100644
--- a/apps/docs/mint.json
+++ b/apps/docs/mint.json
@@ -160,7 +160,7 @@
]
},
{
- "group": "Page",
+ "group": "Status Page",
"pages": [
"api-reference/page/get-page",
"api-reference/page/get-page-id",
diff --git a/apps/docs/synthetic/features/monitor.mdx b/apps/docs/synthetic/features/monitor.mdx
index b94d15ce9..871721b80 100644
--- a/apps/docs/synthetic/features/monitor.mdx
+++ b/apps/docs/synthetic/features/monitor.mdx
@@ -93,6 +93,33 @@ We currently support the following assertions on the following fields:
- **Status Code**
- **Response Body**
+
+## Public Monitor 🌐
+
+You can make your monitor public by checking **Allow public monitor**.
+
+<Frame caption="Public monitor setting">
+ <img
+ src="/images/monitor/setting-public-monitor.png"
+ alt="Public monitor setting"
+ />
+</Frame>
+
+
+
+A public monitor is accessible by anyone with the monitor URL.
+e.g. https://status.openstatus.dev/monitors/1
+
+
+<Frame caption="Public monitor">
+ <img
+ src="/images/monitor/public-monitor.png"
+ alt="Public monitor"
+ />
+</Frame>
+
+If the monitor is attached to a **status page**, the monitor will be displayed on the status page in the **Monitors** tab.
+
## Video Tutorial 📺
<iframe width="560" height="315" src="https://www.youtube.com/embed/nYti3DjHoWY?si=RBGFHzoHFmwphRft" title="YouTube video player" frameborder="0" allow="accelerometer; autoplay; clipboard-write; encrypted-media; gyroscope; picture-in-picture; web-share" referrerpolicy="strict-origin-when-cross-origin" allowfullscreen></iframe>
diff --git a/apps/docs/synthetic/features/status-page.mdx b/apps/docs/synthetic/features/status-page.mdx
index ba63920e8..1207cfa46 100644
--- a/apps/docs/synthetic/features/status-page.mdx
+++ b/apps/docs/synthetic/features/status-page.mdx
@@ -41,7 +41,7 @@ If you want the dark version of the badge, you can use the following URL:
You can also customize the size of the badge by adding a `size` parameter:
-- `sm
+- `sm`
- `md`
- `lg`
- `xl`
@@ -49,4 +49,8 @@ You can also customize the size of the badge by adding a `size` parameter:
```html
<img src="https://YOUR-SLUG.openstatus.dev/badge?theme=dark&size=xl" />
-```
\ No newline at end of file
+```
+
+## Add monitors metrics 📊
+
+If you make your <a href="/synthetic/features/monitor#public-monitor">monitor public</a>, you can display the metrics on your status page.
\ No newline at end of file
diff --git a/apps/docs/synthetic/overview.mdx b/apps/docs/synthetic/overview.mdx
index 73fd71a1b..02f85875e 100644
--- a/apps/docs/synthetic/overview.mdx
+++ b/apps/docs/synthetic/overview.mdx
@@ -11,7 +11,7 @@ responses.
We will alert you if your website or API is down, slow or does not return the expected response.
-You can create monitors in our dashboard, with the API or with Terraform.
+You can create monitors in our dashboard, with the <a href="/api-reference/monitor/post-monitor">API</a> or with <a href="/packages/terraform">Terraform</a>.
## Locations 🌍