Skip to content

improve readme #1930

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
thibaultleouay wants to merge 1 commit into from
Closed

improve readme #1930

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
163 changes: 65 additions & 98 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,107 +1,48 @@
<p align="center" style="margin-top: 120px">

<h3 align="center">OpenStatus</h3>
<h3 align="center">openstatus</h3>

<p align="center">
<a href="https://status.openstatus.dev">
<img src='https://status.openstatus.dev/badge/v2?variant=outline'>
</a>
</p>

<p align="center">The Open-Source synthetic monitoring platform.
<p align="center">The open-source status page and uptime monitoring platform.
<br />
<a href="https://www.openstatus.dev"><strong>Learn more »</strong></a>
<br />
<br />
<a href="https://www.openstatus.dev/discord">Discord</a>
<a href="https://docs.openstatus.dev">Documentation</a>
·
<a href="https://www.openstatus.dev">Website</a>
·
<a href="https://github.com/openstatushq/openstatus/issues">Issues</a>
<a href="https://www.openstatus.dev/discord">Discord</a>
</p>
</p>

## About OpenStatus 🏓

OpenStatus is open-source synthetic monitoring platform.

- **Synthetic monitoring**: Monitor your website and APIs globally and receive
notifications when they are down or slow.

## Recognitions 🏆

<a href="https://trendshift.io/repositories/1780" target="_blank"><img src="https://trendshift.io/api/badge/repositories/1780" alt="openstatusHQ%2Fopenstatus | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>

<a href="https://news.ycombinator.com/item?id=37740870">
<img
alt="Featured on Hacker News"
src="https://hackerbadge.now.sh/api?id=37740870"
style="width: 250px; height: 55px;" width="250" height="55"
/>
</a>

<a href="https://www.producthunt.com/posts/openstatus-2?utm_source=badge-top-post-badge&utm_medium=badge" target="_blank">
<img
alt="OpenStatus - #2 Product of the Day on Product Hunt"
src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=openstatus-2&theme=light&period=daily"
style="width: 250px; height: 55px;" width="250" height="55"
/>
</a>

## Contact us 💌

If you are interested in our enterprise plan or need special features, please
email us at [ping@openstatus.dev](mailto:ping@openstatus.dev) or book a
call<br/><br/>
<a href="https://cal.com/team/openstatus/30min"><img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-dark.svg" /></a>

## Contributing 🤝

