Documentation #

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?

Features #

What is a "pasta" anyway? #

In microbin, a pasta can be:

When is MicroBin useful? #

You can use MicroBin

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

Creating a Pasta #

Navigate to the root of your server, for example https://microbin.myserver.com/. This should show you a form where you will at the very least see an expiration selector, a file attachment input, a content text field and a green save button. Depending on your configuration there miight also be a syntax highlight selector, an editable checkbox and a private ceckbox.

Use the expiration dropdown to choose how long you want your pasta to exist. When the selected time has expired, it will be removed from the server. The content can be any text, including plain text, pre, html, even a URL. A URL is a special case, because when you open the pasta again, it will redirect you to that URL instead of showing it as a text. Entering content is optional, and so is the file attachment. If you want, you can even submit a pasta completely empty.

You will be redirected to the URL of the pasta, which will end with a few animal names. If you remember those animals, you can simply type them in on another machine and open your pasta elsewhere.

If you have editable pastas enabled and you check the editable checkbox, then later on there will be an option to change the text content of your pasta. Selecting the private checkbox will simply prevent your pasta to show up on the pasta list page, if that is enabled.

If you have syntax higlighting enabled, then select your language from the dropdown, or leave it as none if you just want to upload plain with no highlighting.

Listing Pastas #

If you have pasta listing enabled, then there is a pasta list option in the navigation bar, which will list all the pastas on the server in two groups: regular pastas and URL redirects (pastas containing nothing but a URL). If you have private pastas enabled, they will not show up here at all.

From the pasta list page, you will be able to view individual pastas by clicking on their animal identifiers on the lest, view their raw contrent by clicking on the Raw button, remove them, and if you have editable pastas enabled, then open them in edit view.

Use MicroBin from the console with cURL #

Simple text Pasta: curl -d "expiration=10min&content=This is a test pasta" -X POST https://microbin.myserver.com/create

File contents: curl -d "expiration=10min&content=$( < mypastafile.txt )" -X POST https://microbin.myserver.com/create

Available expiration options:
1min, 10min, 1hour, 24hour, 1week, never

Use cURL to read the pasta: curl https://microbin.myserver.com/rawpasta/fish-pony-crow,

or to download the pasta: curl https://microbin.myserver.com/rawpasta/fish-pony-crow > output.txt (use /file instead of /rawpasta to download attached file).
ome/ubuntu/server/microbin

Command Line Arguments #

There is an ever expanding list of customisations built into MicroBin so you can use it the way you want. Instead of a configuration file, we simply use arguments that you pass to the executable, making the workflow even simpler. Read the following options and if you cannot find what you need, you can always open an issue at our GitHub repository and request a new feature!

If you don't want to spend a long time browsing options, use this. Make sure to replace the public path with yours, or remove the option.

microbin -- \
--editable \
--enable-burn-after \
--private \
--qr \
--highlightsyntax \
--bind 0.0.0.0 \
--port 8080 \
--public-path="http://your-server.com"

--auth-username [AUTH_USERNAME] #

Require username for HTTP Basic Authentication when visiting the service. If --auth-username is set but --auth-password is not, just leave the password field empty when logging in. You can also just go to https://username:password@yourserver.net or https://username@yourserver.net if password is not set instead of typing into the password

--auth-password [AUTH_PASSWORD] #

Require password for HTTP Basic Authentication when visiting the service. Will not have any affect unless --auth-username is also set. If --auth-username is set but --auth-password is not, just leave the password field empty when logging in. You can also just go to https://username:password@yourserver.net or https://username@yourserver.net if password is not set instead of typing into the password prompt.

--custom-css [CSS_URL] #

Replaced the built-in water.css stylesheet with the URL you provide.

--default-expiry [BURN_AFTER] #

Sets the default burn after setting on the main screen.

Default value: 0

Available expiration options:
1, 10, 100, 1000, 10000, 0 (= no limit)

--default-expiry [EXPIRY] #

Sets the default expiry time setting on the main screen.

Default value: 24hour

Available expiration options:
1min, 10min, 1hour, 24hour, 1week, never

--editable #

Enables editable pastas. You will still be able to make finalised pastas but there will be an extra checkbox to make your new pasta editable from the pasta list or the pasta view page.

Replaces the default footer text with your own. If you want to hide the footer, use --hide-footer instead.

--gc-days [DAYS] #

Sets the garbage collector time limit. Pastas not accessed for N days are removed even if they are set to never expire.

Default value: 90

To turn off GC: 0

--hash-ids #

Use short hash strings in the URLs instead of animal names to make URLs shorter. Does not change the underlying data stored, just how pastas are recalled.

-h, --help #

Show all commands in the terminal.

Hides the footer on every page.

--hide-header #

Hides the navigation bar on every page.

Hides the MicroBin logo from the navigation bar on every page.

--no-eternal-pasta #

Disables "Never" expiry settings for pastas.

--no-file-upload #

Disables and hides the file upload option in the UI.

--no-listing #

Disables the /pastalist endpoint, essentially making all pastas private.

--highlightsyntax #

Enables syntax highlighting support. When creating a new pasta, a new dropdown selector will be added where you can select your pasta's syntax, or just leave it empty for no highlighting.

-p, --port [PORT] #

Default value: 8080

Sets the port for the server will be listening on.

-b, --bind [ADDRESS] #

Default value: 0.0.0.0

Sets the bind address for the server will be listening on. Both ipv4 and ipv6 are supported.

--private #

Enables private pastas. Adds a new checkbox to make your pasta private, which then won't show up on the pastalist page. With the URL to your pasta, it will still be accessible.

--pure-html #

Disables main CSS styling, just uses a few in-line stylings for the layout. With this option you will lose dark-mode support.

--readonly #

Disables adding/editing/removing pastas entirely.

--title [TITLE] #

Replaces "MicroBin" with your title of choice in the navigation bar.

-t, --threads [THREADS] #

Default value: 1

Number of workers MicroBin is allowed to have. Increase this to the number of CPU cores you have if you want to go beast mode, but for personal use one worker is enough.

-V, --version #

Displays your MicroBin's version information.

--wide #

Changes the maximum width of the UI from 720 pixels to 1080 pixels.

--public-path [PUBLIC_PATH] #

Add the given public path prefix to all urls.

This allows you to host MicroBin behind a reverse proxy on a subpath.
Note that MicroBin itself still expects all routes to be as without this option, and thus is unsuited if you are running MicroBin directly.

--qr #

Enables generating QR codes for pastas. Requires --public-path to be set.


Proudly made and hosted in the EU. Let's keep the Web compact, accessible and humane! © Dániel Szabó 2022
MicroBin.eu, its contents and the MicroBin server are licensed under the BSD 3-Clause License.