Skip to content

quick-start.md

Latest commit

 

History

History
98 lines (74 loc) · 2.46 KB

quick-start.md

File metadata and controls

98 lines (74 loc) · 2.46 KB
Raw

Quick Start

Audience: Users
Scope: Installation and first run

What is Allium?

Allium generates static HTML websites showing Tor relay statistics:

  • AROI leaderboards ranking authenticated operators (18 categories)
  • Network health dashboard
  • Individual pages for ~7,000 relays
  • Geographic and platform analysis

Installation

One-Command (Recommended)

curl -sSL https://raw.githubusercontent.com/1aeo/allium/master/setup.sh | bash

Manual

git clone https://github.com/1aeo/allium.git
cd allium
pip3 install -r config/requirements.txt
cd allium
python3 allium.py --progress

First Run

cd allium
python3 allium.py --progress

Generation takes 2-5 minutes. Output goes to www/.

View Locally

cd www
python3 -m http.server 8000
# Open http://localhost:8000

Output Structure

www/
├── index.html                      # AROI leaderboards (main page)
├── top500.html                     # Top 500 relays by consensus weight
├── network-health.html             # Network health dashboard
├── search-index.json               # Search data
├── misc/
│   ├── all.html                    # All relays
│   ├── aroi-leaderboards.html      # AROI leaderboards
│   ├── authorities.html            # Directory authorities
│   └── ...                         # Sorted listings
├── relay/<fingerprint>/index.html  # Individual relay pages
├── contact/<hash>/index.html       # Operator pages
├── country/<code>/index.html       # Country pages
└── static/                         # CSS, images, flags

Common Options

# Show progress
python3 allium.py --progress

# Custom output directory
python3 allium.py --out /var/www/tor-metrics

# Low memory mode (~400MB instead of ~2.4GB)
python3 allium.py --apis details

# All options
python3 allium.py --help

Quick Troubleshooting

Error Solution
"Jinja2 not found" pip3 install -r config/requirements.txt
"Permission denied" python3 allium.py --out ~/allium-output
"No module named 'lib'" Run from allium/ directory: cd allium
Out of memory python3 allium.py --apis details

Next Steps