kopia lustrzana https://github.com/linuxserver/docker-documentation
181 wiersze
10 KiB
Markdown
181 wiersze
10 KiB
Markdown
|
---
|
||
|
|
title: paperless-ngx
|
||
|
|
---
|
||
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
||
|
|
<!-- Please read the https://github.com/linuxserver/docker-paperless-ngx/blob/main/.github/CONTRIBUTING.md -->
|
||
|
|
|
||
|
|
# DEPRECATION NOTICE
|
||
|
|
|
||
|
|
This image is deprecated. We will not offer support for this image and it will not be updated.
|
||
|
|
We recommend switching to the new official container:
|
||
|
|
https://github.com/paperless-ngx/paperless-ngx
|
||
|
|
|
||
|
|
# [linuxserver/paperless-ngx](https://github.com/linuxserver/docker-paperless-ngx)
|
||
|
|
|
||
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fpaperless-ngx)
|
||
|
|
[](https://github.com/linuxserver/docker-paperless-ngx)
|
||
|
|
[](https://github.com/linuxserver/docker-paperless-ngx/releases)
|
||
|
|
[](https://github.com/linuxserver/docker-paperless-ngx/packages)
|
||
|
|
[](https://gitlab.com/linuxserver.io/docker-paperless-ngx/container_registry)
|
||
|
|
[](https://quay.io/repository/linuxserver.io/paperless-ngx)
|
||
|
|
[](https://hub.docker.com/r/linuxserver/paperless-ngx)
|
||
|
|
[](https://hub.docker.com/r/linuxserver/paperless-ngx)
|
||
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-paperless-ngx/job/main/)
|
||
|
|
[](https://ci-tests.linuxserver.io/linuxserver/paperless-ngx/latest/index.html)
|
||
|
|
|
||
|
|
[Paperless-ngx](https://github.com/paperless-ngx/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
|
||
|
|
|
||
|
|
We utilise the docker manifest for multi-platform awareness. More information is available from docker [here](https://github.com/docker/distribution/blob/master/docs/spec/manifest-v2-2.md#manifest-list) and our announcement [here](https://blog.linuxserver.io/2019/02/21/the-lsio-pipeline-project/).
|
||
|
|
|
||
|
|
Simply pulling `lscr.io/linuxserver/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:
|
||
|
|
|
||
|
|
| 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 [paperless-ngx](https://github.com/paperless-ngx/paperless-ngx).
|
||
|
|
For convenience this container provides an alias to perform administration management commands. Available administration commands are documented upstream [here](https://paperless-ng.readthedocs.io/en/latest/administration.html) 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](https://docs.linuxserver.io/general/docker-compose))
|
||
|
|
|
||
|
|
```yaml
|
||
|
|
---
|
||
|
|
version: "2.1"
|
||
|
|
services:
|
||
|
|
paperless-ngx:
|
||
|
|
image: lscr.io/linuxserver/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](https://docs.docker.com/engine/reference/commandline/cli/))
|
||
|
|
|
||
|
|
```bash
|
||
|
|
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 \
|
||
|
|
lscr.io/linuxserver/paperless-ngx: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 paperless-ngx data files. |
|
||
|
|
|
||
|
|
#### Miscellaneous Options
|
||
|
|
|
||
|
|
| Parameter | Function |
|
||
|
|
| :-----: | --- |
|
||
|
|
|
||
|
|
## Environment variables from files (Docker secrets)
|
||
|
|
|
||
|
|
You can set any environment variable from a file by using a special prepend `FILE__`.
|
||
|
|
|
||
|
|
As an example:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
-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](https://en.wikipedia.org/wiki/Umask) 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:
|
||
|
|
|
||
|
|
```bash
|
||
|
|
$ id username
|
||
|
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
||
|
|
```
|
||
|
|
|
||
|
|
## Docker Mods
|
||
|
|
|
||
|
|
[](https://mods.linuxserver.io/?mod=paperless-ngx "view available mods for this container.") [](https://mods.linuxserver.io/?mod=universal "view available universal mods.")
|
||
|
|
|
||
|
|
We publish various [Docker Mods](https://github.com/linuxserver/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-ngx /bin/bash`
|
||
|
|
* To monitor the logs of the container in realtime:
|
||
|
|
* `docker logs -f paperless-ngx`
|
||
|
|
* Container version number
|
||
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' paperless-ngx`
|
||
|
|
* Image version number
|
||
|
|
* `docker inspect -f '{{ index .Config.Labels "build_version" }}' lscr.io/linuxserver/paperless-ngx:latest`
|
||
|
|
|
||
|
|
## Versions
|
||
|
|
|
||
|
|
* **05.09.22:** - Deprecate.
|
||
|
|
* **16.05.22:** - Add correct libqpdf.so to arm builds.
|
||
|
|
* **14.05.22:** - Fine tune disabling of redis.
|
||
|
|
* **12.05.22:** - Move migrations to after multilangocr mod. Fix disabling of redis. Add missing dep for postgresql.
|
||
|
|
* **12.05.22:** - Utilize lsio wheel for pikepdf.
|
||
|
|
* **11.05.22:** - Update upstream artifact name and utilize lsio wheels for scipy and scikit-learn.
|
||
|
|
* **05.05.22:** - Add runtime dependencies libxslt1.1 for armhf
|
||
|
|
* **30.04.22:** - Add runtime dependencies lizbar and poppler-utils
|
||
|
|
* **27.04.22:** - Add build-dependencies for arm32 builds.
|
||
|
|
* **11.04.22:** - Replaced uwsgi with gunicorn due to websocket issues.
|
||
|
|
* **11.03.22:** - Initial Release.
|