diff --git a/README.md b/README.md index 480b4d693a..a88c4aa47f 100644 --- a/README.md +++ b/README.md @@ -1,103 +1,184 @@

oneuptime logo

+ +

+ The Complete Open-Source Observability Platform +

+ +

+ License + Release + Stars + Helm Chart + Slack +

+ +

+ Website • + Documentation • + Pricing • + Installation • + Contributing +

-### OneUptime: The Complete Open-Source Observability Platform +--- -OneUptime is a comprehensive solution for monitoring and managing your online services. Whether you need to check the availability of your website, dashboard, API, or any other online resource, OneUptime can alert your team when downtime happens and keep your customers informed with a status page. OneUptime also helps you handle incidents, set up on-call rotations, run tests, secure your services, analyze logs, track performance, and debug errors. +## What is OneUptime? -OneUptime replaces multiple tools with one integrated platform: +OneUptime is a comprehensive solution for monitoring and managing your online services. Whether you need to check the availability of your website, dashboard, API, or any other online resource, OneUptime can alert your team when downtime happens and keep your customers informed with a status page. +**OneUptime replaces multiple tools with one integrated platform:** -#### Uptime Monitoring +| Replace | With OneUptime | +|---------|----------------| +| Pingdom | Uptime Monitoring | +| StatusPage.io | Status Pages | +| PagerDuty | On-Call & Alerts | +| Incident.io | Incident Management | +| Loggly | Logs Management | +| New Relic / Datadog | Application Performance Monitoring | +| Sentry | Error Tracking | -Monitor the availability and response time of your online services from multiple locations around the world. Get notified via email, SMS, Slack, or other channels when something goes wrong. Replace tools like Pingdom. +--- + +## ✨ Features + +### 📊 Uptime Monitoring + +Monitor the availability and response time of your online services from multiple locations around the world. Get notified via email, SMS, Slack, or other channels when something goes wrong. ![Monitoring](/Home/Static/img/readme/monitoring.png?raw=true) -#### Status Pages +### 📋 Status Pages -Communicate with your customers and stakeholders during downtime or maintenance. Create a custom-branded status page that shows the current status and history of your services. Replace tools like StatusPage.io. +Communicate with your customers and stakeholders during downtime or maintenance. Create a custom-branded status page that shows the current status and history of your services. ![Status Pages](/Home/Static/img/readme/statuspages.png?raw=true) -#### Incident Management +### 🚨 Incident Management -Manage incidents from start to finish with a collaborative workflow. Create incident reports, assign tasks, update stakeholders, and document resolutions. Replace tools like Incident.io. +Manage incidents from start to finish with a collaborative workflow. Create incident reports, assign tasks, update stakeholders, and document resolutions. ![Incident Management](/Home/Static/img/readme/incident-management.png?raw=true) -#### On Call and Alerts -Schedule on-call shifts for your team and define escalation policies. Ensure that the right person is notified at the right time when an incident occurs. Replace tools like PagerDuty. +### 📞 On-Call & Alerts + +Schedule on-call shifts for your team and define escalation policies. Ensure that the right person is notified at the right time when an incident occurs. ![On Call and Alerts](/Home/Static/img/readme/on-call.png?raw=true) -#### Logs Management +### 📝 Logs Management -Collect, store, and analyze logs from your online services. Search, filter, and visualize log data to gain insights and troubleshoot issues. Replace tools like Loggly. +Collect, store, and analyze logs from your online services. Search, filter, and visualize log data to gain insights and troubleshoot issues. ![Logs Management](/Home/Static/img/readme/logs-management.png?raw=true) -#### Workflows +### ⚡ Workflows -Integrate OneUptime with your existing tools and automate your workflows. Integrate with tools like Slack, Jira, GitHub, and 5000+ more. +Integrate OneUptime with your existing tools and automate your workflows. Connect with Slack, Jira, GitHub, and 5000+ more applications. ![Workflows](/Home/Static/img/readme/workflows.png?raw=true) -#### Application Performance Monitoring +### 🔍 Application Performance Monitoring -Measure and optimize the performance of your online apps and services. Track key metrics such as traces, response time, throughput, error rate, and user satisfaction. Replace tools like NewRelic and DataDog. +Measure and optimize the performance of your online apps and services. Track key metrics such as traces, response time, throughput, error rate, and user satisfaction. ![APM](/Home/Static/img/readme/apm.png?raw=true) -#### Error Tracking +### 🐛 Error Tracking -Detect and diagnose errors in your online services. Get detailed error reports with stack traces, context, and user feedback. Replace tools like Sentry. +Detect and diagnose errors in your online services. Get detailed error reports with stack traces, context, and user feedback. -All under one platform. +--- -## Get Started for Free with OneUptime Cloud +## 🚀 Get Started -OneUptime Cloud is the easiest and fastest way to monitor your website uptime and performance. You can sign up for free to [OneUptime Cloud](https://oneuptime.com) and enjoy the full benefits of OneUptime without any installation or maintenance hassle. +### OneUptime Cloud (Recommended) -By using OneUptime Cloud, you also support the development of OneUptime open-source project, which is a powerful and flexible tool for website monitoring. You can find more information about OneUptime open-source project on [GitHub](##Philosophy). The code of OneUptime is completely open-source, which means you can access, modify, and distribute it freely. You can also contribute to the project by reporting issues, suggesting features, or submitting pull requests. +The easiest and fastest way to get started. Sign up for free at [oneuptime.com](https://oneuptime.com) and enjoy the full benefits of OneUptime without any installation or maintenance. -If you need advanced features, such as API Access, Advanced Workflows, or Advanced Access Control, you can upgrade to a paid plan anytime. You can compare the different plans and pricing on [OneUptime Pricing](https://oneuptime.com/pricing) page. - - -## Community vs. Enterprise Editions - -| Edition | Ideal For | Highlights | Requirements | -|--------------------|-------------------------------------------------------|--------------------------------------------------------------------------------------------------------------------------------------------------------------------------|--------------| -| Community Edition | Self-hosters getting started with the open-source stack | Full OneUptime feature set with the standard security posture; community-driven support channels; rapid updates via public releases | None | -| Enterprise Edition | Regulated teams that need hardened deployments and premium support | Hardened container images with additional security controls;
Custom features and roadmap input;
Dedicated engineer with 1-hour priority phone support;
Custom data residency and retention options;
Deploy on private cloud or SaaS with annual invoicing | Valid enterprise license (contact `sales@oneuptime.com`) | - - -## Installation - -- [Install on Kubernetes with Helm](https://artifacthub.io/packages/helm/oneuptime/oneuptime) (recommended for production) -- [Install with Docker Compose](/Docs/Content/installation/docker-compose.md) (single-node install, not recommended for production) -- [Install for Local Development](/Docs/Content/installation/local-development.md) -- [Upgrade OneUptime](/Docs/Content/installation/upgrading.md) - -## Philosophy - -Our mission is to reduce downtime and increase the number of successful products in the world. To do that, we built a platform that helps you understand the causes of downtime, incidents and help reduce toil. Our product is open-source, free and available for everyone to use. - -## Contributing - -We <3 contributions big and small. In priority order (although everything is appreciated) with the most helpful first: - -- Give us feedback in our [Customer Slack community](https://join.slack.com/t/oneuptimesupport/shared_invite/zt-2pz5p1uhe-Fpmc7bv5ZE5xRMe7qJnwmA) -- Talk to developers in our [Developer Slack community](https://join.slack.com/t/oneuptimedev/shared_invite/zt-17r8o7gkz-nITGan_PS9JYJV6WMm_TsQ) -- Write tests for some of our codebase. [See issues here](https://github.com/OneUptime/oneuptime/issues?q=is%3Aopen+is%3Aissue+label%3A%22write+tests%22) -- Work on any issue you like. [See issues here](https://github.com/OneUptime/oneuptime/issues) -- Open new issues and create new feature requests that you would like to see. [Open issues here](https://github.com/OneUptime/oneuptime/issues) - -## Donate - -If you like the project, please consider a small donation. Every single dollar will be used to ship new features or maintain existing ones. 100% of the work we do is open-source. [Please donate here](https://github.com/sponsors/OneUptime) - -**Merch:** Support the development of OneUptime by purchasing from our [Merch Store](https://shop.oneuptime.com). All revenue generated from the store will go directly towards funding the open-source development of OneUptime. Show your support and get some cool swag! +By using OneUptime Cloud, you also support the continued development of the open-source project. + +**[Get Started Free →](https://oneuptime.com)** + +### Self-Hosted Installation + +- **[Kubernetes with Helm](https://artifacthub.io/packages/helm/oneuptime/oneuptime)** — Recommended for production +- **[Docker Compose](/Docs/Content/installation/docker-compose.md)** — Single-node install (not recommended for production) +- **[Local Development](/Docs/Content/installation/local-development.md)** — For contributors +- **[Upgrade Guide](/Docs/Content/installation/upgrading.md)** — Upgrade existing installations + +--- + +## 💼 Community vs. Enterprise Editions + +| Edition | Ideal For | Highlights | +|---------|-----------|------------| +| **Community** | Self-hosters and small teams | Full feature set • Community support • Open-source | +| **Enterprise** | Regulated teams needing premium support | Hardened images • Priority support • Custom features • Data residency options | + +> 📧 For Enterprise licensing, contact `sales@oneuptime.com` + +--- + +## 🛠️ Installation + +```bash +# Quick start with Docker Compose +git clone https://github.com/OneUptime/oneuptime.git +cd oneuptime +docker compose up -d +``` + +For detailed installation guides, see: +- [Kubernetes with Helm](https://artifacthub.io/packages/helm/oneuptime/oneuptime) (recommended for production) +- [Docker Compose](/Docs/Content/installation/docker-compose.md) +- [Local Development](/Docs/Content/installation/local-development.md) +- [Upgrade Guide](/Docs/Content/installation/upgrading.md) + +--- + +## 💡 Philosophy + +Our mission is to **reduce downtime and increase the number of successful products in the world**. We built a platform that helps you understand the causes of downtime, manage incidents effectively, and reduce operational toil. + +OneUptime is 100% open-source, free, and available for everyone to use. + +--- + +## 🤝 Contributing + +We ❤️ contributions big and small! Here's how you can help: + +| Priority | How to Contribute | +|----------|-------------------| +| 🗣️ | Share feedback in our [Customer Slack](https://join.slack.com/t/oneuptimesupport/shared_invite/zt-2pz5p1uhe-Fpmc7bv5ZE5xRMe7qJnwmA) | +| 💬 | Chat with developers in our [Developer Slack](https://join.slack.com/t/oneuptimedev/shared_invite/zt-17r8o7gkz-nITGan_PS9JYJV6WMm_TsQ) | +| ✅ | [Write tests](https://github.com/OneUptime/oneuptime/issues?q=is%3Aopen+is%3Aissue+label%3A%22write+tests%22) for our codebase | +| 🔧 | Work on [open issues](https://github.com/OneUptime/oneuptime/issues) | +| 💡 | [Open new issues](https://github.com/OneUptime/oneuptime/issues/new) with feature requests | + +--- + +## 💖 Support OneUptime + +If you find OneUptime useful, consider supporting its development: + +- ⭐ **Star this repo** — It helps others discover OneUptime +- 💵 **[Sponsor us](https://github.com/sponsors/OneUptime)** — Every dollar goes to shipping new features +- 🛍️ **[Shop merch](https://shop.oneuptime.com)** — All revenue supports open-source development + +--- + +## 📄 License + +OneUptime is licensed under the [MIT License](LICENSE). + +--- + +

+ Made with ❤️ by the OneUptime team and contributors +