paradizelost/paperless-ngx
1
0
Fork 0
mirror of https://github.com/paperless-ngx/paperless-ngx.git synced 2025-04-02 13:45:10 -05:00
Code Issues Packages Projects Releases Wiki Activity
paperless-ngx/setup/index.html

1686 lines
68 KiB
HTML
Raw Permalink Blame History

<!doctype html>
<html lang="en" class="no-js">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width,initial-scale=1">
<link rel="prev" href="..">
<link rel="next" href="../usage/">
<link rel="icon" href="../assets/favicon.png">
<meta name="generator" content="mkdocs-1.6.1, mkdocs-material-9.5.50">
<title>Setup - Paperless-ngx</title>
<link rel="stylesheet" href="../assets/stylesheets/main.a40c8224.min.css">
<link rel="stylesheet" href="../assets/stylesheets/palette.06af60db.min.css">
<link rel="preconnect" href="https://fonts.gstatic.com" crossorigin>
<link rel="stylesheet" href="https://fonts.googleapis.com/css?family=Roboto:300,300i,400,400i,700,700i%7CRoboto+Mono:400,400i,700,700i&display=fallback">
<style>:root{--md-text-font:"Roboto";--md-code-font:"Roboto Mono"}</style>
<link rel="stylesheet" href="../assets/extra.css">
<script>__md_scope=new URL("..",location),__md_hash=e=>[...e].reduce(((e,_)=>(e<<5)-e+_.charCodeAt(0)),0),__md_get=(e,_=localStorage,t=__md_scope)=>JSON.parse(_.getItem(t.pathname+"."+e)),__md_set=(e,_,t=localStorage,a=__md_scope)=>{try{t.setItem(a.pathname+"."+e,JSON.stringify(_))}catch(e){}}</script>
<link href="../assets/stylesheets/glightbox.min.css" rel="stylesheet"/><style>
html.glightbox-open { overflow: initial; height: 100%; }
.gslide-title { margin-top: 0px; user-select: text; }
.gslide-desc { color: #666; user-select: text; }
.gslide-image img { background: white; }
.gscrollbar-fixer { padding-right: 15px; }
.gdesc-inner { font-size: 0.75rem; }
body[data-md-color-scheme="slate"] .gdesc-inner { background: var(--md-default-bg-color);}
body[data-md-color-scheme="slate"] .gslide-title { color: var(--md-default-fg-color);}
body[data-md-color-scheme="slate"] .gslide-desc { color: var(--md-default-fg-color);}</style> <script src="../assets/javascripts/glightbox.min.js"></script></head>
<body dir="ltr" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo">
<input class="md-toggle" data-md-toggle="drawer" type="checkbox" id="__drawer" autocomplete="off">
<input class="md-toggle" data-md-toggle="search" type="checkbox" id="__search" autocomplete="off">
<label class="md-overlay" for="__drawer"></label>
<div data-md-component="skip">
<a href="#installation" class="md-skip">
Skip to content
</a>
</div>
<div data-md-component="announce">
</div>
<header class="md-header" data-md-component="header">
<nav class="md-header__inner md-grid" aria-label="Header">
<a href=".." title="Paperless-ngx" class="md-header__button md-logo" aria-label="Paperless-ngx" data-md-component="logo">
<img src="../assets/logo.svg" alt="logo">
</a>
<label class="md-header__button md-icon" for="__drawer">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M3 6h18v2H3zm0 5h18v2H3zm0 5h18v2H3z"/></svg>
</label>
<div class="md-header__title" data-md-component="header-title">
<div class="md-header__ellipsis">
<div class="md-header__topic">
<span class="md-ellipsis">
Paperless-ngx
</span>
</div>
<div class="md-header__topic" data-md-component="header-topic">
<span class="md-ellipsis">
Setup
</span>
</div>
</div>
</div>
<form class="md-header__option" data-md-component="palette">
<input class="md-option" data-md-color-media="(prefers-color-scheme)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to light mode" type="radio" name="__palette" id="__palette_0">
<label class="md-header__button md-icon" title="Switch to light mode" for="__palette_1" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="m14.3 16-.7-2h-3.2l-.7 2H7.8L11 7h2l3.2 9zM20 8.69V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12zm-9.15 3.96h2.3L12 9z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: light)" data-md-color-scheme="default" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to dark mode" type="radio" name="__palette" id="__palette_1">
<label class="md-header__button md-icon" title="Switch to dark mode" for="__palette_2" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 8a4 4 0 0 0-4 4 4 4 0 0 0 4 4 4 4 0 0 0 4-4 4 4 0 0 0-4-4m0 10a6 6 0 0 1-6-6 6 6 0 0 1 6-6 6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
<input class="md-option" data-md-color-media="(prefers-color-scheme: dark)" data-md-color-scheme="slate" data-md-color-primary="indigo" data-md-color-accent="indigo" aria-label="Switch to system preference" type="radio" name="__palette" id="__palette_2">
<label class="md-header__button md-icon" title="Switch to system preference" for="__palette_0" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 18c-.89 0-1.74-.2-2.5-.55C11.56 16.5 13 14.42 13 12s-1.44-4.5-3.5-5.45C10.26 6.2 11.11 6 12 6a6 6 0 0 1 6 6 6 6 0 0 1-6 6m8-9.31V4h-4.69L12 .69 8.69 4H4v4.69L.69 12 4 15.31V20h4.69L12 23.31 15.31 20H20v-4.69L23.31 12z"/></svg>
</label>
</form>
<script>var palette=__md_get("__palette");if(palette&&palette.color){if("(prefers-color-scheme)"===palette.color.media){var media=matchMedia("(prefers-color-scheme: light)"),input=document.querySelector(media.matches?"[data-md-color-media='(prefers-color-scheme: light)']":"[data-md-color-media='(prefers-color-scheme: dark)']");palette.color.media=input.getAttribute("data-md-color-media"),palette.color.scheme=input.getAttribute("data-md-color-scheme"),palette.color.primary=input.getAttribute("data-md-color-primary"),palette.color.accent=input.getAttribute("data-md-color-accent")}for(var[key,value]of Object.entries(palette.color))document.body.setAttribute("data-md-color-"+key,value)}</script>
<label class="md-header__button md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
</label>
<div class="md-search" data-md-component="search" role="dialog">
<label class="md-search__overlay" for="__search"></label>
<div class="md-search__inner" role="search">
<form class="md-search__form" name="search">
<input type="text" class="md-search__input" name="query" aria-label="Search" placeholder="Search" autocapitalize="off" autocorrect="off" autocomplete="off" spellcheck="false" data-md-component="search-query" required>
<label class="md-search__icon md-icon" for="__search">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M9.5 3A6.5 6.5 0 0 1 16 9.5c0 1.61-.59 3.09-1.56 4.23l.27.27h.79l5 5-1.5 1.5-5-5v-.79l-.27-.27A6.52 6.52 0 0 1 9.5 16 6.5 6.5 0 0 1 3 9.5 6.5 6.5 0 0 1 9.5 3m0 2C7 5 5 7 5 9.5S7 14 9.5 14 14 12 14 9.5 12 5 9.5 5"/></svg>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M20 11v2H8l5.5 5.5-1.42 1.42L4.16 12l7.92-7.92L13.5 5.5 8 11z"/></svg>
</label>
<nav class="md-search__options" aria-label="Search">
<button type="reset" class="md-search__icon md-icon" title="Clear" aria-label="Clear" tabindex="-1">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M19 6.41 17.59 5 12 10.59 6.41 5 5 6.41 10.59 12 5 17.59 6.41 19 12 13.41 17.59 19 19 17.59 13.41 12z"/></svg>
</button>
</nav>
</form>
<div class="md-search__output">
<div class="md-search__scrollwrap" tabindex="0" data-md-scrollfix>
<div class="md-search-result" data-md-component="search-result">
<div class="md-search-result__meta">
Initializing search
</div>
<ol class="md-search-result__list" role="presentation"></ol>
</div>
</div>
</div>
</div>
</div>
<div class="md-header__source">
<a href="https://github.com/paperless-ngx/paperless-ngx" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
paperless-ngx/paperless-ngx
</div>
</a>
</div>
</nav>
</header>
<div class="md-container" data-md-component="container">
<nav class="md-tabs" aria-label="Tabs" data-md-component="tabs">
<div class="md-grid">
<ul class="md-tabs__list">
<li class="md-tabs__item">
<a href=".." class="md-tabs__link">
Home
</a>
</li>
<li class="md-tabs__item md-tabs__item--active">
<a href="./" class="md-tabs__link">
Setup
</a>
</li>
<li class="md-tabs__item">
<a href="../usage/" class="md-tabs__link">
Basic Usage
</a>
</li>
<li class="md-tabs__item">
<a href="../configuration/" class="md-tabs__link">
Configuration
</a>
</li>
<li class="md-tabs__item">
<a href="../administration/" class="md-tabs__link">
Administration
</a>
</li>
<li class="md-tabs__item">
<a href="../advanced_usage/" class="md-tabs__link">
Advanced Topics
</a>
</li>
<li class="md-tabs__item">
<a href="../api/" class="md-tabs__link">
REST API
</a>
</li>
<li class="md-tabs__item">
<a href="../development/" class="md-tabs__link">
Development
</a>
</li>
<li class="md-tabs__item">
<a href="../faq/" class="md-tabs__link">
FAQs
</a>
</li>
<li class="md-tabs__item">
<a href="../troubleshooting/" class="md-tabs__link">
Troubleshooting
</a>
</li>
<li class="md-tabs__item">
<a href="../changelog/" class="md-tabs__link">
Changelog
</a>
</li>
</ul>
</div>
</nav>
<main class="md-main" data-md-component="main">
<div class="md-main__inner md-grid">
<div class="md-sidebar md-sidebar--primary" data-md-component="sidebar" data-md-type="navigation" >
<div class="md-sidebar__scrollwrap">
<div class="md-sidebar__inner">
<nav class="md-nav md-nav--primary md-nav--lifted md-nav--integrated" aria-label="Navigation" data-md-level="0">
<label class="md-nav__title" for="__drawer">
<a href=".." title="Paperless-ngx" class="md-nav__button md-logo" aria-label="Paperless-ngx" data-md-component="logo">
<img src="../assets/logo.svg" alt="logo">
</a>
Paperless-ngx
</label>
<div class="md-nav__source">
<a href="https://github.com/paperless-ngx/paperless-ngx" title="Go to repository" class="md-source" data-md-component="source">
<div class="md-source__icon md-icon">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</div>
<div class="md-source__repository">
paperless-ngx/paperless-ngx
</div>
</a>
</div>
<ul class="md-nav__list" data-md-scrollfix>
<li class="md-nav__item">
<a href=".." class="md-nav__link">
<span class="md-ellipsis">
Home
</span>
</a>
</li>
<li class="md-nav__item md-nav__item--active">
<input class="md-nav__toggle md-toggle" type="checkbox" id="__toc">
<label class="md-nav__link md-nav__link--active" for="__toc">
<span class="md-ellipsis">
Setup
</span>
<span class="md-nav__icon md-icon"></span>
</label>
<a href="./" class="md-nav__link md-nav__link--active">
<span class="md-ellipsis">
Setup
</span>
</a>
<nav class="md-nav md-nav--secondary" aria-label="Table of contents">
<label class="md-nav__title" for="__toc">
<span class="md-nav__icon md-icon"></span>
Table of contents
</label>
<ul class="md-nav__list" data-md-component="toc" data-md-scrollfix>
<li class="md-nav__item">
<a href="#installation" class="md-nav__link">
<span class="md-ellipsis">
Installation
</span>
</a>
<nav class="md-nav" aria-label="Installation">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#docker_script" class="md-nav__link">
<span class="md-ellipsis">
Use the Installation Script
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docker" class="md-nav__link">
<span class="md-ellipsis">
Use Docker Compose
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#docker_build" class="md-nav__link">
<span class="md-ellipsis">
Build the Docker image yourself
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#bare_metal" class="md-nav__link">
<span class="md-ellipsis">
Bare Metal Route
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#migrating-to-paperless-ngx" class="md-nav__link">
<span class="md-ellipsis">
Migrating to Paperless-ngx
</span>
</a>
<nav class="md-nav" aria-label="Migrating to Paperless-ngx">
<ul class="md-nav__list">
<li class="md-nav__item">
<a href="#migrating-from-paperless-ng" class="md-nav__link">
<span class="md-ellipsis">
Migrating from Paperless-ng
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#migrating-from-paperless" class="md-nav__link">
<span class="md-ellipsis">
Migrating from Paperless
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#migrating-from-linuxserverio-docker-image" class="md-nav__link">
<span class="md-ellipsis">
Migrating from LinuxServer.io Docker Image
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#sqlite_to_psql" class="md-nav__link">
<span class="md-ellipsis">
Moving data from SQLite to PostgreSQL or MySQL/MariaDB
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#moving-back-to-paperless" class="md-nav__link">
<span class="md-ellipsis">
Moving back to Paperless
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="#less-powerful-devices" class="md-nav__link">
<span class="md-ellipsis">
Considerations for less powerful devices
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#nginx" class="md-nav__link">
<span class="md-ellipsis">
Using nginx as a reverse proxy
</span>
</a>
</li>
<li class="md-nav__item">
<a href="#security" class="md-nav__link">
<span class="md-ellipsis">
Enhancing security
</span>
</a>
</li>
</ul>
</nav>
</li>
<li class="md-nav__item">
<a href="../usage/" class="md-nav__link">
<span class="md-ellipsis">
Basic Usage
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../configuration/" class="md-nav__link">
<span class="md-ellipsis">
Configuration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../administration/" class="md-nav__link">
<span class="md-ellipsis">
Administration
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../advanced_usage/" class="md-nav__link">
<span class="md-ellipsis">
Advanced Topics
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../api/" class="md-nav__link">
<span class="md-ellipsis">
REST API
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../development/" class="md-nav__link">
<span class="md-ellipsis">
Development
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../faq/" class="md-nav__link">
<span class="md-ellipsis">
FAQs
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../troubleshooting/" class="md-nav__link">
<span class="md-ellipsis">
Troubleshooting
</span>
</a>
</li>
<li class="md-nav__item">
<a href="../changelog/" class="md-nav__link">
<span class="md-ellipsis">
Changelog
</span>
</a>
</li>
</ul>
</nav>
</div>
</div>
</div>
<div class="md-content" data-md-component="content">
<article class="md-content__inner md-typeset">
<h2 id="installation">Installation</h2>
<p>You can go multiple routes to setup and run Paperless:</p>
<ul>
<li><a href="#docker_script">Use the script to setup a Docker install</a></li>
<li><a href="#docker">Use the Docker compose templates</a></li>
<li><a href="#docker_build">Build the Docker image yourself</a></li>
<li><a href="#bare_metal">Install Paperless-ngx directly on your system manually ("bare metal")</a></li>
<li>A user-maintained list of commercial hosting providers can be found <a href="https://github.com/paperless-ngx/paperless-ngx/wiki/Related-Projects">in the wiki</a></li>
</ul>
<p>The Docker routes are quick &amp; easy. These are the recommended routes.
This configures all the stuff from the above automatically so that it
just works and uses sensible defaults for all configuration options.
Here you find a cheat-sheet for docker beginners: <a href="https://www.sehn.tech/refs/devops-with-docker/">CLI
Basics</a></p>
<p>The bare metal route is complicated to setup but makes it easier should
you want to contribute some code back. You need to configure and run the
above mentioned components yourself.</p>
<h3 id="docker_script">Use the Installation Script</h3>
<p>Paperless provides an interactive installation script to setup a Docker Compose
installation. The script asks for a couple configuration options, and will then create the
necessary configuration files, pull the docker image, start Paperless-ngx and create your superuser
account. The script essentially automatically performs the steps described in <a href="#docker">Docker setup</a>.</p>
<ol>
<li>
<p>Make sure that Docker and Docker Compose are <a href="https://docs.docker.com/engine/install/" target="_blank">installed</a>.</p>
</li>
<li>
<p>Download and run the installation script:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-0-1" name="__codelineno-0-1" href="#__codelineno-0-1"></a><span class="go">bash -c &quot;$(curl --location --silent --show-error https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/install-paperless-ngx.sh)&quot;</span>
</code></pre></div>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>macOS users will need to install <a href="https://formulae.brew.sh/formula/gnu-sed">gnu-sed</a> with support
for running as <code>sed</code> as well as <a href="https://formulae.brew.sh/formula/wget">wget</a>.</p>
</div>
</li>
</ol>
<h3 id="docker">Use Docker Compose</h3>
<ol>
<li>
<p>Make sure that Docker and Docker Compose are <a href="https://docs.docker.com/engine/install/" target="_blank">installed</a>.</p>
</li>
<li>
<p>Go to the <a href="https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose" target="_blank">/docker/compose directory on the project
page</a>
and download one of the <code>docker-compose.*.yml</code> files, depending on which database backend
you want to use. Place the files in a local directory and rename it <code>docker-compose.yml</code>. Download the
<code>docker-compose.env</code> file and the <code>.env</code> file as well in the same directory.</p>
<p>If you want to enable optional support for Office and other documents, download a
file with <code>-tika</code> in the file name.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>For new installations, it is recommended to use PostgreSQL as the
database backend.</p>
</div>
</li>
<li>
<p>Modify <code>docker-compose.yml</code> as needed. For example, you may want to change the paths to the
consumption, media etc. directories to use 'bind mounts'.
Find the line that specifies where to mount the directory, e.g.:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-1-1" name="__codelineno-1-1" href="#__codelineno-1-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">./consume:/usr/src/paperless/consume</span>
</code></pre></div>
<p>Replace the part <em>before</em> the colon with a local directory of your choice:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-2-1" name="__codelineno-2-1" href="#__codelineno-2-1"></a><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">/home/jonaswinkler/paperless-inbox:/usr/src/paperless/consume</span>
</code></pre></div>
<p>You may also want to change the default port that the webserver will
use from the default (8000) to something else, e.g. for port 8010:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-3-1" name="__codelineno-3-1" href="#__codelineno-3-1"></a><span class="nt">ports</span><span class="p">:</span>
<a id="__codelineno-3-2" name="__codelineno-3-2" href="#__codelineno-3-2"></a><span class="w"> </span><span class="p p-Indicator">-</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">8010:8000</span>
</code></pre></div>
<p><strong>Rootless</strong></p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>It is currently not possible to run the container rootless if additional languages are specified via <code>PAPERLESS_OCR_LANGUAGES</code>.</p>
</div>
<p>If you want to run Paperless as a rootless container, you will need
to do the following in your <code>docker-compose.yml</code>:</p>
<ul>
<li>set the <code>user</code> running the container to map to the <code>paperless</code>
user in the container. This value (<code>user_id</code> below), should be
the same id that <code>USERMAP_UID</code> and <code>USERMAP_GID</code> are set to in
the next step. See <code>USERMAP_UID</code> and <code>USERMAP_GID</code>
<a href="../configuration/#docker">here</a>.</li>
</ul>
<p>Your entry for Paperless should contain something like:</p>
<blockquote>
<div class="highlight"><pre><span></span><code><a id="__codelineno-4-1" name="__codelineno-4-1" href="#__codelineno-4-1"></a>webserver:
<a id="__codelineno-4-2" name="__codelineno-4-2" href="#__codelineno-4-2"></a> image: ghcr.io/paperless-ngx/paperless-ngx:latest
<a id="__codelineno-4-3" name="__codelineno-4-3" href="#__codelineno-4-3"></a> user: &lt;user_id&gt;
</code></pre></div>
</blockquote>
</li>
<li>
<p>Modify <code>docker-compose.env</code> with any configuration options you'd like.
See the <a href="../configuration/">configuration documentation</a> for all options.</p>
<p>You may also need to set <code>USERMAP_UID</code> and <code>USERMAP_GID</code> to
the uid and gid of your user on the host system. Use <code>id -u</code> and
<code>id -g</code> to get these. This ensures that both the container and the host
user have write access to the consumption directory. If your UID
and GID on the host system is 1000 (the default for the first normal
user on most systems), it will work out of the box without any
modifications. Run <code>id "username"</code> to check.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>You can utilize Docker secrets for configuration settings by
appending <code>_FILE</code> to configuration values. For example <a href="../configuration/#PAPERLESS_DBUSER"><code>PAPERLESS_DBUSER</code></a>
can be set using <code>PAPERLESS_DBUSER_FILE=/var/run/secrets/password.txt</code>.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Some file systems such as NFS network shares don't support file
system notifications with <code>inotify</code>. When storing the consumption
directory on such a file system, paperless will not pick up new
files with the default configuration. You will need to use
<a href="../configuration/#PAPERLESS_CONSUMER_POLLING"><code>PAPERLESS_CONSUMER_POLLING</code></a>, which will disable inotify. See
<a href="../configuration/#polling">here</a>.</p>
</div>
</li>
<li>
<p>Run <code>docker compose pull</code>. This will pull the image from the GitHub container registry
by default but you can change the image to pull from Docker Hub by changing the <code>image</code>
line to <code>image: paperlessngx/paperless-ngx:latest</code>.</p>
</li>
<li>
<p>To be able to login, you will need a "superuser". To create it,
execute the following command:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-5-1" name="__codelineno-5-1" href="#__codelineno-5-1"></a><span class="go">docker compose run --rm webserver createsuperuser</span>
</code></pre></div>
<p>or using docker exec from within the container:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-6-1" name="__codelineno-6-1" href="#__codelineno-6-1"></a><span class="go">python3 manage.py createsuperuser</span>
</code></pre></div>
<p>This will guide you through the superuser setup.</p>
</li>
<li>
<p>Run <code>docker compose up -d</code>. This will create and start the necessary containers.</p>
</li>
<li>
<p>Congratulations! Your Paperless-ngx instance should now be accessible at <code>http://127.0.0.1:8000</code>
(or similar, depending on your configuration). Use the superuser credentials you have
created in the previous step to login.</p>
</li>
</ol>
<h3 id="docker_build">Build the Docker image yourself</h3>
<ol>
<li>
<p>Clone the entire repository of paperless:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-7-1" name="__codelineno-7-1" href="#__codelineno-7-1"></a><span class="go">git clone https://github.com/paperless-ngx/paperless-ngx</span>
</code></pre></div>
<p>The main branch always reflects the latest stable version.</p>
</li>
<li>
<p>Copy one of the <code>docker/compose/docker-compose.*.yml</code> to
<code>docker-compose.yml</code> in the root folder, depending on which database
backend you want to use. Copy <code>docker-compose.env</code> into the project
root as well.</p>
</li>
<li>
<p>In the <code>docker-compose.yml</code> file, find the line that instructs
Docker Compose to pull the paperless image from Docker Hub:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-8-1" name="__codelineno-8-1" href="#__codelineno-8-1"></a><span class="nt">webserver</span><span class="p">:</span>
<a id="__codelineno-8-2" name="__codelineno-8-2" href="#__codelineno-8-2"></a><span class="w"> </span><span class="nt">image</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">ghcr.io/paperless-ngx/paperless-ngx:latest</span>
</code></pre></div>
<p>and replace it with a line that instructs Docker Compose to build
the image from the current working directory instead:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-9-1" name="__codelineno-9-1" href="#__codelineno-9-1"></a><span class="nt">webserver</span><span class="p">:</span>
<a id="__codelineno-9-2" name="__codelineno-9-2" href="#__codelineno-9-2"></a><span class="w"> </span><span class="nt">build</span><span class="p">:</span>
<a id="__codelineno-9-3" name="__codelineno-9-3" href="#__codelineno-9-3"></a><span class="w"> </span><span class="nt">context</span><span class="p">:</span><span class="w"> </span><span class="l l-Scalar l-Scalar-Plain">.</span>
</code></pre></div>
</li>
<li>
<p>Follow the <a href="#docker">Docker setup</a> above except when asked to run
<code>docker compose pull</code> to pull the image, run</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-10-1" name="__codelineno-10-1" href="#__codelineno-10-1"></a><span class="go">docker compose build</span>
</code></pre></div>
<p>instead to build the image.</p>
</li>
</ol>
<h3 id="bare_metal">Bare Metal Route</h3>
<p>Paperless runs on linux only. The following procedure has been tested on
a minimal installation of Debian/Buster, which is the current stable
release at the time of writing. Windows is not and will never be
supported.</p>
<p>Paperless requires Python 3. At this time, 3.10 - 3.12 are tested versions.
Newer versions may work, but some dependencies may not fully support newer versions.
Support for older Python versions may be dropped as they reach end of life or as newer versions
are released, dependency support is confirmed, etc.</p>
<ol>
<li>
<p>Install dependencies. Paperless requires the following packages.</p>
<ul>
<li><code>python3</code></li>
<li><code>python3-pip</code></li>
<li><code>python3-dev</code></li>
<li><code>default-libmysqlclient-dev</code> for MariaDB</li>
<li><code>pkg-config</code> for mysqlclient (python dependency)</li>
<li><code>fonts-liberation</code> for generating thumbnails for plain text
files</li>
<li><code>imagemagick</code> &gt;= 6 for PDF conversion</li>
<li><code>gnupg</code> for handling encrypted documents</li>
<li><code>libpq-dev</code> for PostgreSQL</li>
<li><code>libmagic-dev</code> for mime type detection</li>
<li><code>mariadb-client</code> for MariaDB compile time</li>
<li><code>libzbar0</code> for barcode detection</li>
<li><code>poppler-utils</code> for barcode detection</li>
</ul>
<p>Use this list for your preferred package management:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-11-1" name="__codelineno-11-1" href="#__codelineno-11-1"></a>python3 python3-pip python3-dev imagemagick fonts-liberation gnupg libpq-dev default-libmysqlclient-dev pkg-config libmagic-dev libzbar0 poppler-utils
</code></pre></div>
<p>These dependencies are required for OCRmyPDF, which is used for text
recognition.</p>
<ul>
<li><code>unpaper</code></li>
<li><code>ghostscript</code></li>
<li><code>icc-profiles-free</code></li>
<li><code>qpdf</code></li>
<li><code>liblept5</code></li>
<li><code>libxml2</code></li>
<li><code>pngquant</code> (suggested for certain PDF image optimizations)</li>
<li><code>zlib1g</code></li>
<li><code>tesseract-ocr</code> &gt;= 4.0.0 for OCR</li>
<li><code>tesseract-ocr</code> language packs (<code>tesseract-ocr-eng</code>,
<code>tesseract-ocr-deu</code>, etc)</li>
</ul>
<p>Use this list for your preferred package management:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-12-1" name="__codelineno-12-1" href="#__codelineno-12-1"></a>unpaper ghostscript icc-profiles-free qpdf liblept5 libxml2 pngquant zlib1g tesseract-ocr
</code></pre></div>
<p>On Raspberry Pi, these libraries are required as well:</p>
<ul>
<li><code>libatlas-base-dev</code></li>
<li><code>libxslt1-dev</code></li>
<li><code>mime-support</code></li>
</ul>
<p>You will also need these for installing some of the python dependencies:</p>
<ul>
<li><code>build-essential</code></li>
<li><code>python3-setuptools</code></li>
<li><code>python3-wheel</code></li>
</ul>
<p>Use this list for your preferred package management:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-13-1" name="__codelineno-13-1" href="#__codelineno-13-1"></a>build-essential python3-setuptools python3-wheel
</code></pre></div>
</li>
<li>
<p>Install <code>redis</code> &gt;= 6.0 and configure it to start automatically.</p>
</li>
<li>
<p>Optional. Install <code>postgresql</code> and configure a database, user and
password for paperless. If you do not wish to use PostgreSQL,
MariaDB and SQLite are available as well.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>On bare-metal installations using SQLite, ensure the <a href="https://code.djangoproject.com/wiki/JSON1Extension">JSON1
extension</a> is
enabled. This is usually the case, but not always.</p>
</div>
</li>
<li>
<p>Create a system user with a new home folder under which you wish
to run paperless.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-14-1" name="__codelineno-14-1" href="#__codelineno-14-1"></a><span class="go">adduser paperless --system --home /opt/paperless --group</span>
</code></pre></div>
</li>
<li>
<p>Get the release archive from
<a href="https://github.com/paperless-ngx/paperless-ngx/releases">https://github.com/paperless-ngx/paperless-ngx/releases</a> for example with</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-15-1" name="__codelineno-15-1" href="#__codelineno-15-1"></a><span class="go">curl -O -L https://github.com/paperless-ngx/paperless-ngx/releases/download/v1.10.2/paperless-ngx-v1.10.2.tar.xz</span>
</code></pre></div>
<p>Extract the archive with</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-16-1" name="__codelineno-16-1" href="#__codelineno-16-1"></a><span class="go">tar -xf paperless-ngx-v1.10.2.tar.xz</span>
</code></pre></div>
<p>and copy the contents to the
home folder of the user you created before (<code>/opt/paperless</code>).</p>
<p>Optional: If you cloned the git repo, you will have to
compile the frontend yourself, see <a href="../development/#front-end-development">here</a>
and use the <code>build</code> step, not <code>serve</code>.</p>
</li>
<li>
<p>Configure paperless. See <a href="../configuration/">configuration</a> for details.
Edit the included <code>paperless.conf</code> and adjust the settings to your
needs. Required settings for getting
paperless running are:</p>
<ul>
<li><a href="../configuration/#PAPERLESS_REDIS"><code>PAPERLESS_REDIS</code></a> should point to your redis server, such as
<redis://localhost:6379>.</li>
<li><a href="../configuration/#PAPERLESS_DBENGINE"><code>PAPERLESS_DBENGINE</code></a> optional, and should be one of <code>postgres</code>,
<code>mariadb</code>, or <code>sqlite</code></li>
<li><a href="../configuration/#PAPERLESS_DBHOST"><code>PAPERLESS_DBHOST</code></a> should be the hostname on which your
PostgreSQL server is running. Do not configure this to use
SQLite instead. Also configure port, database name, user and
password as necessary.</li>
<li><a href="../configuration/#PAPERLESS_CONSUMPTION_DIR"><code>PAPERLESS_CONSUMPTION_DIR</code></a> should point to a folder which
paperless should watch for documents. You might want to have
this somewhere else. Likewise, <a href="../configuration/#PAPERLESS_DATA_DIR"><code>PAPERLESS_DATA_DIR</code></a> and
<a href="../configuration/#PAPERLESS_MEDIA_ROOT"><code>PAPERLESS_MEDIA_ROOT</code></a> define where paperless stores its data.
If you like, you can point both to the same directory.</li>
<li><a href="../configuration/#PAPERLESS_SECRET_KEY"><code>PAPERLESS_SECRET_KEY</code></a> should be a random sequence of
characters. It's used for authentication. Failure to do so
allows third parties to forge authentication credentials.</li>
<li><a href="../configuration/#PAPERLESS_URL"><code>PAPERLESS_URL</code></a> if you are behind a reverse proxy. This should
point to your domain. Please see
<a href="../configuration/">configuration</a> for more
information.</li>
</ul>
<p>Many more adjustments can be made to paperless, especially the OCR
part. The following options are recommended for everyone:</p>
<ul>
<li>Set <a href="../configuration/#PAPERLESS_OCR_LANGUAGE"><code>PAPERLESS_OCR_LANGUAGE</code></a> to the language most of your
documents are written in.</li>
<li>Set <a href="../configuration/#PAPERLESS_TIME_ZONE"><code>PAPERLESS_TIME_ZONE</code></a> to your local time zone.</li>
</ul>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Ensure your Redis instance <a href="https://redis.io/docs/getting-started/#securing-redis">is secured</a>.</p>
</div>
</li>
<li>
<p>Create the following directories if they are missing:</p>
<ul>
<li><code>/opt/paperless/media</code></li>
<li><code>/opt/paperless/data</code></li>
<li><code>/opt/paperless/consume</code></li>
</ul>
<p>Adjust as necessary if you configured different folders.
Ensure that the paperless user has write permissions for every one
of these folders with</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-17-1" name="__codelineno-17-1" href="#__codelineno-17-1"></a><span class="go">ls -l -d /opt/paperless/media</span>
</code></pre></div>
<p>If needed, change the owner with</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-18-1" name="__codelineno-18-1" href="#__codelineno-18-1"></a><span class="go">sudo chown paperless:paperless /opt/paperless/media</span>
<a id="__codelineno-18-2" name="__codelineno-18-2" href="#__codelineno-18-2"></a><span class="go">sudo chown paperless:paperless /opt/paperless/data</span>
<a id="__codelineno-18-3" name="__codelineno-18-3" href="#__codelineno-18-3"></a><span class="go">sudo chown paperless:paperless /opt/paperless/consume</span>
</code></pre></div>
</li>
<li>
<p>Install python requirements from the <code>requirements.txt</code> file.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-19-1" name="__codelineno-19-1" href="#__codelineno-19-1"></a><span class="go">sudo -Hu paperless pip3 install -r requirements.txt</span>
</code></pre></div>
<p>This will install all python dependencies in the home directory of
the new paperless user.</p>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>It is up to you if you wish to use a virtual environment or not for the Python
dependencies. This is an alternative to the above and may require adjusting
the example scripts to utilize the virtual environment paths</p>
</div>
</li>
<li>
<p>Go to <code>/opt/paperless/src</code>, and execute the following commands:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-20-1" name="__codelineno-20-1" href="#__codelineno-20-1"></a><span class="c1"># This creates the database schema.</span>
<a id="__codelineno-20-2" name="__codelineno-20-2" href="#__codelineno-20-2"></a>sudo<span class="w"> </span>-Hu<span class="w"> </span>paperless<span class="w"> </span>python3<span class="w"> </span>manage.py<span class="w"> </span>migrate
<a id="__codelineno-20-3" name="__codelineno-20-3" href="#__codelineno-20-3"></a>
<a id="__codelineno-20-4" name="__codelineno-20-4" href="#__codelineno-20-4"></a><span class="c1"># This creates your first paperless user</span>
<a id="__codelineno-20-5" name="__codelineno-20-5" href="#__codelineno-20-5"></a>sudo<span class="w"> </span>-Hu<span class="w"> </span>paperless<span class="w"> </span>python3<span class="w"> </span>manage.py<span class="w"> </span>createsuperuser
</code></pre></div>
</li>
<li>
<p>Optional: Test that paperless is working by executing</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-21-1" name="__codelineno-21-1" href="#__codelineno-21-1"></a><span class="c1"># Manually starts the webserver</span>
<a id="__codelineno-21-2" name="__codelineno-21-2" href="#__codelineno-21-2"></a>sudo<span class="w"> </span>-Hu<span class="w"> </span>paperless<span class="w"> </span>python3<span class="w"> </span>manage.py<span class="w"> </span>runserver
</code></pre></div>
<p>and pointing your browser to http://localhost:8000 if
accessing from the same devices on which paperless is installed.
If accessing from another machine, set up systemd services. You may need
to set <code>PAPERLESS_DEBUG=true</code> in order for the development server to work
normally in your browser.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>This is a development server which should not be used in production.
It is not audited for security and performance is inferior to
production ready web servers.</p>
</div>
<div class="admonition tip">
<p class="admonition-title">Tip</p>
<p>This will not start the consumer. Paperless does this in a separate
process.</p>
</div>
</li>
<li>
<p>Setup systemd services to run paperless automatically. You may use
the service definition files included in the <code>scripts</code> folder as a
starting point.</p>
<p>Paperless needs the <code>webserver</code> script to run the webserver, the
<code>consumer</code> script to watch the input folder, <code>taskqueue</code> for the
background workers used to handle things like document consumption
and the <code>scheduler</code> script to run tasks such as email checking at
certain times .</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>The <code>socket</code> script enables <code>gunicorn</code> to run on port 80 without
root privileges. For this you need to uncomment the
<code>Require=paperless-webserver.socket</code> in the <code>webserver</code> script
and configure <code>gunicorn</code> to listen on port 80 (see
<code>paperless/gunicorn.conf.py</code>).</p>
</div>
<p>You may need to adjust the path to the <code>gunicorn</code> executable. This
will be installed as part of the python dependencies, and is either
located in the <code>bin</code> folder of your virtual environment, or in
<code>~/.local/bin/</code> if no virtual environment is used.</p>
<p>These services rely on redis and optionally the database server, but
don't need to be started in any particular order. The example files
depend on redis being started. If you use a database server, you
should add additional dependencies.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>The included scripts run a <code>gunicorn</code> standalone server, which is
fine for running paperless. It does support SSL, however, the
documentation of GUnicorn states that you should use a proxy server
in front of gunicorn instead.</p>
<p>For instructions on how to use nginx for that,
<a href="https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx#nginx">see the wiki</a>.</p>
</div>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>If celery won't start (check with
<code>sudo systemctl status paperless-task-queue.service</code> for
paperless-task-queue.service and paperless-scheduler.service
) you need to change the path in the files. Example:
<code>ExecStart=/opt/paperless/.local/bin/celery --app paperless worker --loglevel INFO</code></p>
</div>
</li>
<li>
<p>Optional: Install a samba server and make the consumption folder
available as a network share.</p>
</li>
<li>
<p>Configure ImageMagick to allow processing of PDF documents. Most
distributions have this disabled by default, since PDF documents can
contain malware. If you don't do this, paperless will fall back to
ghostscript for certain steps such as thumbnail generation.</p>
<p>Edit <code>/etc/ImageMagick-6/policy.xml</code> and adjust</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-22-1" name="__codelineno-22-1" href="#__codelineno-22-1"></a>&lt;policy domain=&quot;coder&quot; rights=&quot;none&quot; pattern=&quot;PDF&quot; /&gt;
</code></pre></div>
<p>to</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-23-1" name="__codelineno-23-1" href="#__codelineno-23-1"></a>&lt;policy domain=&quot;coder&quot; rights=&quot;read|write&quot; pattern=&quot;PDF&quot; /&gt;
</code></pre></div>
</li>
<li>
<p>Optional: Install the
<a href="https://ocrmypdf.readthedocs.io/en/latest/jbig2.html">jbig2enc</a>
encoder. This will reduce the size of generated PDF documents.
You'll most likely need to compile this by yourself, because this
software has been patented until around 2017 and binary packages are
not available for most distributions.</p>
</li>
<li>
<p>Optional: If using the NLTK machine learning processing (see
<a href="../configuration/#PAPERLESS_ENABLE_NLTK"><code>PAPERLESS_ENABLE_NLTK</code></a> for details),
download the NLTK data for the Snowball
Stemmer, Stopwords and Punkt tokenizer to <code>/usr/share/nltk_data</code>. Refer to the <a href="https://www.nltk.org/data.html">NLTK
instructions</a> for details on how to
download the data.</p>
</li>
</ol>
<h1 id="migrating-to-paperless-ngx">Migrating to Paperless-ngx</h1>
<p>Migration is possible both from Paperless-ng or directly from the
'original' Paperless.</p>
<h2 id="migrating-from-paperless-ng">Migrating from Paperless-ng</h2>
<p>Paperless-ngx is meant to be a drop-in replacement for Paperless-ng and
thus upgrading should be trivial for most users, especially when using
docker. However, as with any major change, it is recommended to take a
full backup first. Once you are ready, simply change the docker image to
point to the new source. E.g. if using Docker Compose, edit
<code>docker-compose.yml</code> and change:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-24-1" name="__codelineno-24-1" href="#__codelineno-24-1"></a>image: jonaswinkler/paperless-ng:latest
</code></pre></div>
<p>to</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-25-1" name="__codelineno-25-1" href="#__codelineno-25-1"></a>image: ghcr.io/paperless-ngx/paperless-ngx:latest
</code></pre></div>
<p>and then run <code>docker compose up -d</code> which will pull the new image
recreate the container. That's it!</p>
<p>Users who installed with the bare-metal route should also update their
Git clone to point to <code>https://github.com/paperless-ngx/paperless-ngx</code>,
e.g. using the command
<code>git remote set-url origin https://github.com/paperless-ngx/paperless-ngx</code>
and then pull the latest version.</p>
<h2 id="migrating-from-paperless">Migrating from Paperless</h2>
<p>At its core, paperless-ngx is still paperless and fully compatible.
However, some things have changed under the hood, so you need to adapt
your setup depending on how you installed paperless.</p>
<p>This setup describes how to update an existing paperless Docker
installation. The important things to keep in mind are as follows:</p>
<ul>
<li>Read the <a href="../changelog/">changelog</a> and
take note of breaking changes.</li>
<li>You should decide if you want to stick with SQLite or want to
migrate your database to PostgreSQL. See <a href="#sqlite_to_psql">documentation</a>
for details on
how to move your data from SQLite to PostgreSQL. Both work fine with
paperless. However, if you already have a database server running
for other services, you might as well use it for paperless as well.</li>
<li>The task scheduler of paperless, which is used to execute periodic
tasks such as email checking and maintenance, requires a
<a href="https://redis.io/">redis</a> message broker instance. The
Docker Compose route takes care of that.</li>
<li>The layout of the folder structure for your documents and data
remains the same, so you can just plug your old docker volumes into
paperless-ngx and expect it to find everything where it should be.</li>
</ul>
<p>Migration to paperless-ngx is then performed in a few simple steps:</p>
<ol>
<li>
<p>Stop paperless.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-26-1" name="__codelineno-26-1" href="#__codelineno-26-1"></a><span class="nb">cd</span><span class="w"> </span>/path/to/current/paperless
<a id="__codelineno-26-2" name="__codelineno-26-2" href="#__codelineno-26-2"></a>docker<span class="w"> </span>compose<span class="w"> </span>down
</code></pre></div>
</li>
<li>
<p>Do a backup for two purposes: If something goes wrong, you still
have your data. Second, if you don't like paperless-ngx, you can
switch back to paperless.</p>
</li>
<li>
<p>Download the latest release of paperless-ngx. You can either go with
the Docker Compose files from
<a href="https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose">here</a>
or clone the repository to build the image yourself (see
<a href="#docker_build">above</a>). You can
either replace your current paperless folder or put paperless-ngx in
a different location.</p>
<div class="admonition warning">
<p class="admonition-title">Warning</p>
<p>Paperless-ngx includes a <code>.env</code> file. This will set the project name
for docker compose to <code>paperless</code>, which will also define the name
of the volumes by paperless-ngx. However, if you experience that
paperless-ngx is not using your old paperless volumes, verify the
names of your volumes with</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-27-1" name="__codelineno-27-1" href="#__codelineno-27-1"></a><span class="go">docker volume ls | grep _data</span>
</code></pre></div>
<p>and adjust the project name in the <code>.env</code> file so that it matches
the name of the volumes before the <code>_data</code> part.</p>
</div>
</li>
<li>
<p>Download the <code>docker-compose.sqlite.yml</code> file to
<code>docker-compose.yml</code>. If you want to switch to PostgreSQL, do that
after you migrated your existing SQLite database.</p>
</li>
<li>
<p>Adjust <code>docker-compose.yml</code> and <code>docker-compose.env</code> to your needs.
See <a href="#docker">Docker setup</a> details on
which edits are advised.</p>
</li>
<li>
<p><a href="../administration/#updating">Update paperless.</a></p>
</li>
<li>
<p>In order to find your existing documents with the new search
feature, you need to invoke a one-time operation that will create
the search index:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-28-1" name="__codelineno-28-1" href="#__codelineno-28-1"></a><span class="go">docker compose run --rm webserver document_index reindex</span>
</code></pre></div>
<p>This will migrate your database and create the search index. After
that, paperless will take care of maintaining the index by itself.</p>
</li>
<li>
<p>Start paperless-ngx.</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-29-1" name="__codelineno-29-1" href="#__codelineno-29-1"></a>docker<span class="w"> </span>compose<span class="w"> </span>up<span class="w"> </span>-d
</code></pre></div>
<p>This will run paperless in the background and automatically start it
on system boot.</p>
</li>
<li>
<p>Paperless installed a permanent redirect to <code>admin/</code> in your
browser. This redirect is still in place and prevents access to the
new UI. Clear your browsing cache in order to fix this.</p>
</li>
<li>
<p>Optionally, follow the instructions below to migrate your existing
data to PostgreSQL.</p>
</li>
</ol>
<h2 id="migrating-from-linuxserverio-docker-image">Migrating from LinuxServer.io Docker Image</h2>
<p>As with any upgrades and large changes, it is highly recommended to
create a backup before starting. This assumes the image was running
using Docker Compose, but the instructions are translatable to Docker
commands as well.</p>
<ol>
<li>Stop and remove the paperless container</li>
<li>If using an external database, stop the container</li>
<li>
<p>Update Redis configuration</p>
<ol>
<li>
<p>If <code>REDIS_URL</code> is already set, change it to <a href="../configuration/#PAPERLESS_REDIS"><code>PAPERLESS_REDIS</code></a>
and continue to step 4.</p>
</li>
<li>
<p>Otherwise, in the <code>docker-compose.yml</code> add a new service for
Redis, following <a href="https://github.com/paperless-ngx/paperless-ngx/tree/main/docker/compose">the example compose
files</a></p>
</li>
<li>
<p>Set the environment variable <a href="../configuration/#PAPERLESS_REDIS"><code>PAPERLESS_REDIS</code></a> so it points to
the new Redis container</p>
</li>
</ol>
</li>
<li>
<p>Update user mapping</p>
<ol>
<li>
<p>If set, change the environment variable <code>PUID</code> to <code>USERMAP_UID</code></p>
</li>
<li>
<p>If set, change the environment variable <code>PGID</code> to <code>USERMAP_GID</code></p>
</li>
</ol>
</li>
<li>
<p>Update configuration paths</p>
<ol>
<li>Set the environment variable <a href="../configuration/#PAPERLESS_DATA_DIR"><code>PAPERLESS_DATA_DIR</code></a> to <code>/config</code></li>
</ol>
</li>
<li>
<p>Update media paths</p>
<ol>
<li>Set the environment variable <a href="../configuration/#PAPERLESS_MEDIA_ROOT"><code>PAPERLESS_MEDIA_ROOT</code></a> to
<code>/data/media</code></li>
</ol>
</li>
<li>
<p>Update timezone</p>
<ol>
<li>Set the environment variable <a href="../configuration/#PAPERLESS_TIME_ZONE"><code>PAPERLESS_TIME_ZONE</code></a> to the same
value as <code>TZ</code></li>
</ol>
</li>
<li>
<p>Modify the <code>image:</code> to point to
<code>ghcr.io/paperless-ngx/paperless-ngx:latest</code> or a specific version
if preferred.</p>
</li>
<li>Start the containers as before, using <code>docker compose</code>.</li>
</ol>
<h2 id="sqlite_to_psql">Moving data from SQLite to PostgreSQL or MySQL/MariaDB</h2>
<p>The best way to migrate between database types is to perform an <a href="../administration/#exporter">export</a> and then
<a href="../administration/#importer">import</a> into a clean installation of Paperless-ngx.</p>
<h2 id="moving-back-to-paperless">Moving back to Paperless</h2>
<p>Lets say you migrated to Paperless-ngx and used it for a while, but
decided that you don't like it and want to move back (If you do, send
me a mail about what part you didn't like!), you can totally do that
with a few simple steps.</p>
<p>Paperless-ngx modified the database schema slightly, however, these
changes can be reverted while keeping your current data, so that your
current data will be compatible with original Paperless. Thumbnails
were also changed from PNG to WEBP format and will need to be
re-generated.</p>
<p>Execute this:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-30-1" name="__codelineno-30-1" href="#__codelineno-30-1"></a><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>/path/to/paperless
<a id="__codelineno-30-2" name="__codelineno-30-2" href="#__codelineno-30-2"></a><span class="gp">$ </span>docker<span class="w"> </span>compose<span class="w"> </span>run<span class="w"> </span>--rm<span class="w"> </span>webserver<span class="w"> </span>migrate<span class="w"> </span>documents<span class="w"> </span><span class="m">0023</span>
</code></pre></div>
<p>Or without docker:</p>
<div class="highlight"><pre><span></span><code><a id="__codelineno-31-1" name="__codelineno-31-1" href="#__codelineno-31-1"></a><span class="gp">$ </span><span class="nb">cd</span><span class="w"> </span>/path/to/paperless/src
<a id="__codelineno-31-2" name="__codelineno-31-2" href="#__codelineno-31-2"></a><span class="gp">$ </span>python3<span class="w"> </span>manage.py<span class="w"> </span>migrate<span class="w"> </span>documents<span class="w"> </span><span class="m">0023</span>
</code></pre></div>
<p>After regenerating thumbnails, you'll need to clear your cookies
(Paperless-ngx comes with updated dependencies that do cookie-processing
differently) and probably your cache as well.</p>
<h1 id="less-powerful-devices">Considerations for less powerful devices</h1>
<p>Paperless runs on Raspberry Pi. However, some things are rather slow on
the Pi and configuring some options in paperless can help improve
performance immensely:</p>
<ul>
<li>Stick with SQLite to save some resources. See <a href="../troubleshooting/#log-reports-creating-paperlesstask-failed">troubleshooting</a>
if you encounter issues with SQLite locking.</li>
<li>Consider setting <a href="../configuration/#PAPERLESS_OCR_PAGES"><code>PAPERLESS_OCR_PAGES</code></a> to 1, so that paperless will
only OCR the first page of your documents. In most cases, this page
contains enough information to be able to find it.</li>
<li><a href="../configuration/#PAPERLESS_TASK_WORKERS"><code>PAPERLESS_TASK_WORKERS</code></a> and <a href="../configuration/#PAPERLESS_THREADS_PER_WORKER"><code>PAPERLESS_THREADS_PER_WORKER</code></a> are
configured to use all cores. The Raspberry Pi models 3 and up have 4
cores, meaning that paperless will use 2 workers and 2 threads per
worker. This may result in sluggish response times during
consumption, so you might want to lower these settings (example: 2
workers and 1 thread to always have some computing power left for
other tasks).</li>
<li>Keep <a href="../configuration/#PAPERLESS_OCR_MODE"><code>PAPERLESS_OCR_MODE</code></a> at its default value <code>skip</code> and consider
OCR'ing your documents before feeding them into paperless. Some
scanners are able to do this!</li>
<li>Set <a href="../configuration/#PAPERLESS_OCR_SKIP_ARCHIVE_FILE"><code>PAPERLESS_OCR_SKIP_ARCHIVE_FILE</code></a> to <code>with_text</code> to skip archive
file generation for already ocr'ed documents, or <code>always</code> to skip it
for all documents.</li>
<li>If you want to perform OCR on the device, consider using
<code>PAPERLESS_OCR_CLEAN=none</code>. This will speed up OCR times and use
less memory at the expense of slightly worse OCR results.</li>
<li>If using docker, consider setting <a href="../configuration/#PAPERLESS_WEBSERVER_WORKERS"><code>PAPERLESS_WEBSERVER_WORKERS</code></a> to 1. This will save some memory.</li>
<li>Consider setting <a href="../configuration/#PAPERLESS_ENABLE_NLTK"><code>PAPERLESS_ENABLE_NLTK</code></a> to false, to disable the
more advanced language processing, which can take more memory and
processing time.</li>
</ul>
<p>For details, refer to <a href="../configuration/">configuration</a>.</p>
<div class="admonition note">
<p class="admonition-title">Note</p>
<p>Updating the
<a href="../advanced_usage/#automatic-matching">automatic matching algorithm</a> takes quite a bit of time. However, the update mechanism
checks if your data has changed before doing the heavy lifting. If you
experience the algorithm taking too much cpu time, consider changing the
schedule in the admin interface to daily. You can also manually invoke
the task by changing the date and time of the next run to today/now.</p>
<p>The actual matching of the algorithm is fast and works on Raspberry Pi
as well as on any other device.</p>
</div>
<h1 id="nginx">Using nginx as a reverse proxy</h1>
<p>Please see <a href="https://github.com/paperless-ngx/paperless-ngx/wiki/Using-a-Reverse-Proxy-with-Paperless-ngx#nginx">the wiki</a> for user-maintained documentation of using nginx with Paperless-ngx.</p>
<h1 id="security">Enhancing security</h1>
<p>Please see <a href="https://github.com/paperless-ngx/paperless-ngx/wiki/Using-Security-Tools-with-Paperless-ngx">the wiki</a> for user-maintained documentation of how to configure security tools like Fail2ban with Paperless-ngx.</p>
</article>
</div>
<script>var target=document.getElementById(location.hash.slice(1));target&&target.name&&(target.checked=target.name.startsWith("__tabbed_"))</script>
</div>
<button type="button" class="md-top md-icon" data-md-component="top" hidden>
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M13 20h-2V8l-5.5 5.5-1.42-1.42L12 4.16l7.92 7.92-1.42 1.42L13 8z"/></svg>
Back to top
</button>
</main>
<footer class="md-footer">
<div class="md-footer-meta md-typeset">
<div class="md-footer-meta__inner md-grid">
<div class="md-copyright">
<div class="md-copyright__highlight">
Copyright &copy; 2016 - 2023 Daniel Quinn, Jonas Winkler, and the Paperless-ngx team
</div>
Made with
<a href="https://squidfunk.github.io/mkdocs-material/" target="_blank" rel="noopener">
Material for MkDocs
</a>
</div>
<div class="md-social">
<a href="https://github.com/paperless-ngx/paperless-ngx" target="_blank" rel="noopener" title="github.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 496 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M165.9 397.4c0 2-2.3 3.6-5.2 3.6-3.3.3-5.6-1.3-5.6-3.6 0-2 2.3-3.6 5.2-3.6 3-.3 5.6 1.3 5.6 3.6m-31.1-4.5c-.7 2 1.3 4.3 4.3 4.9 2.6 1 5.6 0 6.2-2s-1.3-4.3-4.3-5.2c-2.6-.7-5.5.3-6.2 2.3m44.2-1.7c-2.9.7-4.9 2.6-4.6 4.9.3 2 2.9 3.3 5.9 2.6 2.9-.7 4.9-2.6 4.6-4.6-.3-1.9-3-3.2-5.9-2.9M244.8 8C106.1 8 0 113.3 0 252c0 110.9 69.8 205.8 169.5 239.2 12.8 2.3 17.3-5.6 17.3-12.1 0-6.2-.3-40.4-.3-61.4 0 0-70 15-84.7-29.8 0 0-11.4-29.1-27.8-36.6 0 0-22.9-15.7 1.6-15.4 0 0 24.9 2 38.6 25.8 21.9 38.6 58.6 27.5 72.9 20.9 2.3-16 8.8-27.1 16-33.7-55.9-6.2-112.3-14.3-112.3-110.5 0-27.5 7.6-41.3 23.6-58.9-2.6-6.5-11.1-33.3 2.6-67.9 20.9-6.5 69 27 69 27 20-5.6 41.5-8.5 62.8-8.5s42.8 2.9 62.8 8.5c0 0 48.1-33.6 69-27 13.7 34.7 5.2 61.4 2.6 67.9 16 17.7 25.8 31.5 25.8 58.9 0 96.5-58.9 104.2-114.8 110.5 9.2 7.9 17 22.9 17 46.4 0 33.7-.3 75.4-.3 83.6 0 6.5 4.6 14.4 17.3 12.1C428.2 457.8 496 362.9 496 252 496 113.3 383.5 8 244.8 8M97.2 352.9c-1.3 1-1 3.3.7 5.2 1.6 1.6 3.9 2.3 5.2 1 1.3-1 1-3.3-.7-5.2-1.6-1.6-3.9-2.3-5.2-1m-10.8-8.1c-.7 1.3.3 2.9 2.3 3.9 1.6 1 3.6.7 4.3-.7.7-1.3-.3-2.9-2.3-3.9-2-.6-3.6-.3-4.3.7m32.4 35.6c-1.6 1.3-1 4.3 1.3 6.2 2.3 2.3 5.2 2.6 6.5 1 1.3-1.3.7-4.3-1.3-6.2-2.2-2.3-5.2-2.6-6.5-1m-11.4-14.7c-1.6 1-1.6 3.6 0 5.9s4.3 3.3 5.6 2.3c1.6-1.3 1.6-3.9 0-6.2-1.4-2.3-4-3.3-5.6-2"/></svg>
</a>
<a href="https://hub.docker.com/r/paperlessngx/paperless-ngx" target="_blank" rel="noopener" title="hub.docker.com" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 640 512"><!--! Font Awesome Free 6.7.2 by @fontawesome - https://fontawesome.com License - https://fontawesome.com/license/free (Icons: CC BY 4.0, Fonts: SIL OFL 1.1, Code: MIT License) Copyright 2024 Fonticons, Inc.--><path d="M349.9 236.3h-66.1v-59.4h66.1zm0-204.3h-66.1v60.7h66.1zm78.2 144.8H362v59.4h66.1zm-156.3-72.1h-66.1v60.1h66.1zm78.1 0h-66.1v60.1h66.1zm276.8 100c-14.4-9.7-47.6-13.2-73.1-8.4-3.3-24-16.7-44.9-41.1-63.7l-14-9.3-9.3 14c-18.4 27.8-23.4 73.6-3.7 103.8-8.7 4.7-25.8 11.1-48.4 10.7H2.4c-8.7 50.8 5.8 116.8 44 162.1 37.1 43.9 92.7 66.2 165.4 66.2 157.4 0 273.9-72.5 328.4-204.2 21.4.4 67.6.1 91.3-45.2 1.5-2.5 6.6-13.2 8.5-17.1zm-511.1-27.9h-66v59.4h66.1v-59.4zm78.1 0h-66.1v59.4h66.1zm78.1 0h-66.1v59.4h66.1zm-78.1-72.1h-66.1v60.1h66.1z"/></svg>
</a>
<a href="https://matrix.to/#/#paperless:matrix.org" target="_blank" rel="noopener" title="matrix.to" class="md-social__link">
<svg xmlns="http://www.w3.org/2000/svg" viewBox="0 0 24 24"><path d="M12 3c5.5 0 10 3.58 10 8s-4.5 8-10 8c-1.24 0-2.43-.18-3.53-.5C5.55 21 2 21 2 21c2.33-2.33 2.7-3.9 2.75-4.5C3.05 15.07 2 13.13 2 11c0-4.42 4.5-8 10-8"/></svg>
</a>
</div>
</div>
</div>
</footer>
</div>
<div class="md-dialog" data-md-component="dialog">
<div class="md-dialog__inner md-typeset"></div>
</div>
<script id="__config" type="application/json">{"base": "..", "features": ["navigation.tabs", "navigation.top", "toc.integrate", "content.code.annotate"], "search": "../assets/javascripts/workers/search.f8cc74c7.min.js", "translations": {"clipboard.copied": "Copied to clipboard", "clipboard.copy": "Copy to clipboard", "search.result.more.one": "1 more on this page", "search.result.more.other": "# more on this page", "search.result.none": "No matching documents", "search.result.one": "1 matching document", "search.result.other": "# matching documents", "search.result.placeholder": "Type to start searching", "search.result.term.missing": "Missing", "select.version": "Select version"}}</script>
<script src="../assets/javascripts/bundle.60a45f97.min.js"></script>
<script id="init-glightbox">const lightbox = GLightbox({"touchNavigation": true, "loop": false, "zoomable": true, "draggable": true, "openEffect": "zoom", "closeEffect": "zoom", "slideEffect": "slide"});
document$.subscribe(() => { lightbox.reload() });
</script></body>
</html>
Reference in New Issue View Git Blame Copy Permalink