Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/janyksteenbeek/uppi
Uppi: A self-hosted robust uptime monitoring solution built with Laravel
https://github.com/janyksteenbeek/uppi
Last synced: 15 days ago
JSON representation
Uppi: A self-hosted robust uptime monitoring solution built with Laravel
- Host: GitHub
- URL: https://github.com/janyksteenbeek/uppi
- Owner: janyksteenbeek
- License: other
- Created: 2024-12-11T15:17:07.000Z (2 months ago)
- Default Branch: main
- Last Pushed: 2025-01-25T14:14:16.000Z (27 days ago)
- Last Synced: 2025-01-25T15:18:25.534Z (27 days ago)
- Language: PHP
- Homepage: https://uppi.dev
- Size: 2.33 MB
- Stars: 21
- Watchers: 1
- Forks: 3
- Open Issues: 1
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Uppi
[](https://github.com/janyksteenbeek/uppi/releases)
[](LICENSE)
[](https://github.com/janyksteenbeek/uppi/issues)
A robust uptime monitoring solution built with Laravel, designed to track the availability of your web services and
notify you when issues arise.
## Features
- **Real-time Monitoring**: Continuously monitor the status of your web services
- **Smart Alerting**: Get notified when services go down and when they recover
- **Dashboard Overview**: Visual representation of your monitors' status
- **Anomaly Detection**: Track and manage service disruptions
- **Flexible Notifications**: Multiple notification channels for alerts
- **Public Status Pages**: Share your service status with your users, or embed it in your website
## Installation
1. Clone the repository:
```bash
git clone https://github.com/janyksteenbeek/uppi.git
cd uppi
```
2. Install dependencies:
```bash
composer install
```
3. Set up your environment:
```bash
cp .env.example .env
php artisan key:generate
```
4. Configure your database in `.env` and run migrations:
```bash
php artisan migrate
```
5. Build the assets
```bash
npm install
npm run build
```
6. Run the Scheduler every minute in a cron
```bash
php artisan schedule:run
```
7. Start the queue worker:
```bash
php artisan queue:work
```
## Usage
1. Access the dashboard at the URL you configured
2. Add monitors for the services you want to track
3. Configure alerts and notification preferences
4. Monitor your services through the dashboard
## Supervisor configuration
```cnf
[program:uppi]
command=php artisan queue:work --queue=default
autostart=true
autorestart=true
user=www-data
directory=/var/www/uppi
numprocs=10
redirect_stderr=true
stdout_logfile=/var/log/uppi.log
```
```bash
sudo supervisorctl reread
sudo supervisorctl update
sudo supervisorctl start uppi
```
## Mobile companion app
The mobile app is available for Android and iOS and built with React Native. You can find the source code
at [janyksteenbeek/uppi-app](https://github.com/janyksteenbeek/uppi-app)
## License
Uppi is released under the Creative Commons Attribution-NonCommercial 4.0 International license. See
the [LICENSE](LICENSE). A human friendly summary is available
at [creativecommons.org](https://creativecommons.org/licenses/by-nc/4.0/). An addendum regarding clarification of
non-commercial use is available at [NON-COMMERCIAL.md](NON-COMMERCIAL.md).
Dependencies may be subject to their own licenses.
## Security
If you discover any security-related issues, please email [[email protected]](mailto:[email protected]) instead of using the
issue tracker. All security vulnerabilities will be promptly addressed.