openstatus
openstatus copied to clipboard
π The open-source synthetic & real user monitoring platform π
OpenStatus
The Open-Source performance monitoring platform.
Learn more Β»
Discord
Β·
Website
Β·
Issues
Β·
Roadmap
About OpenStatus π
OpenStatus is open-source performance monitoring platform.
- Synthetic monitoring: Monitor your website and APIs worldwide and receive notifications when they are down or slow.
- Real User Monitoring: Understand how your users are experiencing your website with core web vitals metrics.
Recognitions π
Contact us π
If you are interested in our enterprise plan or need special features, please
email us at [email protected] or book a
call
Roadmap πΊοΈ
Here's our roadmap feel free to contribute to it.
Contributing π€
If you want to help us building the best status page and alerting system, you can check our contributing guidelines
Top Contributors
Made with Contrib.rocks
Stats
Built with π οΈ
Getting Started π
Requirements
Setup
-
Clone the repository
git clone https://github.com/openstatushq/openstatus.git
-
Install dependencies
pnpm install
-
Set up your .env file
From
apps/web
andpackages/db
, you will find .env.example. Create your own copy. -
Follow the steps to run your sqlite database locally inside of README.md
-
Start the development with the below command
pnpm dev
It will:
- run the web app on port
3000
- run the api server on port
3001
- run the docs on port
3002
- run the web app on port
-
See the results:
- open http://localhost:3000 for the web app
- open http://localhost:3001/ping for the api server health check
- open http://localhost:3002 for the docs
Tunnelmole, an open source tunnelling tool or ngrok, a popular closed source tunnelling tool.
Using Tunnelmole
- Install Tunnelmole with
curl -O https://install.tunnelmole.com/384HK/install && sudo bash install
. (On Windows, download tmole.exe) - Run
tmole 3000
. In the output, you'll see two URLs, one HTTP, and an HTTPS URL. It's best to use the HTTPS URL for privacy and security.
β ~ tmole 3000
http://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
https://bvdo5f-ip-49-183-170-144.tunnelmole.net is forwarding to localhost:3000
Videos
Videos to better understand the OpenStatus codebase: