Install Paperless-AI (Linux) – One-Liner Installer Script with Docker & Caddy HTTPS

Need professional Paperless-ngx hosting or installation? At WZ-IT we handle consulting, installation, support, operation, maintenance and monitoring of Paperless-ngx and Paperless-AI - on our infrastructure or yours. Schedule your free consultation: Book a meeting.

Paperless-AI is an AI extension for Paperless-ngx that automatically analyzes incoming documents and assigns appropriate tags. Whether using OpenAI, local models with Ollama, or Azure - Paperless-AI leverages LLMs to understand document contents.

We've created a free, open-source installer script that deploys Paperless-AI with Docker in minutes - with interactive configuration for all supported AI providers.

Table of Contents

• What You Get
• Prerequisites
• Option 1: Quick Install (One Command)
• Option 2: Review Before Installing (Recommended)
• Installation Walkthrough
• Post-Installation Setup
• Useful Commands
• Uninstallation
• Troubleshooting
• Source Code

What You Get

Our installer script provides:

• Automatic Docker installation - Docker and Docker Compose are installed if not present
• Interactive configuration - Choose your installation directory, domain, and Paperless-ngx connection
• Optional HTTPS - Caddy reverse proxy with automatic Let's Encrypt certificates
• Web interface - Configure directly in the browser after installation
• Production-ready setup - Sensible defaults for immediate use

Prerequisites

Before running the installer, ensure you have:

• A Linux server (Ubuntu, Debian, CentOS, RHEL, etc.)
• bash and curl installed (standard on most systems)
• sudo access for Docker installation
• Running Paperless-ngx instance with API access
• For HTTPS: A domain name with DNS pointing to your server

Option 1: Quick Install (One Command)

If you trust the source, deploy Paperless-AI with a single command:

curl -fsSL https://raw.githubusercontent.com/wzitcom/public-scripts/main/open-source-apps/paperless-ai/install.sh | bash

Option 2: Review Before Installing (Recommended)

For security-conscious users, download and review the script first:

# Download the installer
curl -O https://raw.githubusercontent.com/wzitcom/public-scripts/main/open-source-apps/paperless-ai/install.sh

# Review the script contents
cat install.sh

# Make it executable and run
chmod +x install.sh
./install.sh

We always recommend reviewing scripts before execution, especially when running with elevated privileges.

Installation Walkthrough

When you run the installer, you'll see an interactive setup process:

The script guides you through:

1. Installation directory - Where to store configuration files (default: ~/paperless-ai)
2. Domain configuration - Optional domain for HTTPS setup

After configuration, the script:

• Installs Docker if needed
• Creates docker-compose.yml with your settings
• Sets up Caddy for HTTPS (if domain provided)
• Starts the container
• Displays access information

Post-Installation Setup

Once installation completes, Paperless-AI is ready to use:

First Login

1. Open the web interface (http://localhost:3000 or your domain)
2. Configure your Paperless-ngx connection:
   • Paperless-ngx URL
   • API Token
3. Set up your AI provider:
   • OpenAI API Key, or
   • Ollama connection, or
   • Other supported providers

How It Works

1. Paperless-AI connects to your Paperless-ngx instance
2. New documents are automatically detected
3. The AI analyzes document content
4. Appropriate tags are automatically assigned

Installation Files

Your installation directory contains:

Useful Commands

Navigate to your installation directory first:

cd ~/paperless-ai

Service Management

# View logs
docker compose logs -f
docker compose logs -f paperless-ai
docker compose logs -f caddy  # If using Caddy

# Stop services
docker compose down

# Start services
docker compose up -d

# Restart services
docker compose restart

# Check status
docker compose ps

Updates

# Pull latest images and restart
docker compose pull
docker compose up -d

Uninstallation

To completely remove Paperless-AI:

cd ~/paperless-ai

# Stop and remove containers
docker compose down

# Also remove volumes (WARNING: deletes all data!)
docker compose down -v

# Remove installation directory
cd ~
rm -rf ~/paperless-ai

Troubleshooting

Port Already in Use

If port 3000 (or 80/443 when using Caddy) is in use:

# Check what's using the ports
sudo lsof -i :3000
sudo lsof -i :80
sudo lsof -i :443

SSL Certificate Issues

# Check Caddy logs
docker compose logs caddy

# Verify DNS
nslookup your-domain.com

Connection to Paperless-ngx Fails

• Ensure Paperless-ngx is accessible from this server
• Check firewall rules between servers
• Verify the API token is correct

Container Won't Start

# Check container logs
docker compose logs paperless-ai

# Check container status
docker ps -a

Source Code

The installer script is open source and available on GitHub:

• Repository: github.com/wzitcom/public-scripts
• Paperless-AI Installer: open-source-apps/paperless-ai

Feel free to review, fork, or contribute!

Disclaimer

This script is intended for quickly deploying development and testing environments.

For production deployments, please consider:

• Proper security hardening
• Secure storage of API keys
• Firewall and network security rules
• Regular backup strategies
• Resource monitoring and alerting
• Custom environment configurations

Need a production-ready setup? Contact WZ-IT for professional Paperless-ngx and Paperless-AI installation and managed hosting services.