Open Source Ecosystems

✨ Features

🔍 Service Monitoring: Checks response codes of URLs at configurable intervals with a configurable data retention time/history.
📊 Charts: Response times are recorded and displayed on charts.
🚨 Incident Management: Supports incidents of type 'incident' or 'maintenance' with a description and a list of affected services.
👤 User Roles: Admins have full access to the settings, while Managers can only manage incidents.
🌓 Dark/Light Mode: The status page supports both dark and light modes.

This project uses 🐰 BunJS, 🚀 Astro, ⚛️ React, 🎨 Tailwind, and 🧰 ShadcnUI.

🚀 Installation and Setup

📜 Using the Setup Script (Recommended)

[!IMPORTANT] It is required to use a bash shell when using the setup script. I'm currently working on a cross platform alternative using bun shell.

The setup script includes an update checker and provides functionality for installing, upgrading, starting, stopping, and viewing the application's logs.

📥 Download the Latest Stable Release:
- This command will download and open the setup menu, choosing install will also run the BunJS install script.
```
curl -O https://raw.githubusercontent.com/tommy141x/os-status-page/main/scripts/setup.sh && chmod +x setup.sh && ./setup.sh
```
⚙️ Configure Settings in (os-status-page):
- Rename config.example.yml to config.yml.
- Change the secret to a secure value for storing session cookies.
- Edit other configuration settings via the web UI.
🏁 Start with the Setup Script (../setup.sh) & Access the Status Page
- Default port is 3000.
- For Docker users, check docker-compose.yml for port configuration.

🐰 Using BunJS (Without the Setup Script)

📦 Install BunJS:

🐧 Linux & 🍎 Mac:

curl -fsSL https://bun.sh/install | bash

🪟 Windows:

powershell -c "irm bun.sh/install.ps1 | iex"

📥 Clone the Repository:
```
git clone https://github.com/tommy141x/os-status-page.git
```
📝 Note: Make sure to cd into the cloned repository directory:
```
cd os-status-page
```
📦 Install Dependencies:
```
bun install
```
⚙️ Configure Your Settings:
- Rename config.example.yml to config.yml.
- Change the secret to a secure value for storing session cookies.
- Edit other configuration settings via the web UI.
🏁 Start the Application:
- Run:
```
bun start
```
- Alternatively, if using Docker:
```
docker compose up
```
- Access the status page at port 3000 by default or the port specified in docker-compose.yml.

💡 Motivation

I created this project because I couldn't find a lightweight status page that was super simple and easy to set up. Additionally, I wanted to try out BunJS and React, as I've never made a full React project before, and I've never used Tailwind.

🤝 Contributing

Contributions to this project are encouraged and appreciated. Please feel free to submit pull requests or open issues if you encounter any problems or have suggestions for improvements.