Skip to content
/ bit Public

Fast, lightweight, production-ready, URL shortener powered by SQLite and Crystal

License

Notifications You must be signed in to change notification settings

sjdonado/bit

Repository files navigation

Docker Pulls Docker Stars Docker Image Size

Lightweight URL shortener (API-only) with minimal resource requirements. Avg memory consumption 30MiB, avg CPU load 20%.

Highly performant: 7.9k req/sec, latency 15.8ms (100k requests using 125 connections, benchmark).

Self-hosted: Dokku, Docker Compose.

Images available on Docker Hub.

Why bit?

It is feature-complete by design: simple and reliable without unnecessary bloat. Bug fixes will continue, but new features aren't planned.

  • Minimal tracking setup: Country, browser, OS, referer. No cookies or persistent tracking mechanisms are used beyond what's available from a basic client's request.
  • Includes X-Forwarded-For header.
  • Multiple users are supported via API key authentication. Users can create, list and delete keys via the CLI.
  • Easy to extend, Ruby on Rails-inspired setup.

Recommented requirements

  • 100MB disk space
  • 70MiB RAM
  • x86_64 or ARM64

Documentation

Contributing

Found an issue or have a suggestion? Please follow our contribution guidelines.