Skip to content

A secure, configurable file-sharing and URL shortening web app written in Rust.

License

Notifications You must be signed in to change notification settings

szabodanika/microbin

Repository files navigation

Screenshot

MicroBin

Build crates.io Docker Image Docker Pulls

MicroBin is a super tiny, feature-rich, configurable, self-contained and self-hosted paste bin web application. It is very easy to set up and use, and will only require a few megabytes of memory and disk storage. It takes only a couple minutes to set it up, why not give it a try now?

Check out the Public Test Server at pub.microbin.eu!

Or host MicroBin yourself

Run our quick docker setup script (DockerHub):

bash <(curl -s https://microbin.eu/docker.sh)

Or install it manually from Cargo:

cargo install microbin;
curl -L -O https://raw.githubusercontent.com/szabodanika/microbin/master/.env;
source .env;
microbin

On our website microbin.eu, you will find the following:

Features

  • Entirely self-contained executable, MicroBin is a single file!
  • Server-side and client-side encryption
  • File uploads (e.g. server.com/file/pig-dog-cat)
  • Raw text serving (e.g. server.com/raw/pig-dog-cat)
  • QR code support
  • URL shortening and redirection
  • Animal names instead of random numbers for upload identifiers (64 animals)
  • SQLite and JSON database support
  • Private and public, editable and uneditable, automatically and never expiring uploads
  • Automatic dark mode and custom styling support with very little CSS and only vanilla JS (see water.css)
  • And much more!

What is an upload?

In MicroBin, an upload can be:

  • A text that you want to paste from one machine to another, e.g. some code,
  • A file that you want to share, e.g. a video that is too large for Discord, a zip with a code project in it or an image,
  • A URL redirection.

When is MicroBin useful?

You can use MicroBin:

  • To send long texts to other people,
  • To send large files to other people,
  • To share secrets or sensitive documents securely,
  • As a URL shortener/redirect service,
  • To serve content on the web, eg . configuration files for testing, images, or any other file content using the Raw functionality,
  • To move files between your desktop and a server you access from the console,
  • As a "postbox" service where people can upload their files or texts, but they cannot see or remove what others sent you,
  • Or even to take quick notes.

...and many other things, why not get creative?

MicroBin and MicroBin.eu are available under the BSD 3-Clause License.

© Dániel Szabó 2022-2024