|
2 | 2 | [](https://hub.docker.com/r/sjdonado/bit)
|
3 | 3 | [](https://hub.docker.com/r/sjdonado/bit)
|
4 | 4 |
|
5 |
| -Lightweight URL shortener API service with minimal resource requirements. Average memory consumption is under **30MiB** and single CPU core consumption around 30%. |
6 |
| - |
7 |
| -Performance: Avg **1K reqs/sec**, latency 30ms, [benchmark](docs/SETUP.md#benchmark). |
| 5 | +Lightweight URL shortener (API-only) with minimal resource requirements. Avg memory consumption under pressure is **60MiB**, single CPU core consumption around 30% (1K reqs/sec, latency 30ms, [benchmark](docs/SETUP.md#benchmark)). |
8 | 6 |
|
9 | 7 | Self-hosted with [Dokku](docs/SETUP.md#dokku) and [Docker Compose](docs/SETUP.md#docker-compose).
|
10 | 8 |
|
11 | 9 | Images available on [Docker Hub](https://hub.docker.com/r/sjdonado/bit/tags).
|
12 | 10 |
|
13 | 11 | ## Why bit?
|
14 |
| -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. |
| 12 | +It is feature-complete by design: simple and reliable without unnecessary bloat. Bug fixes will continue, but new features aren't planned. |
15 | 13 |
|
16 |
| -- 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. |
17 |
| -- Standard `X-Forwarded-For` headers pass client context, enabling tracking and integration capabilities. |
18 |
| -- Multiple users are supported via API key authentication. Create, list and delete via the [CLI](docs/SETUP.md#cli). |
| 14 | +- 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. |
| 15 | +- Provides standard `X-Forwarded-For` header support to enable extended capabilities. |
| 16 | +- Multiple users are supported via API key authentication. Users can create, list and delete keys via the [CLI](docs/SETUP.md#cli). |
19 | 17 |
|
20 | 18 | ## Minimum Requirements
|
21 | 19 | - 100MB disk space
|
|
0 commit comments