paaster

<div align="center">
  <img src="./assets/logo.png" width="300px" />
  <h1>Paaster.io</h1>
  <blockquote>
    Paaster is a secure and user-friendly pastebin application that prioritizes privacy and simplicity. With end-to-end encryption and paste history, Paaster ensures that your pasted code remains confidential and accessible.
  </blockquote>

  <a href="https://paaster.io/terms-of-service">Terms of service</a> · <a href="https://paaster.io/privacy-policy">Privacy policy</a>

  <br><br>

  <a href="https://fink.inlang.com/github.com/WardPearce/paaster"><img src="https://img.shields.io/badge/Help_translate-0a0a0a?style=for-the-badge" alt="Translate"></a>
  <a href="https://github.com/WardPearce/paaster/releases"><img src="https://img.shields.io/github/v/release/WardPearce/paaster?style=for-the-badge&label=Release&color=0a0a0a" alt="Release"></a>
  <a href="https://matrix.to/#/#ward:matrix.org"><img src="https://img.shields.io/badge/Chat-0a0a0a?style=for-the-badge&logo=matrix" alt="Matrix"></a>
  <a href="https://hub.docker.com/r/wardpearce/paaster"><img src="https://img.shields.io/docker/pulls/wardpearce/paaster?style=for-the-badge&label=Docker&color=0a0a0a" alt="Docker"></a>
</div>

---

# Preview

![Preview of paaster](./previews/image.png)

---

# Table of Contents

