Skip to content

jgrunder/kimsufi-alert

Repository files navigation

Kimsufi Alert

This NodeJS project allows you to regularly monitor the availability of Kimsufi servers and send you a notification as soon as a monitored server is available. If one of the monitored servers is available, you receive a notification with the url to pre-purchase this server and it is immediately removed from the list of monitored servers; the application continues to monitor availabilities until there are no more servers to monitor.

Scope

You can currently receive notifications with the following systems:

Getting Started

  1. Clone this project in any folder, then:
  2. Install the project:
cd kimsufi-alert
cp config.json.exemple config.json
cp servers.update.json servers.json
npm install
  1. Update the file config.json with your settings
  2. Update the file servers.json by setting the servers you want to monitor to true
  3. Specify which servers you want to monitor by editing the servers.json file.
  4. Start the service:
node service.js

Kimsufi Alert as a service (Linux)

This application comes with two configuration files to make Kimsufi Alert a service under Linux. To do so, you must place the two files below in your system and change the path to the Kimsufi Alert application.

  • File kimsufi-alert.service must be moved to your /etc/systemd/system folder (this is for Debian dist, you can easily find any equivalent for your dist)
  • (Optional) File kimsufialert.conf must be moved to your /etc/rsyslog.d only if you want to separate Kimsufi Alert application logs from system logs (the log file must exists and be writable by the system agent, you can use chown :adm)
  • In both files, replace the /PATH/TO to the absolute path to the application and to the log file
systemctl enable kimsufi-alert
systemctl restart rsyslog
systemctl start kimsufi-alert

Gmail configuration

To use the service with email via Gmail (you must have a valid Gmail account and email address), we recommend that you create a Google application password so that you don't have to write your Google password in plaintext in the configuration file. Regardless of this security issue, you're required to use Google application password if you've enabled dual authentication on your Google Account.

To do this :

  1. Manage your Google account
  2. Go to security
  3. Add an application password
  4. More information about Google Application Password

Then in this application configuration file, you can specify your email address and then the application password.

Pushover configuration

This is a paid service (5$ one time for each device where to receive notifications) but you can test it for free during 7 days:

  1. Go to Pushover website and create an account. You'll receive your user key by email, keep it!
  2. In Apps and plugins, create a new application (i.e. kimsufi-alert)
  3. Save the app key in this config file

About

Kimsufi availability notifications service for NodeJS, updated MAY 2020

Resources

License

Stars

Watchers

Forks

Releases

No releases published

Packages

No packages published