Repository files navigation

A minimal pastebin with a design shamelessly copied frombin.

DEMO (resets every day)

You are reading the documentation for anunreleased version. You can referto released versions here:

3.4.0 •3.3.0 •3.2.0 •3.1.0 •3.0.0 •2.7.1

• axum andsqlite3 backend
• comes as a single binary with low memory footprint
• compresses pastes usingzstd
• syntax highlighting for > 170 languages withsyntect
• comes witheight color themes in light and dark mode
• encrypts entries using ChaCha20Poly1305 and argon2 hashed passwords
• allows deletion after expiration, after reading or by anonymous owners
• shows QR code to browse a paste's URL on mobile devices

• user authentication and admin functionality
• arbitrary file uploads
• mitigations for all kinds of DoS attack vectors

You can download pre-built, statically compiledLinux and MacOSbinaries. After extraction run thecontainedwastebin binary.

Alternatively, you can run a pre-built Docker image pushed toquxfoo/wastebin:<VERSION> andquxfoo/wastebin:latest respectively. Topersist the database asstate.db via theWASTEBIN_DATABASE_PATH environmentvariable use a bind mount to/path/for/storage like this

docker run \    -e WASTEBIN_DATABASE_PATH=/data/state.db \    -v /path/for/storage:/data \    -u$(id -u):$(id -g) \    quxfoo/wastebin:latest

services:wastebin:restart:alwaysenvironment:      -WASTEBIN_DATABASE_PATH=/data/state.dbports:      -"8088:8088"volumes:      -'./data:/data'image:'quxfoo/wastebin:latest'

Make sure the./data folder is writable by the user 10001.

For Nix users, aflake.nix is also provided. Build and execute it directlywith:

nix run'github:matze/wastebin#wastebin'

Or install the providedwastebin package like you normally would.

Install a Rust 2024 toolchain containing Rust 1.85 withrustup and run the server binary with

cargo run --release

It is possible to build a container image using Docker or Podman. TheDockerfile is designed to be run on an x86_64 host but capable of buildingimages for both x86_64 and aarch64 via the--target flag:

# Dockerdocker build -t wastebin:v3.0.0 -f Dockerfile --target amd64.docker build -t wastebin:v3.0.0 -f Dockerfile --target arm64.# Podmanpodman build -t wastebin:v3.0.0 -f Dockerfile --target amd64podman build -t wastebin:v3.0.0 -f Dockerfile --target arm64

Note that youcannot build aarch64 images on aarch64 hosts with it.

To interact with a running wastebin instance the bundledwastebin-ctl tool canbe used, e.g.:

podmanexec -e RUST_LOG=debug -it wastebin /app/wastebin-ctl

When viewing a paste, you can use

• r to view the raw paste,
• n to go the index page,
• y to copy the current URL to the clipboard,
• c to copy the content to the clipboard,
• q to display the current URL as a QR code,
• p to view the formatted paste and
• w to toggle line wrapping on and off (off by default)
• ? to view the list of keybindings.

To paste some text you can also use thectrl+s keycombination.

The following environment variables can be set to configure the server andrun-time behavior:

POST a new paste to the/ endpoint with the following JSON payload:

{  "text": "<paste content>",  "extension": "<file extension, optional>",  "title": "<paste title, optional>",  "expires": <number of seconds from now, optional>,  "burn_after_reading": <true/false, optional>,  "password": <password for encryption optional>,}

After successful insertion, you will receive a JSON response with the path tothe newly created paste:

{"path":"/Ibv9Fa.rs"}

To retrieve the raw content, make a GET request on the/raw/:id route. In casethe paste was encrypted, pass the password via thewastebin-password header.

To delete a paste, make a DELETE request on the/:id route with theuidcookie set that was sent back in theSet-Cookie header of the redirectresponse after creation.

wastebin-ctl is a command line tool to interact directly with the wastebindatabase. It can be used tolist all entries,purge entries which haveexpired ordelete specific entries. To specify the database either use the--database option or set theWASTEBIN_DATABASE_PATH environment variable asusual.

Use thewastebin.nvim plugin and pastethe current buffer or selection with:WastePaste.

To paste clipboard data from the command line you can use the aforementioned APIcalls together withxclip,curl andjq. Define the following function inyour.bashrc and you are good to go:

functionpaste_from_clipboard() {local API_URL="https://wastebin.tld"local URL=$(\        jq -n --arg t"$(xclip -selection clipboard -o)"'{text: $t}'| \            curl -s -H'Content-Type: application/json' --data-binary @-${API_URL}/| \            jq -r'. | "'${API_URL}'\(.path)"')    xdg-open$URL}

For wayland users, consider replace thexclip ... withwl-paste fromwl-clipboard.

To paste from stdin use the following function in your.bashrc:

functionpaste_from_stdin() {local API_URL="https://wastebin.tld"    jq -Rns'{text: inputs}'| \        curl  -s -H'Content-Type: application/json' --data-binary @-${API_URL}/| \        jq -r'. | "'${API_URL}'\(.path)"'}

It can be handy for creating pastes from logs or the output of commands, e.g.cat file.log | paste_from_stdin.

MIT