kopia lustrzana https://github.com/linuxserver/docker-documentation
183 wiersze
9.6 KiB
Markdown
Executable File
183 wiersze
9.6 KiB
Markdown
Executable File
---
|
|
title: papermerge
|
|
---
|
|
<!-- DO NOT EDIT THIS FILE MANUALLY -->
|
|
<!-- Please read the https://github.com/linuxserver/docker-papermerge/blob/master/.github/CONTRIBUTING.md -->
|
|
|
|
# DEPRECATION NOTICE
|
|
|
|
This image is deprecated. We will not offer support for this image and it will not be updated.
|
|
The last working tag is:
|
|
v2.0.1-ls60
|
|
We recommend the official image instead:
|
|
https://hub.docker.com/r/papermerge/papermerge
|
|
|
|
# [linuxserver/papermerge](https://github.com/linuxserver/docker-papermerge)
|
|
|
|
[](https://scarf.sh/gateway/linuxserver-ci/docker/linuxserver%2Fpapermerge)
|
|
[](https://github.com/linuxserver/docker-papermerge)
|
|
[](https://github.com/linuxserver/docker-papermerge/releases)
|
|
[](https://github.com/linuxserver/docker-papermerge/packages)
|
|
[](https://gitlab.com/linuxserver.io/docker-papermerge/container_registry)
|
|
[](https://quay.io/repository/linuxserver.io/papermerge)
|
|
[](https://hub.docker.com/r/linuxserver/papermerge)
|
|
[](https://hub.docker.com/r/linuxserver/papermerge)
|
|
[](https://ci.linuxserver.io/job/Docker-Pipeline-Builders/job/docker-papermerge/job/master/)
|
|
[](https://ci-tests.linuxserver.io/linuxserver/papermerge/latest/index.html)
|
|
|
|
[Papermerge](https://www.papermerge.com/) 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](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/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](https://www.papermerge.com/).
|
|
|
|
If you need non-English OCR language support, you can use [this mod](https://github.com/linuxserver/docker-mods/tree/papermerge-multilangocr).
|
|
|
|
## 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:
|
|
papermerge:
|
|
image: lscr.io/linuxserver/papermerge:latest
|
|
container_name: papermerge
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=Etc/UTC
|
|
- 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=papermerge \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=Etc/UTC \
|
|
-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=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
|
|
| `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
|
|
|
|
| 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=papermerge "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 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.02.23:** - Deprecate image.
|
|
* **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.
|