itty-bitty/README.md
2025-10-03 01:33:13 +02:00

1.2 KiB
Raw Blame History

itty.bitty

itty.bitty takes html (or other data), compresses it into a URL fragment, and provides a link that can be shared. When it is opened, it inflates that data on the receivers side.

Learn more at: about.bitty.site

How it works: how.bitty.site

For more info: wiki.bitty.site

Self-hosting

Local runtime prerequisites

  • Node.js 20 or newer
  • npm 9 or newer

Run locally

  1. Install dependencies with npm install.
  2. Start the server with npm run dev.
  3. Visit http://localhost:8080.

Optional environment variables:

  • PORT: server port (defaults to 8080).
  • UA_ARRAY: comma separated list of User-Agents to block with HTTP 401.
  • REQUEST_LOG: set to silent to disable HTTP request logging.

Docker workflow

  1. Build the image locally: docker build -t itty-bitty ..
  2. Run the container: docker run --rm -d -p 8080:8080 --name itty-bitty itty-bitty.
  3. Open http://localhost:8080/ in your browser.
  4. Stop it with docker rm -f itty-bitty (or let --rm clean up if you stop the container normally).

Docker Compose

docker compose up --build -d

Stop the stack with docker compose down when you are done.