Skip to content

Try it locally

Requirements

  • Python 3.12 or newer, and uv.
  • SQLite, which Python includes, is enough to try it. Production uses PostgreSQL 14 or newer.
  • Network access to download.db-ip.com, for DB-IP's free country and network databases. No account is needed. Without them, visits simply have no country or network.

Three commands

git clone https://github.com/abilian/abilian-analytics.git
cd abilian-analytics
make develop     # installs dependencies and the pre-commit hooks
make seed-db     # creates data/db.sqlite3, an admin and a "Demo" project
make run         # http://localhost:5000

The seed script creates the account admin@example.com with the password admin123, and a project claiming localhost. Sign in, open http://localhost:5000/demo/ in another tab, click around, and the visits appear in the Demo project.

The demo page exists in development mode only (DEBUG=true, which make run sets). Use the seed script on development databases only: its credentials are public.

To see countries and networks, download the GeoIP databases: uv run abilian-analytics geoip update.

Next

  • Deploy it for your own sites.
  • Read the guide, starting with projects and hostnames.