https://github.com/accudio/aurorawatch-ntfy

An unofficial and simple way of getting AuroraWatch UK notifications on devices via ntfy
https://github.com/accudio/aurorawatch-ntfy

Last synced: 2 days ago
JSON representation

An unofficial and simple way of getting AuroraWatch UK notifications on devices via ntfy

• Host: GitHub
• URL: https://github.com/accudio/aurorawatch-ntfy
• Owner: Accudio
• Created: 2024-10-15T21:44:18.000Z (about 1 month ago)
• Default Branch: main
• Last Pushed: 2024-10-16T09:26:39.000Z (about 1 month ago)
• Last Synced: 2024-10-18T10:25:41.772Z (about 1 month ago)
• Language: PHP
• Size: 76.2 KB
• Stars: 0
• Watchers: 1
• Forks: 0
• Open Issues: 0
• Metadata Files:
  • Readme: README.md

Awesome Lists containing this project

README

        
# AuroraWatch UK ntfy notification bridge

An unofficial and simple way of getting [AuroraWatch UK](https://aurorawatch.lancs.ac.uk) notifications on devices via ntfy.

Uses the [AuroraWatch UK API](https://aurorawatch.lancs.ac.uk/api-info/) to check aurora status and [ntfy](https://ntfy.sh) for delivering notifications.

## Usage

First, install the ntfy app on your chosen device:

- [Google Play Store (Android)](https://play.google.com/store/apps/details?id=io.heckel.ntfy&pli=1)

- [Apple app store (iOS)](https://apps.apple.com/us/app/ntfy/id1625396347)

- [Progressive Web App (Windows, macOS, linux, other)](https://ntfy.sh/app)

- [F-Droid (Android)](https://f-droid.org/en/packages/io.heckel.ntfy/)

Then, subscribe to the [aurorawatch](https://ntfy.sh/aurorawatch) topic on the default ntfy.sh server.

## Development

The project is a simple PHP script in `cron.php`.

Set up environment variables by copying `env.php.sample` to `env.php`. It's set up for live details by default but can be changed to test details via commenting.

Run it via the command line or on a cron job with `php cron.php`. It uses composer for dependencies but includes them in the repo so there should be no need for installation.

`state.json` is used to store the previous state of the script to avoid duplicate alerts and to track the cooldown of alerts and alert escalation.

Notification behaviour and content is designed to mirror the 'official' AuroraWatch UK apps as closely as possible.

## Credit

Built by Alistair Shepherd. Relies on AuroraWatch UK and ntfy projects heavily.

This project does not have an open-source license, so is not licensed for re-use. However the code is publicly accessible so feel free to use it as inspiration.