diff --git a/README.md b/README.md index d823e51c5f..49932aa9c5 100644 --- a/README.md +++ b/README.md @@ -1,107 +1,48 @@

-

OpenStatus

+

openstatus

-

- - - -

- -

The Open-Source synthetic monitoring platform. +

The open-source status page and uptime monitoring platform.
Learn more ยป

- Discord + Documentation ยท Website ยท - Issues + Discord

-

- -## 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 ๐Ÿ† - -openstatusHQ%2Fopenstatus | Trendshift - - - Featured on Hacker News - - - - OpenStatus - #2 Product of the Day on Product Hunt - -## 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

-Book us with Cal.com - -## 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 - - - - - -Made with [Contrib.rocks](https://contrib.rocks) +

+ openstatus status -### Stats +

+

+ License + GitHub stars + Discord +

-![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)** +openstatus | Trendshift +Featured on Hacker News +openstatus - #2 Product of the Day on Product Hunt -## Getting Started ๐Ÿš€ +## Getting Started ### With Docker (Recommended) @@ -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 @@ -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). + + + + + +![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. + +Book us with Cal.com -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).