- [Features](#features)
- [Deployment](#deployment)
  - [Docker Compose](#docker-compose)
  - [Reverse Proxy](#reverse-proxy)
  - [Minio Setup](#minio)
- [Security](#security)
  - [What is E2EE?](#what-is-e2ee)
  - [FAQ](#faq)
- [Cipher](#cipher)
- [Requesting Features](#requesting-features)
- [Support](#support)

---

# Features

- [End-to-end encryption](#what-is-e2ee)
- Memory efficient
- File drag & drop
- Keyboard shortcuts
- Paste history
- Themes
- Delete after view or X amount of time
- Share via QR code
- [CLI Tool](https://github.com/WardPearce/paaster-cli)
- i18n support ([Contribute](https://fink.inlang.com/github.com/WardPearce/paaster))
- Automatic or manual language detection
- No dynamically loaded 3rd party dependencies — malicious code must be present at build time
- Use of `package-lock.json` & [Socket.dev](https://socket.dev/) to fight supply chain attacks

---

# Deployment

Paaster requires S3-compatible object storage. You can use a hosted solution or self-host using [MinIO](https://github.com/minio/minio).

## Docker Compose

```yaml
services:
  paaster:
    container_name: paaster
    image: wardpearce/paaster:latest
    restart: unless-stopped
    ports:
      - 3015:3000
    environment:
      COOKIE_SECRET: "" # A secure random value

      S3_ENDPOINT: ""
      S3_REGION: ""
      S3_ACCESS_KEY_ID: ""
      S3_SECRET_ACCESS_KEY: ""
      S3_BUCKET: ""
      s3_FORCE_PATH_STYLE: true # Required for minio

      MONGO_DB: "paasterv3"
      MONGO_URL: "mongodb://paaster_mongodb:27017"

  paaster_mongodb:
    image: mongo
    container_name: paaster_mongodb
    restart: unless-stopped
    environment:
      MONGODB_DATA_DIR: /data/db
      MONDODB_LOG_DIR: /dev/null

  paaster_minio:
    container_name: paaster_minio
    image: quay.io/minio/minio
    restart: unless-stopped
    ports:
      - "9000:9000"
      - "9001:9001"
    environment:
      MINIO_ROOT_USER: ""
      MINIO_ROOT_PASSWORD: "" # A secure random value
    volumes:
      - ~/minio/data:/data
    command: server /data --console-address ":9001"
```

## Reverse Proxy

### Caddy

```caddy
paaster.io {
    reverse_proxy localhost:3016
}

# Only required for MinIO
s3.paaster.io {
    header Access-Control-Allow-Origin "https://paaster.io" {
        defer
    }
    header Access-Control-Allow-Methods "GET,POST,OPTIONS,HEAD,PATCH,PUT,DELETE"
    header Access-Control-Allow-Headers "User-Agent,Authorization,Content-Type"
    reverse_proxy localhost:9000
}
```

### NGINX

```nginx
server {
    listen 80;
    server_name paaster.io;

    location / {
        proxy_pass http://localhost:3016;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}

# Only required for MinIO
server {
    listen 80;
    server_name s3.paaster.io;

    location / {
        add_header 'Access-Control-Allow-Origin' 'https://paaster.io' always;
        add_header 'Access-Control-Allow-Methods' 'GET,POST,OPTIONS,HEAD,PATCH,PUT,DELETE' always;
        add_header 'Access-Control-Allow-Headers' 'User-Agent,Authorization,Content-Type' always;

        proxy_pass http://localhost:9000;
        proxy_set_header Host $host;
        proxy_set_header X-Real-IP $remote_addr;
    }
}
```

## MinIO

### Install mc CLI

[Follow the official guide](https://min.io/docs/minio/linux/reference/minio-mc.html#install-mc)

### Add instance

```
mc alias set minio_instance https://s3.paaster.io my_minio_username my_minio_password
```

### Create bucket

```
mc mb minio_instance/paaster
mc anonymous set none minio_instance/paaster
```

### Get credentials

```
mc admin accesskey create minio_instance/my_minio_username
```

### Object storage providers

- [iDrive e2](https://www.idrive.com/e2/) (no free tier anymore)
- [Wasabi Hot Cloud Storage](https://wasabi.com/hot-cloud-storage/)
- [Storj](https://www.storj.io/) (25 GB free tier)
- [Contabo object storage](https://contabo.com/en/object-storage/)
- [Cloudflare R2](https://www.cloudflare.com/products/r2/)
- [Amazon S3](https://aws.amazon.com/s3/)
- [Google Cloud Storage](https://cloud.google.com/storage)

---

# Security

## What is E2EE?

End-to-end encryption (E2EE) is a zero-trust encryption methodology. When you paste code into Paaster, it is encrypted locally in your browser using a secret that is never shared with the server. Only people you share the link with can view the paste.

## FAQ

### Can I trust an instance of Paaster not hosted by me?

No. Anyone could modify the functionality of Paaster to expose your secret key to the server. We recommend using an instance you host or trust.

### How are client secrets stored?

Client secrets are stored in IndexedDB when the paste is created, allowing for paste history. This method of storage makes Paaster vulnerable to malicious JavaScript, but it would require malicious code to be present when the application is built.

### How are client secrets transported?

Paaster uses URI fragments to transport secrets. According to the [Mozilla Foundation](https://developer.mozilla.org/en-US/docs/Learn/Common_questions/Web_mechanics/What_is_a_URL#anchor), URI fragments aren't meant to be sent to the server. Bitwarden also has an article covering this usage [here](https://bitwarden.com/blog/bitwarden-send-how-it-works/).

### How are server secrets stored?

Server secrets are stored in IndexedDB when the paste is created, allowing for modification or deletion of pastes later on.

---

# Cipher

Paaster uses the following libsodium functions:

- `crypto_secretstream_xchacha20poly1305_*`
- `crypto_pwhash`
- `crypto_secretbox_easy`

These are implemented using the [libsodium-wrappers-sumo](https://www.npmjs.com/package/libsodium-wrappers-sumo) library.

---

# Requesting Features

- Open a [new issue](https://github.com/WardPearce/paaster/issues/new) to request a feature (one issue per feature).

### What we won't add

- **Paste editing** — Paaster isn't a text editor, it's a pastebin.
- **Paste button** — Paaster isn't a text editor. When code is inputted, it will always be automatically uploaded.
- **Optional encryption** — Paaster will never have opt-in/opt-out encryption. Encryption will always be present.

---

# Support

Have any questions? [Join our Matrix space](https://matrix.to/#/#ward:matrix.org).