linuxserver/paperless-ng

​linuxserver/paperless-ng​
​​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​ ​
​​
​Paperless-ng is an application by Daniel Quinn and contributors that indexes your scanned documents and allows you to easily search for documents and store metadata alongside your documents."
Supported Architectures
Our images support multiple architectures such as x86-64, arm64 and armhf. We utilise the docker manifest for multi-platform awareness. More information is available from docker here and our announcement here.
Simply pulling lscr.io/linuxserver/paperless-ng should retrieve the correct image for your arch, but you can also pull specific arch images via tags.
The architectures supported by this image are:
Architecture
Tag
x86-64
amd64-latest
arm64
arm64v8-latest
armhf
arm32v7-latest
Application Setup
Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT More info at paperless-ng. For convenience this container provides an alias to perform administration management commands. Available administration commands are documented upstream here and can be accessed with this container thus: docker exec -it <container_name> manage <command>. For example, docker exec -it paperless manage document_retagger -tT.
Usage
To help you get started creating a container from this image you can either use docker-compose or the docker cli.
docker-compose (recommended, click here for more info)
1
---
2
version: "2.1"
3
services:
4
  paperless-ng:
5
    image: lscr.io/linuxserver/paperless-ng
6
    container_name: paperless-ng
7
    environment:
8
      - PUID=1000
9
      - PGID=1000
10
      - TZ=America/New_York
11
      - REDIS_URL= #optional
12
    volumes:
13
      - </path/to/appdata/config>:/config
14
      - </path/to/appdata/data>:/data
15
    ports:
16
      - 8000:8000
17
    restart: unless-stopped
Copied!
docker cli (click here for more info)
1
docker run -d \
2
  --name=paperless-ng \
3
  -e PUID=1000 \
4
  -e PGID=1000 \
5
  -e TZ=America/New_York \
6
  -e REDIS_URL= `#optional` \
7
  -p 8000:8000 \
8
  -v </path/to/appdata/config>:/config \
9
  -v </path/to/appdata/data>:/data \
10
  --restart unless-stopped \
11
  lscr.io/linuxserver/paperless-ng
Copied!
Parameters
Docker images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate <external>:<internal> respectively. For example, -p 8080:80 would expose port 80 from inside the container to be accessible from the host's IP on port 8080 outside the container.
Ports (-p)
Parameter
Function
8000
http gui
Environment Variables (-e)
Env
Function
PUID=1000
for UserID - see below for explanation
PGID=1000
for GroupID - see below for explanation
TZ=America/New_York
Specify a timezone to use EG America/New_York
REDIS_URL=
Specify an external redis instance to use. Can optionally include a port (redis:6379) and/or db (redis/foo). If left blank or not included, will use a built-in redis instance. If changed after initial setup will also require manual modification of /config/settings.py
Volume Mappings (-v)
Volume
Function
/config
Contains all relevant configuration files.
/data
Storage location for all paperless-ng data files.
Miscellaneous Options
Environment variables from files (Docker secrets)
You can set any environment variable from a file by using a special prepend FILE__.
As an example:
1
-e FILE__PASSWORD=/run/secrets/mysecretpassword
Copied!
Will set the environment variable PASSWORD based on the contents of the /run/secrets/mysecretpassword file.
Umask for running applications
For all of our images we provide the ability to override the default umask settings for services started within the containers using the optional -e UMASK=022 setting. Keep in mind umask is not chmod it subtracts from permissions based on it's value it does not add. Please read up here before asking for support.
User / Group Identifiers
When using volumes (-v flags), permissions issues can arise between the host OS and the container, we avoid this issue by allowing you to specify the user PUID and group PGID.
Ensure any volume directories on the host are owned by the same user you specify and any permissions issues will vanish like magic.
In this instance PUID=1000 and PGID=1000, to find yours use id user as below:
1
  $ id username
2
    uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
Copied!
Docker Mods
​​
​ ​
​​
We publish various Docker Mods to enable additional functionality within the containers. The list of Mods available for this image (if any) as well as universal mods that can be applied to any one of our images can be accessed via the dynamic badges above.
Support Info
Shell access whilst the container is running:
docker exec -it paperless-ng /bin/bash
To monitor the logs of the container in realtime:
docker logs -f paperless-ng
Container version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' paperless-ng
Image version number
docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/paperless-ng
Versions
07.10.21: - Fixed variable that determins if we should run redis locally.
01.10.21: - Replaced uwsgi with gunicorn due to websocket issues.
24.07.21: - Fixed directory config files (sqlite db) is all stored.
23.07.21: - Fixed initial user creation.
10.07.21: - Initial Release.