https://github.com/manjaro/mdd
Manjaro Data Donor - WIP
https://github.com/manjaro/mdd
Last synced: 11 days ago
JSON representation
Manjaro Data Donor - WIP
- Host: GitHub
- URL: https://github.com/manjaro/mdd
- Owner: manjaro
- License: mit
- Created: 2024-10-31T12:48:30.000Z (6 months ago)
- Default Branch: master
- Last Pushed: 2024-11-08T20:26:11.000Z (6 months ago)
- Last Synced: 2025-03-31T23:51:07.295Z (about 1 month ago)
- Language: Python
- Homepage:
- Size: 37.1 KB
- Stars: 12
- Watchers: 2
- Forks: 2
- Open Issues: 8
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# Manjaro Data Donor
MDD provides us with a secure way to receive anonymized data about the usage of Manjaro.
This way we can learn how Manjaro is used by our users and we can focus our efforts on what matters most in order to improve the user experience.
**The data is anonym in two ways:**
- We only collect impersonal information about the hardware and the environment. In particular **we don't store IP addresses**.
- To differentiate systems we need a unique identifer. For that we use [`/etc/machine-id`](https://www.freedesktop.org/software/systemd/man/latest/machine-id.html), what is hashed before being sent.
The data is being stored in a database on one of our Hetzner servers. Visualizations of the data are made available via Grafana [here](https://metrics.manjaro.org/public-dashboards/cb0f690cba304389bf3ed2c254c14c01). We plan on adding more charts for interesting data later on.
## Setup Instructions
1. **Install package dependencies**:
```bash
sudo pacman -S git python-pip inxi
```
2. **Clone this repo** to your computer and navigate to the project directory:
```bash
git clone https://github.com/manjaro/mdd
cd mdd
```
3. **Create a virtual environment** (recommended) to manage dependencies:
```bash
python -m venv venv
source venv/bin/activate
```
4. **Install the dependencies** listed in `requirements.txt`:
```bash
pip install -r requirements.txt
```
5. **Run the script**:
```bash
python mdd.py
```
6. **Deactivate the virtual environment** when done:
```bash
deactivate
```
## Usage
### Dry Run
Run the script without any arguments to send data directly. The submitted data will be displayed on the terminal.
Additionally you can first run
```bash
python mdd.py --dry-run
```
in order to only display the data that would be sent without actually doing so.
### Telemetry
If you only want to count the device but not provide any data about your system, then run:
```bash
python mdd.py --disable-telemetry
```
If possible please provide all information though. It helps us with learning about what our users need. And the graphs look cool!
### Debugging
The log level can be increased from `WARNING` to `INFO`/`DEBUG` with:
```bash
python mdd.py --log INFO
```
By default MDD tries to use [inxi](https://smxi.org/docs/inxi.htm) for gathering information about the system. For debugging this can be deactivated:
```bash
MDD_DISABLE_INXI=1 python mdd.py
```