kevinkdev/paperless-ngx repository overview

⁠Overview:

This repository is a fork of the archived repository from linuxserver.io, in order to maintain an updated version of the Paperless-Ngx Docker image. Due to its deprecation on linuxserver.io, I have taken the initiative to ensure the continued availability and enhancement of the Paperless-Ngx image.

⁠Why this Repository?

With the original repository being archived, the Paperless-Ngx image faced potential obsolescence. This repository addresses that concern by actively curating and updating the Docker image, ensuring users have access to the latest features, improvements, and security updates.

⁠Contributions

Contributions from the community are highly encouraged! Whether you're reporting issues, suggesting improvements, or submitting pull requests, your involvement is crucial to the ongoing success of this repository.

Paperless-ngx⁠ 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

Simply pulling kevinkdev/paperless-ngx: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:

⁠Application Setup

Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT⁠ More info at paperless-ngx⁠. 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

Here are some example snippets to help you get started creating a container.

⁠docker-compose

---
version: "2.1"
services:
  paperless-ngx:
    image: kevinkdev/paperless-ngx:latest
    container_name: paperless-ngx
    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 cli (click here for more info⁠)

docker run -d \
  --name=paperless-ngx \
  -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 \
  kevinkdev/paperless-ngx:latest

⁠Parameters

Container 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.

⁠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)

⁠Via Docker Compose

• Update all images: docker-compose pull
  • or update a single image: docker-compose pull paperless-ngx
• Let compose update all containers as necessary: docker-compose up -d
  • or update a single container: docker-compose up -d paperless-ngx
• You can also remove the old dangling images: docker image prune

⁠Via Docker Run

• Update the image: docker pull kevinkdev/paperless-ngx:latest
• Stop the running container: docker stop paperless-ngx
• Delete the container: docker rm paperless-ngx
• Recreate a new container with the same docker run parameters as instructed above (if mapped correctly to a host folder, your /config folder and settings will be preserved)
• You can also remove the old dangling images: docker image prune

⁠Via Watchtower auto-updater (only use if you don't remember the original parameters)

• Pull the latest image at its tag and replace it with the same env variables in one run:

  docker run --rm \
  -v /var/run/docker.sock:/var/run/docker.sock \
  containrrr/watchtower \
  --run-once paperless-ngx
  

  Copy

• You can also remove the old dangling images: docker image prune

Note: We do not endorse the use of Watchtower as a solution to automated updates of existing Docker containers. In fact we generally discourage automated updates. However, this is a useful tool for one-time manual updates of containers where you have forgotten the original parameters.

⁠Image Update Notifications - Diun (Docker Image Update Notifier)

• We recommend Diun⁠ for update notifications. Other tools that automatically update containers unattended are not recommended or supported.

⁠Building locally

If you want to make local modifications to these images for development purposes or just to customize the logic:

git clone https://github.com/kevinkdev/docker-paperless-ngx.git
cd docker-paperless-ngx
docker build \
  --no-cache \
  --pull \
  -t kevinkdev/paperless-ngx:latest .

The ARM variants can be built on x86_64 hardware using multiarch/qemu-user-static

docker run --rm --privileged multiarch/qemu-user-static:register --reset

Once registered you can define the dockerfile to use with -f Dockerfile.aarch64.

⁠Disclaimer

Please note that this repository is not affiliated with linuxserver.io. It solely exists to ensure the continued development and support of the Paperless-Ngx Docker image.