Skip to content

Commit

Permalink
📝 probe doc (#933)
Browse files Browse the repository at this point in the history
* 📝 probe doc

* 🔥 guide probe

* 🚀
  • Loading branch information
thibaultleouay authored Jul 24, 2024
1 parent 8d1b2f8 commit eafc3eb
Show file tree
Hide file tree
Showing 10 changed files with 89 additions and 4 deletions.
4 changes: 3 additions & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -74,7 +74,7 @@ Made with [Contrib.rocks](https://contrib.rocks)

![Alt](https://repobeats.axiom.co/api/embed/180eee159c0128f683a30f15f51ac35bdbd9fa44.svg "Repobeats analytics image")

## Built with 🛠️
## Tech stack 🥞

- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
Expand All @@ -84,6 +84,8 @@ Made with [Contrib.rocks](https://contrib.rocks)
- [drizzle](https://orm.drizzle.team/)
- [Resend](https://resend.com/)

[![Built with Depot](https://depot.dev/badges/built-with-depot.svg)](https://depot.dev/?utm_source=Opource=OpenStatus)

## Getting Started 🚀

### Requirements
Expand Down
67 changes: 67 additions & 0 deletions apps/docs/guides/how-deploy-checker-koyeb.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
---
title: How to deploy your own checker on Koyeb
description: Learn how to deploy our checker on Koyeb.`
---

## Introduction

You need a koeyb account to deploy our checker on Koyeb. If you don't have one, you can create one [here](https://app.koyeb.com/).

## Deploying the checker

1. Go to the [Koyeb dashboard](https://app.koyeb.com/).

2. Click on the `Create Service` button.

3. Select the `Docker` option.


<Frame>
<img
src="/images/guides/how-deploy-checker-koyeb/koyeb-1.png"
alt="Koyeb"
/>
</Frame>


4. In the `Image` field, enter `ghcr.io/openstatushq/checker:latest`.


<Frame>
<img
src="/images/guides/how-deploy-checker-koyeb/koyeb-2.png"
alt="Koyeb"
/>
</Frame>

5. Click on the `Next` button.

6. Fill the following settings

You should set the following environment variables
- `CLOUD_PROVIDER` : Koyeb
- `REGION` : The koyeb region where you want to deploy your checker
- `CRON_SECRET` : A secret key to secure your endpoint to avoid unauthorized access

<Frame>
<img
src="/images/guides/how-deploy-checker-koyeb/koyeb-3.png"
alt="Koyeb"
/>
</Frame>

## Calling your probe

Once your checker is deployed, you can call it using the following command:

```bash
curl --request POST \
--url https://YOUR_KOYEB_URL.koyeb.app/ping/KOYEB_REGION \
--header 'Authorization: Basic test' \
--header 'Content-Type: application/json' \
--data '{
"url": "https://www.openstatus.dev",
"method": "GET",
}'
```

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
1 change: 1 addition & 0 deletions apps/docs/mint.json
Original file line number Diff line number Diff line change
Expand Up @@ -212,6 +212,7 @@
"group": "Guides",
"pages": [
"guides/introduction",
"guides/how-deploy-checker-koyeb",
"guides/test-latency-cf-workers-in-github-actions",
"guides/how-deploy-status-page-cf-pages"
]
Expand Down
1 change: 1 addition & 0 deletions apps/docs/synthetic/overview.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -36,3 +36,4 @@ monitors to your users.
Don't wait for your users to tell you that your website or API is down.

You can configure alerts to be notified when your monitor is down or slow, or does not return the expected response.

Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
16 changes: 16 additions & 0 deletions apps/web/src/content/changelog/docker-checker.mdx
Original file line number Diff line number Diff line change
@@ -0,0 +1,16 @@
---
title: Docker Image Checker
description: Our checker has been published to a container registry.
image: /assets/changelog/docker-probe.png
publishedAt: 2024-07-24
---

You can deploy our checker within your infrastructure, any cloud providers or coolify by pulling the image from the container registry.

The image is available at `ghcr.io/openstatushq/checker:latest`.

It opens up a lot of possibilities to run the checker in your own environment, on your own infrastructure, or on any cloud provider. We will be able to add private locations soon.

We have created a guide to help you deploy our checker on [Koyeb](https://www.koyeb.com/).

Thanks to [Depot](https://depot.dev/?utm_source=Opource=OpenStatus) for the fast build and the easy integration with GitHub Actions.
4 changes: 1 addition & 3 deletions apps/web/src/content/posts/pricing-update-july-2024.mdx
Original file line number Diff line number Diff line change
Expand Up @@ -19,9 +19,7 @@ In light of these improvements, we realized our pricing needed a refresh to accu

Let's dive into the details of our update and why it matters.

**We have grandfathered all our existing users into the previous pricing, so this update only affects new users."

**
**We have grandfathered all our existing users into the previous pricing, so this update only affects new users.**

## 🫳 9️⃣ We Dropped the 9: Embracing Clean Pricing

Expand Down

0 comments on commit eafc3eb

Please sign in to comment.