Warning: This is under heavy development, and is not ready for use.
Gathers anonymous usage statistics of IPOP users.
We need these statistics to justify our funding in grant proposals. They're opt-in only, and the only information we collect is:
- Your IP address
- A randomly generated UUID
- Client version number
- The number of connections your node makes
- If STUN or TURN is being used
- The name of the controller (groupvpn or socialvpn)
- Statistics about average connection lifetime
We'll never publish full database dumps, but we will publish general statistical information from our database.
The API still needs to be finalized and documented. For now, read the source to see how the API works.
We follow the JSend specification for successes and failures.
sudo aptitude install python-pip
sudo pip3 install virtualenv
virtualenv -p python .env
.env/bin/pip install -e .
.env/bin/ipop-statsYou should be able to play with the API via curl.
We follow PEP 8 with a few exceptions:
- Lines are 80 characters long (not 79). This includes docstrings and comments.
- Explicit line continuation is often preferred over implicit, when it saves us from deeply nesting parenthesis
It's possible for someone to write a client that abuses the API, spamming it with artificially inflated statistics. We record IPs so we could perform some analysis later to filter out these results, but heavily NATed environments could complicate this.
Generally, we assume nobody will spam us with API calls, as there's no motivation for an attacker to do so.
Upon setting up a production system, we should use some sort of rate-limiting, to avoid being DoSed. The configuration file allows limiting based on UUID, IPv4, and IPv6 addresses. This can be paired with nginx's rate limiting module.
Please don't be evil!