mirror of https://github.com/szabodanika/microbin synced 2024-11-10 03:34:17 +00:00

No description

Find a file

Daniel Szabo a4ab03322c update sqlite directory and gitignore - Missed one place where the data directory changes in commit `668b460` - Updated gitignore to reflect new default data directory path		2023-07-08 22:42:02 +03:00
.github	Update release.yml	2023-07-01 22:36:39 +03:00
src	update sqlite directory and gitignore	2023-07-08 22:42:02 +03:00
templates	Fixed pasta creation bug	2023-07-08 21:54:13 +03:00
.env	Update .env	2023-07-08 15:44:02 +03:00
.gitignore	update sqlite directory and gitignore	2023-07-08 22:42:02 +03:00
Cargo.lock	Bump versioning for new beta release	2023-07-08 19:18:58 +03:00
Cargo.toml	Bump versioning for new beta release	2023-07-08 19:18:58 +03:00
compose.yaml	Added option to change data directory	2023-07-08 22:26:26 +03:00
docker-setup.sh	Docker setup script	2023-07-02 13:04:28 +03:00
Dockerfile	Update Dockerfile	2023-07-01 23:18:06 +03:00
LICENSE	Create LICENSE	2022-04-27 16:00:53 +01:00
README.md	Update README.md	2023-07-02 23:59:32 +03:00
render.yaml	Update render.yaml	2022-06-04 23:30:39 +01:00
SECURITY.md	Getting ready for 1.2.0 release: many smaller requests implemented	2022-10-29 14:11:55 +03:00

README.md

MicroBin

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

Is very small
Entirely self-contained executable, MicroBin is a single file!
Animal names instead of random numbers for pasta identifiers (64 animals)
Server-side and client-side encryption
File uploads (eg. server.com/file/pig-dog-cat)
Raw text serving (eg. server.com/raw/pig-dog-cat)
URL shortening and redirection
QR code support
Very simple database (JSON + files) for portability, easy backups and integration
SQLite support
Private and public, editable and final, automatically and never expiring uploads
Syntax highlighting
Automatic dark mode and custom styling support with very little CSS and only vanilla JS (see water.css)
Most of the above can be toggled on and off!

What is an upload?

In MicroBin, an upload can be:

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

When is MicroBin useful?

You can use MicroBin:

As a URL shortener/redirect service,
To send long texts to other people,
To send large files to other people,
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 - just disable the upload page
To take notes! Simply create an editable upload.

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

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