2020-12-08 10:09:21 +01:00
|
|
|
# OVH-server-tracker
|
|
|
|
|
|
2021-05-03 11:20:47 +02:00
|
|
|
An OVH server tracker for Kimsufi and So You Start.
|
2020-12-09 20:03:13 +01:00
|
|
|
|
|
|
|
|
## Purpose
|
|
|
|
|
|
|
|
|
|
The objective is to **send notifications** when the Kimsufi server you want is available in the zone(s) desired.
|
|
|
|
|
There is many type of notification listed here : https://github.com/caronc/apprise
|
|
|
|
|
Actualy only email, xmpp are supported here. Easy to integrate other (see `src/notifications.py`)
|
|
|
|
|
Discord and Matrix are planned.
|
|
|
|
|
|
2021-05-03 11:20:47 +02:00
|
|
|
This project is [inspired by Pofilo](https://git.pofilo.fr/pofilo/kimsufi).
|
|
|
|
|
|
2020-12-09 20:03:13 +01:00
|
|
|
## Documentation
|
|
|
|
|
|
|
|
|
|
### References and zones
|
|
|
|
|
|
2021-05-02 17:56:31 +02:00
|
|
|
In `config/`, you can find [the list of references](https://git.dryusdan.fr/Dryusdan/OVH-server-tracker/src/branch/stable/config/refToName.yml)
|
2020-12-09 20:03:13 +01:00
|
|
|
Zone are fra, gra, rbx, sbg for Kimsufi
|
|
|
|
|
|
|
|
|
|
## Installation
|
|
|
|
|
|
2021-03-03 20:48:02 +01:00
|
|
|
+ `git clone https://git.dryusdan.fr/Dryusdan/OVH-server-tracker.git`
|
2021-05-02 18:39:51 +02:00
|
|
|
+ `cd /OVH-server-tracker`
|
2020-12-09 20:03:13 +01:00
|
|
|
+ Create virtual environment: `python3 -m venv .`
|
|
|
|
|
+ Source it: `source bin/activate`
|
|
|
|
|
+ Install dependencies: `pip install -r requirements.txt`
|
|
|
|
|
+ `cp config/kimsufi.sample.yml config/kimsufi.yml`
|
|
|
|
|
+ Edit *config/kimsufi.yml*
|
2020-12-09 20:03:42 +01:00
|
|
|
+ `python3 servertracker.py`
|
