https://github.com/cityssm/uptime-feed

Push notifications, RSS and JSON application startup notifications, useful for informally notifying affected users of unexpected server restarts.
https://github.com/cityssm/uptime-feed

json ntfy push-notifications rss-feed uptime-monitor

Last synced: 7 months ago
JSON representation

Push notifications, RSS and JSON application startup notifications, useful for informally notifying affected users of unexpected server restarts.

• Host: GitHub
• URL: https://github.com/cityssm/uptime-feed
• Owner: cityssm
• License: mit
• Created: 2022-11-02T17:27:08.000Z (almost 3 years ago)
• Default Branch: main
• Last Pushed: 2023-01-09T20:41:33.000Z (almost 3 years ago)
• Last Synced: 2025-02-19T13:47:01.715Z (8 months ago)
• Topics: json, ntfy, push-notifications, rss-feed, uptime-monitor
• Language: TypeScript
• Homepage:
• Size: 365 KB
• Stars: 2
• Watchers: 1
• Forks: 0
• Open Issues: 1
• Metadata Files:
  • Readme: README.md
  • Contributing: CONTRIBUTING.md
  • License: LICENSE
  • Code of conduct: CODE_OF_CONDUCT.md

Awesome Lists containing this project

README

          
# Uptime Feed

## _Did the server restart?_

[![Codacy grade](https://img.shields.io/codacy/grade/c1e38f5d78b640d5b3e55d78c2b435ec)](https://app.codacy.com/gh/cityssm/uptime-feed/dashboard)

[![Code Climate maintainability](https://img.shields.io/codeclimate/maintainability/cityssm/uptime-feed)](https://codeclimate.com/github/cityssm/uptime-feed)

[![Snyk Vulnerabilities for GitHub Repo](https://img.shields.io/snyk/vulnerabilities/github/cityssm/uptime-feed)](https://app.snyk.io/org/cityssm/project/7d36a41a-ee6a-44fa-a374-a7631bda7308)

![Android Push Notification](docs/push.png)

![RSS Output](docs/rss.png)

![JSON Output](docs/json.png)

Push notifications (using [ntfy.sh](https://ntfy.sh/)), RSS and JSON application startup notifications, useful for informally notifying affected users of unexpected server restarts.

## Why?

Sometimes the application support team are the last ones to hear about unexpected server restarts.

It's not the fault of the busy systems administrators responding to the problem,

but finding out about server problems sooner helps everyone.

## What Does it Do?

This simple application runs on a server, preferably as a service that starts with the server.

It hosts an RSS Feed (and a JSON response, if that's your preference)

with the last time the application was started.

It also has the ability to send a push notification using the [ntfy](https://ntfy.sh/) notification service.

If the server restarts, the timestamp will change, resulting in a new notification.

If the feed is unavailable, either the application is down or the server is.

## Getting Started

**Download** a release or clone the repository.

**Install** the dependencies.

    npm install

Create a `data/config.js` file.

    cp data/configSample.js data/config.js

**Run** the application.

    npm start

Alternatively, the application can be set up as a Windows service.

    npm link node-windows

    windowsService-install.bat

**Subscribe** to the RSS feed or read the JSON file.

_Note that the server port is configurable,_

and there is an option to customize the URLs (helpful when proxying).

    http://serverName:9111/rss

    http://serverName:9111/json

**Install** the appropriate [ntfy app on your phone](https://ntfy.sh/docs/subscribe/phone/),

and subscribe to the push notification topic set up in the config file.