CodeSpace/Uptime-Status
CodeSpace/Uptime-Status
2
0
Fork 0
Code Issues Pull requests Packages Projects Releases Wiki Activity

Updated README

Browse source
This commit is contained in:
Filip Znachor 2024-03-02 14:11:09 +01:00
parent 22483c86ea
commit 056e9952af
1 changed files with 13 additions and 10 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

23
README.md
View file

@ -13,11 +13,12 @@ Uptime Status is your go-to solution for creating a stylish, lightning-fast, and
- **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.
- **Multiple Backends and Failovers**: Uptime Status provides a way to setup multiple Uptime Kuma backends with automatic failover.
- **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.
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 secure within your private network.
## Requirements
@ -31,31 +32,33 @@ To get Uptime Status up and running, you'll need the following:
Setting up Uptime Status is straightforward. Follow these steps to get started:
1. **Clone the Repository**:
1. **Install Dependencies**:
Use Composer to install Uptime Status and all the necessary dependencies, whether you're on your server or local device.
```sh
git clone https://github.com/FZnachor/Uptime-Status
cd Uptime-Status
composer require codespace/uptime-status
```
2. **Install Dependencies**:
2. **Retrieve project's files**:
Use Composer to install all the necessary dependencies, whether you're on your server or local device.
Copy the `public` directory from `vendor/codespace/uptime-status` to the directory where you ran the `composer` command. You can also copy the `config.inc.php` template configuration file there.
```sh
composer install
cp -r vendor/codespace/uptime-status/public .
cp vendor/codespace/uptime-status/config.inc.php .
```
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.
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 `composer run dev` to set up a local PHP server.
If you're interested in developing Uptime Status or testing it on your local device, make sure you have [PHP](https://php.net) and [Composer](https://getcomposer.org/) installed. Finally, you can simply clone this repository and run `composer run dev` to spin up a local PHP dev server.