aviary

A webhook-driven document uploader for reMarkable, featuring a static Next.js + ShadCN UI and a Go backend that processes and pushes documents to your device. Compatible with both reMarkable Cloud and rmfakecloud via rmapi.

Why the Name?

Aviary is a place where birds are kept, chosen to evoke sending documents into the clouds using avian couriers.

Features

• Webhook endpoint (/api/webhook) for SMS or HTTP integrations (e.g. Twilio)
• Automatic PDF download with a real-browser User-Agent
• Optional Ghostscript compression
• Two upload modes:
  • Simple: upload the raw PDF
  • Managed: rename by date, upload, then append the year locally & clean up files older than 7 days
• Clean web UI for uploading of documents by URL or from the local filesystem

Screenshot

Environment Variable Configuration

For more rmapi-specific configuration, see their documentation.

Webhook POST parameters

Example cURL

curl -X POST http://localhost:8000/api/webhook \
  -d "Body=https://pdfobject.com/pdf/sample.pdf" \
  -d "prefix=Reports" \
  -d "compress=true" \
  -d "manage=true" \
  -d "rm_dir=Books"

Integrations

• AWS SES - Lambda to provide emailed PDFs/ePubs to Aviary.

Examples

The following examples are provided as a way to get started. Some adjustments may be required before production use, particularly regarding secret management.

Set Up

1. Get your device and user token file (rmapi.conf) from the reMarkable cloud by running the following command and entering the one-time code: docker run -it -e RMAPI_HOST=remarkable.mydomain.com ghcr.io/rmitchellscott/aviary pair
2. Save the output as rmapi.conf, and this will get mounted into the container.

Docker

docker run -d \
-p 8000:8000 \
-v ~/rmapi.conf:/root/.config/rmapi/rmapi.conf \
ghcr.io/rmitchellscott/aviary

Docker Compose

services:
  aviary:
    image: ghcr.io/rmitchellscott/aviary
    ports:
      - "8000:8000"
    environment:
      RMAPI_HOST: "${RMAPI_HOST}"
    volumes:
      - type: bind
        source: ~/rmapi.conf
        target: /root/.config/rmapi/rmapi.conf
    restart: unless-stopped

Building Locally

Requirements

• Ghostscript (gs CLI)
• npm
• rmapi (must be installed & in your $PATH)
• Access to your reMarkable credentials (rmapi setup)

Ensure the requirements are installed and available in your PATH.

go generate # Generate the Next.js static front-end
go build -o aviary