Updated README

This commit is contained in:
Filip Znachor 2023-11-01 21:59:15 +01:00
parent 0edb205ad2
commit 2fdb1cbd92

View file

@ -2,4 +2,60 @@
# Uptime Status
Alternative public status page for **[Uptime Kuma](https://uptime.kuma.pet/)**.
Modern and simple alternative public status page for **[Uptime Kuma](https://uptime.kuma.pet/)**.
## Overview
Uptime Status is your go-to solution for creating a stylish, lightning-fast, and straightforward public status page, designed to seamlessly complement Uptime Kuma. This status page offers a range of features, including:
- **Modern and Fast**: A sleek, up-to-date design that loads quickly for users.
- **Simple Configuration**: Easily customizable right from within Uptime Kuma's interface.
- **Global Status at a Glance**: Instantly view the overall status of all your services in the page header.
- **Grouping and Monitoring**: Organize your services into groups and closely monitor their performance.
- **Heartbeats and More**: Utilize various Uptime Kuma features to ensure comprehensive monitoring.
- **No JavaScript Required**: A JavaScript-free experience for a wider audience.
## How it works
Uptime Status fetches data from Uptime Kuma's public status page API. This way, you can share your status pages while keeping your Uptime Kuma instance instance secure within your private network.
## Requirements
To get Uptime Status up and running, you'll need the following:
- **Web Server**: Any web server will do (e.g., Apache2, Nginx, etc.).
- **PHP**: Version 7.4 or higher.
- **Composer**: This is essential for installing dependencies.
## Installation
Setting up Uptime Status is straightforward. Follow these steps to get started:
1. **Clone the Repository**:
```sh
git clone https://github.com/FZnachor/Uptime-Status
cd Uptime-Status
```
2. **Install Dependencies**:
Use Composer to install all the necessary dependencies, whether you're on your server or local device.
```sh
composer install
```
3. **Copy the Files to Your Web Server**:
Ensure that your web server's virtual host document root is configured to point to the application's `public` directory.
4. **Edit the Configuration File**:
Don't forget to edit the `config.inc.php` file and set your Uptime Kuma's URL and status page.
Once you've completed these steps, you're all set to start using Uptime Status.
## Development
If you're interested in developing Uptime Status or testing it on your local device, make sure you have PHP installed, and run the `./dev.sh` script to set up a local PHP server.