If you want to help us building the best status page and alerting system, you
can check our
[contributing guidelines](https://github.com/openstatusHQ/openstatus/blob/main/CONTRIBUTING.MD)

### Top Contributors

<a href="https://github.com/openstatushq/openstatus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=openstatushq/openstatus" />
</a>

Made with [Contrib.rocks](https://contrib.rocks)
<p align="center">
<a href="https://status.openstatus.dev"><img src="https://status.openstatus.dev/badge/v2?variant=outline" alt="openstatus status"></a>

### Stats
</p>
<p align="center">
<a href="https://github.com/openstatushq/openstatus/blob/main/LICENSE"><img src="https://img.shields.io/badge/license-AGPL--3.0-blue.svg" alt="License"></a>
<a href="https://github.com/openstatushq/openstatus/stargazers"><img src="https://img.shields.io/github/stars/openstatushq/openstatus?style=social" alt="GitHub stars"></a>
<a href="https://www.openstatus.dev/discord"><img src="https://img.shields.io/discord/1129008226264940625?color=7289da&logo=discord&logoColor=white" alt="Discord"></a>
</p>

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

## Tech stack 🥞
openstatus is an open-source platform that combines **status pages** and **uptime monitoring** in a single tool. Keep your users informed and your services reliable. Available as a managed service or self-hosted.

- [Next.js](https://nextjs.org/)
- [Tailwind CSS](https://tailwindcss.com/)
- [shadcn/ui](https://ui.shadcn.com/)
- [tinybird](https://tinybird.co/?ref=openstatus.dev)
- [turso](https://turso.tech/)
- [drizzle](https://orm.drizzle.team/)
- [Resend](https://resend.com/)
### Status pages

[![Built with Depot](https://depot.dev/badges/built-with-depot.svg)](https://depot.dev/?utm_source=Opource=OpenStatus)
Beautiful, customizable status pages with custom domains, password protection, maintenance windows, and subscriber notifications via email and RSS. Build trust and keep your users informed during incidents.

## Quick Start with Coolify 🚀
### Synthetic monitoring

We provide pre-built Docker images for easy deployment with Coolify:
Monitor your servers, websites and APIs from 28 regions across multiple cloud providers globally. Get notified via Slack, Discord, PagerDuty, email, and more when your services are down or slow.

```bash
# Example Coolify configuration
ghcr.io/openstatushq/openstatus-server:latest
ghcr.io/openstatushq/openstatus-dashboard:latest
ghcr.io/openstatushq/openstatus-workflows:latest
ghcr.io/openstatushq/openstatus-private-location:latest
ghcr.io/openstatushq/openstatus-status-page:latest
ghcr.io/openstatushq/openstatus-checker:latest
```
## Recognitions

📖 **[Complete Coolify Deployment Guide](./COOLIFY_DEPLOYMENT.md)**
<a href="https://trendshift.io/repositories/1780" target="_blank"><img src="https://trendshift.io/api/badge/repositories/1780" alt="openstatus | Trendshift" style="width: 250px; height: 55px;" width="250" height="55"/></a>
<a href="https://news.ycombinator.com/item?id=37740870"><img alt="Featured on Hacker News" src="https://hackerbadge.now.sh/api?id=37740870" style="width: 250px; height: 55px;" width="250" height="55" /></a>
<a href="https://www.producthunt.com/posts/openstatus-2?utm_source=badge-top-post-badge&utm_medium=badge" target="_blank"><img alt="openstatus - #2 Product of the Day on Product Hunt" src="https://api.producthunt.com/widgets/embed-image/v1/top-post-badge.svg?post_id=openstatus-2&theme=light&period=daily" style="width: 250px; height: 55px;" width="250" height="55" /></a>

## Getting Started 🚀
## Getting Started

### With Docker (Recommended)

Expand All @@ -119,20 +60,22 @@ open http://localhost:3002 # Dashboard
open http://localhost:3003 # Status Pages
```

📖 **Full guide**: [DOCKER.md](DOCKER.md)
Full guide: [DOCKER.md](DOCKER.md)

### With Devbox
### Self-Hosting with Coolify

You can use [Devbox](https://www.jetify.com/devbox/) and get started with the following commands:
We provide pre-built Docker images for easy deployment:

1. Install Devbox
```sh
curl -fsSL https://get.jetify.com/devbox | bash
```
2. Install project dependencies, build and start services
```sh
devbox services up
```
```bash
ghcr.io/openstatushq/openstatus-server:latest
ghcr.io/openstatushq/openstatus-dashboard:latest
ghcr.io/openstatushq/openstatus-workflows:latest
ghcr.io/openstatushq/openstatus-private-location:latest
ghcr.io/openstatushq/openstatus-status-page:latest
ghcr.io/openstatushq/openstatus-checker:latest
```

[Complete Coolify Deployment Guide](./COOLIFY_DEPLOYMENT.md)

### Manual Setup

Expand Down Expand Up @@ -179,15 +122,39 @@ pnpm dev:status-page
pnpm dev:dashboard
```

The above commands whill automatically run the libSQL client on `8080` so you might wanna kill the turso command from step 3.
The above commands will automatically run the libSQL client on `8080` so you might want to kill the turso command from step 3.

5. See the results:

- open [http://localhost:3000](http://localhost:3000) (default port)

### Videos
## Tech Stack

- [Next.js](https://nextjs.org/) - Dashboard
- [Hono](https://hono.dev/) - API server
- [Go](https://go.dev/) - Checker
- [Turso](https://turso.tech/) - Database
- [Drizzle](https://orm.drizzle.team/) - ORM
- [Tinybird](https://tinybird.co/?ref=openstatus.dev) - Analytics
- [Tailwind CSS](https://tailwindcss.com/) - Styling
- [shadcn/ui](https://ui.shadcn.com/) - UI components

## Contributing

If you want to help us build the best status page and monitoring platform, check our [contributing guidelines](https://github.com/openstatusHQ/openstatus/blob/main/CONTRIBUTING.MD).

<a href="https://github.com/openstatushq/openstatus/graphs/contributors">
<img src="https://contrib.rocks/image?repo=openstatushq/openstatus" />
</a>

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

## Contact

Interested in our enterprise plan or need special features? Email us at [ping@openstatus.dev](mailto:ping@openstatus.dev) or book a call.

<a href="https://cal.com/team/openstatus/30min"><img alt="Book us with Cal.com" src="https://cal.com/book-with-cal-dark.svg" /></a>

Videos to better understand the OpenStatus codebase:
## License

- [The code behind OpenStatus and how it uses Turbopack](https://youtube.com/watch?v=PYfSJATE8v8).
- [Drop Betterstack and go open source](https://www.youtube.com/watch?v=PKag0USy3eQ)
Distributed under the [AGPL-3.0 License](LICENSE).