2022-04-11 13:41:28 +00:00
2022-11-07 15:57:50 +00:00
![Screenshot ](.github/index.png )
2022-04-11 13:41:28 +00:00
2022-11-07 15:59:47 +00:00
# MicroBin
2022-06-04 23:20:23 +00:00
![Build ](https://github.com/szabodanika/microbin/actions/workflows/rust.yml/badge.svg )
![crates.io ](https://img.shields.io/crates/v/microbin.svg )
2022-09-26 12:10:01 +00:00
[![Docker Image ](https://github.com/szabodanika/microbin/actions/workflows/docker.yml/badge.svg )](https://hub.docker.com/r/danielszabo99/microbin)
2022-11-14 19:24:08 +00:00
[![Docker Pulls ](https://img.shields.io/docker/pulls/danielszabo99/microbin?label=Docker%20pulls )](https://img.shields.io/docker/pulls/danielszabo99/microbin?label=Docker%20pulls)
[![Support Server ](https://img.shields.io/discord/662017309162078267.svg?color=7289da&label=Discord&logo=discord&style=flat-square )](https://discord.gg/3DsyTN7T)
2022-06-04 23:20:23 +00:00
2022-06-03 16:24:34 +00:00
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?
2022-04-23 15:57:45 +00:00
2022-11-07 15:57:50 +00:00
Install from Cargo:
2022-06-04 22:05:47 +00:00
2022-11-09 18:55:13 +00:00
```bash
cargo install microbin
```
2022-06-04 23:20:23 +00:00
And run with your custom configuration:
2022-11-09 18:55:13 +00:00
```bash
microbin --port 8080 --public-path https://myserver.net --highlightsyntax --editable
```
2022-06-04 22:05:47 +00:00
2022-11-09 18:55:13 +00:00
Or get the Docker Image from [Dockerhub: danielszabo99/microbin ](https://hub.docker.com/r/danielszabo99/microbin ).
2022-11-07 15:57:50 +00:00
2022-11-09 09:26:44 +00:00
On our website [microbin.eu ](https://microbin.eu ) you will find the following:
2022-11-07 15:57:50 +00:00
- [Screenshots ](https://microbin.eu/screenshots/ )
- [Quickstart Guide ](https://microbin.eu/quickstart/ )
- [Documentation ](https://microbin.eu/documentation/ )
2022-11-09 15:46:51 +00:00
- [Donations and Sponsorships ](https://microbin.eu/donate/ )
2022-11-07 15:57:50 +00:00
- [Community ](https://microbin.eu/community/ )
2022-11-09 18:55:13 +00:00
## Features
2022-04-23 15:57:45 +00:00
- Is very small
2022-11-07 15:57:50 +00:00
- Entirely self-contained executable, MicroBin is a single file!
2022-04-23 15:57:45 +00:00
- Animal names instead of random numbers for pasta identifiers (64 animals)
2022-11-09 18:55:13 +00:00
- File uploads (eg. `server.com/file/pig-dog-cat` )
- Raw text serving (eg. `server.com/raw/pig-dog-cat` )
2022-06-03 16:24:34 +00:00
- URL shortening and redirection
2022-11-07 15:57:50 +00:00
- QR code support
2022-06-03 16:24:34 +00:00
- Very simple database (JSON + files) for portability, easy backups and integration
2022-11-09 18:55:13 +00:00
- Listing and manually removing pastas (`/pastalist`)
2022-11-07 15:57:50 +00:00
- Private and public, editable and final, automatically and never expiring pastas
2022-06-03 16:24:34 +00:00
- Syntax highlighting
2022-11-09 18:55:13 +00:00
- Automatic dark mode and custom styling support with very little CSS and only vanilla JS (see [`water.css` ](https://github.com/kognise/water.css ))
2022-06-03 16:24:34 +00:00
- Most of the above can be toggled on and off!
2022-10-01 06:12:24 +00:00
2022-11-09 18:55:13 +00:00
## What is a "pasta" anyway?
In MicroBin, a pasta can be:
2022-06-03 16:24:34 +00:00
- 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.
2022-11-09 18:55:13 +00:00
## When is MicroBin useful?
You can use MicroBin:
2022-06-03 16:24:34 +00:00
- 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 pastalist page
- To take notes! Simply create an editable pasta.
...and many other things, why not get creative?
2022-11-09 18:55:13 +00:00
MicroBin and MicroBin.eu are available under the [BSD 3-Clause License ](LICENSE ).
2022-10-01 06:12:24 +00:00
2022-11-09 09:26:44 +00:00
© Dániel Szabó 2022