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 service with minimal resource requirements. Average memory consumption is under 20MiB and single CPU core consumption under 20%.

Performance: Avg 3K reqs/sec, latency 56ms (100K requests using 100 connections, benchmark).

Self-hosted with Dokku and Docker Compose.

Images available on Docker Hub.

Why bit?

It is feature-complete by design. Its strength lies in simplicity, 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.
  • Flexible request forwarding system passes client context to destinations via standard X-Forwarded-For and User-Agent headers, enabling advanced tracking and integration capabilities when needed.
  • Multiple users are supported via API key authentication. Create, list and delete via the CLI.

Minimum Requirements

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

Documentation

Contributing

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