README.md

April 17, 2026 · View on GitHub

A webhook-driven document uploader that automatically downloads and sends PDFs to your reMarkable tablet through a web interface or API. Compatible with both reMarkable Cloud and self-hosted rmfakecloud via rmapi, with features like automatic PDF conversion, compression, and organized file management.

Why the Name?

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

Features

Web Interface

Send documents from URL or local filesystem
Compression toggle for supported file types
Destination directory selector
Light/dark themes with system detection
Internationalization: 15 languages with auto-detected browser locale

Authentication & User Management

Single-user mode: Simple environment variable authentication
Multi-user mode: Database-backed user management with admin interface
- Advanced auth: OIDC and proxy authentication support
- Per-user API key management with expiration tracking
- Password reset via e-mail

Document Processing

Webhook endpoint for HTTP integrations
Automatic PDF download with realistic browser User-Agent
Web article extraction (using Mozilla Readability algorithm)
Markdown and HTML to PDF/EPUB conversion
PNG/JPEG to PDF conversion
Optional Ghostscript compression
Configurable conflict resolution (abort/overwrite/content-only)
Smart upload modes (simple or managed with retention via API)

Data Management (Mulit-User Mode)

SQLite (default) or PostgreSQL database support
Complete backup/restore system with cross-database migration
Per-user document storage and folder caching
Admin tools for user management and system settings

Screenshot

Quick Start

Simple Docker Setup

# Basic usage (pair through web interface)
docker run -d -p 8000:8000 -v ~/.config/rmapi:/root/.config/rmapi ghcr.io/rmitchellscott/aviary

Multi-User Setup

# Multi-user mode - first user becomes admin
docker run -d -p 8000:8000 \
  -e MULTI_USER=true \
  -e ALLOW_INSECURE=true \
  -v ./data:/data \
  ghcr.io/rmitchellscott/aviary

# Or pre-create admin user
docker run -d -p 8000:8000 \
  -e MULTI_USER=true \
  -e ALLOW_INSECURE=true \
  -e AUTH_USERNAME=admin \
  -e AUTH_PASSWORD=secure-password \
  -v ./data:/data \
  ghcr.io/rmitchellscott/aviary