README.md 1.28 KB
Newer Older
1
# EduGAIN Connectivity Check Service 2
Marco Malavolti's avatar
Marco Malavolti committed
2

3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
# Requirements Hardware

* OS: Debian 9,10 (tested)
* HDD: 10 GB
* RAM: 4 GB
* CPU: >= 2 vCPU

# Requirements Software

* Apache Server + WSGI
* Python 3.8
* Selenim + Chromium Web Brower

# HOWTO Install and Configure

* `sudo apt install chromium chromium-l10n git jq`
Marco Malavolti's avatar
Marco Malavolti committed
19
20
* `python3 -m pip install --user --upgrade pip virtualenv`
* `python3 -m venv eccs2venv`
21
* `source eccs2venv/bin/activate`   (`deactivate` to exit Virtualenv)
Marco Malavolti's avatar
Marco Malavolti committed
22
23
  * `python3 -m pip install --upgrade wheel setuptools certifi selenium urllib3 flask flask-jsonpify flask-restful`
  * `cd ~ ; git clone https://github.com/malavolti/eccs2.git`
24
25
26
  * `cd eccs2`
  * `cp eccs2properties.py.template eccs2properties.py` (and change it with your needs)
  * `./runEccs2.py`
Marco Malavolti's avatar
Marco Malavolti committed
27

28
29
30
31
32
33
# API Development Server

* `sudo apt install libapache2-mod-wsgi-py3 python3-dev`
* `sudo a2enmod wsgi`
* `cd ~/eccs2 ; ./api.py`

34
35
36
# API

* `/eccs/test` (Trivial Test)
Marco Malavolti's avatar
Marco Malavolti committed
37
* `/eccs/checks` (Return the results of the last checks)
38
39
40
41
42
43
44
45
46
* `/eccs/checks?<parameter>=<value>`:
  * `date=2020-02-20` (select date)
  * `idp=Any%20words%20do%20you%20like%20url%20encoded`
  * `status=`
    * 'OK'
    * 'TIMEOUT'
    * 'No-eduGAIN-Metadata'
    * 'Form-Invalid'
    * 'Excluded'
Marco Malavolti's avatar
Marco Malavolti committed
47
* /eccs/eccsresults (Return the results of the last check ready for ECCS Gui)
48
49