Search…
Images
linuxserver/papermerge
Papermerge is an open source document management system (DMS) primarily designed for archiving and retrieving your digital documents. Instead of having piles of paper documents all over your desk, office or drawers - you can quickly scan them and configure your scanner to directly upload to Papermerge DMS."

Supported Architectures

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/papermerge:latest 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
Available
Tag
x86-64
amd64-<version tag>
arm64
arm64v8-<version tag>
armhf
arm32v7-<version tag>

Application Setup

Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT More info at papermerge.
If you need non-English OCR language support, you can use this mod.

Usage

To help you get started creating a container from this image you can either use docker-compose or the docker cli.
---
version: "2.1"
services:
papermerge:
image: lscr.io/linuxserver/papermerge:latest
container_name: papermerge
environment:
- PUID=1000
- PGID=1000
- TZ=America/New_York
- REDIS_URL= #optional
volumes:
- </path/to/appdata/config>:/config
- </path/to/appdata/data>:/data
ports:
- 8000:8000
restart: unless-stopped
docker run -d \
--name=papermerge \
-e PUID=1000 \
-e PGID=1000 \
-e TZ=America/New_York \
-e REDIS_URL= `#optional` \
-p 8000:8000 \
-v </path/to/appdata/config>:/config \
-v </path/to/appdata/data>:/data \
--restart unless-stopped \
lscr.io/linuxserver/papermerge:latest

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 papermerge 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:
-e FILE__PASSWORD=/run/secrets/mysecretpassword
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:
$ id username
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)

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 papermerge /bin/bash
  • To monitor the logs of the container in realtime:
    • docker logs -f papermerge
  • Container version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' papermerge
  • Image version number
    • docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/papermerge:latest

Versions

  • 15.07.22: - Don't install development python packages
  • 13.04.21: - Handle upstream stapler change
  • 13.03.21: - Fixed mglib dependency per issue 32
  • 25.02.21: - Updated dependencies for v2
  • 07.02.21: - Support external MySQL/PSQL DBs.
  • 01.02.21: - Add redis.
  • 09.12.20: - Fix locales.
  • 08.08.20: - Initial Release.
Copy link
On this page
linuxserver/papermerge
Supported Architectures
Application Setup
Usage
Parameters
Environment variables from files (Docker secrets)
Umask for running applications
User / Group Identifiers
Docker Mods
Support Info
Versions