GitHub - matze/wastebin: wastebin is a pastebin 📝

support 🇺🇦 • defend 🇪🇺

A minimal pastebin with a design shamelessly copied from bin.

DEMO (resets every day)

You are reading the documentation for an unreleased version. You can refer to released versions here:

3.4.0 • 3.3.0 • 3.2.0 • 3.1.0 • 3.0.0 • 2.7.1

Features

• axum and sqlite3 backend
• comes as a single binary with low memory footprint
• compresses pastes using zstd
• syntax highlighting for > 170 languages with syntect
• comes with eight 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

Non-features

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

Installation

Run pre-built binaries

You can download pre-built, statically compiled Linux and MacOS binaries. After extraction run the contained wastebin binary.

Run a Docker image

Alternatively, you can run a pre-built Docker image pushed to quxfoo/wastebin:<VERSION> and quxfoo/wastebin:latest respectively. To persist the database as state.db via the WASTEBIN_DATABASE_PATH environment variable 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

Run with docker-compose

services:
  wastebin:
    restart: always
    environment:
      - WASTEBIN_DATABASE_PATH=/data/state.db
    ports:
      - "8088:8088"
    volumes:
      - './data:/data'
    image: 'quxfoo/wastebin:latest'

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

Run with Nix

For Nix users, a flake.nix is also provided. Build and execute it directly with:

nix run 'github:matze/wastebin#wastebin'

Or install the provided wastebin package like you normally would.

Build from source

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

Build a container image

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

# Docker
docker build -t wastebin:v3.0.0 -f Dockerfile --target amd64 .
docker build -t wastebin:v3.0.0 -f Dockerfile --target arm64 .

# Podman
podman build -t wastebin:v3.0.0 -f Dockerfile --target amd64
podman build -t wastebin:v3.0.0 -f Dockerfile --target arm64

Note that you cannot build aarch64 images on aarch64 hosts with it.

To interact with a running wastebin instance the bundled wastebin-ctl tool can be used, e.g.:

podman exec -e RUST_LOG=debug -it wastebin /app/wastebin-ctl

Usage

Browser interface

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 the ctrl+s key combination.

Configuration

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

API endpoints

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 to the newly created paste:

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

To delete a paste, make a DELETE request on the /:id route with the uid cookie set that was sent back in the Set-Cookie header of the redirect response after creation.

wastebin-ctl command line tool

wastebin-ctl is a command line tool to interact directly with the wastebin database. It can be used to list all entries, purge entries which have expired or delete specific entries. To specify the database either use the --database option or set the WASTEBIN_DATABASE_PATH environment variable as usual.

Paste from neovim

Use the wastebin.nvim plugin and paste the current buffer or selection with :WastePaste.

Paste from clipboard

To paste clipboard data from the command line you can use the aforementioned API calls together with xclip, curl and jq. Define the following function in your .bashrc and you are good to go:

function paste_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 the xclip ... with wl-paste from wl-clipboard.

Paste from stdin

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

function paste_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.

License

MIT