Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/linuxserver/docker-papermerge
https://github.com/linuxserver/docker-papermerge
Last synced: about 2 months ago
JSON representation
- Host: GitHub
- URL: https://github.com/linuxserver/docker-papermerge
- Owner: linuxserver
- License: gpl-3.0
- Archived: true
- Created: 2020-08-18T12:58:39.000Z (about 4 years ago)
- Default Branch: master
- Last Pushed: 2023-02-15T15:50:00.000Z (over 1 year ago)
- Last Synced: 2024-04-14T06:47:43.417Z (5 months ago)
- Language: Dockerfile
- Size: 192 KB
- Stars: 47
- Watchers: 9
- Forks: 12
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- Contributing: .github/CONTRIBUTING.md
- Funding: .github/FUNDING.yml
- License: LICENSE
Awesome Lists containing this project
README
[](https://linuxserver.io)
[](https://blog.linuxserver.io "all the things you can do with our containers including How-To guides, opinions and much more!")
[](https://discord.gg/YWrKVTn "realtime support / chat with the community and the team.")
[](https://discourse.linuxserver.io "post on our community forum.")
[](https://fleet.linuxserver.io "an online web interface which displays all of our maintained images.")
[](https://github.com/linuxserver "view the source for all of our repositories.")
[](https://opencollective.com/linuxserver "please consider helping us by either donating or contributing to our budget")
The [LinuxServer.io](https://linuxserver.io) team brings you another container release featuring:
* regular and timely application updates
* easy user mappings (PGID, PUID)
* custom base image with s6 overlay
* weekly base OS updates with common layers across the entire LinuxServer.io ecosystem to minimise space usage, down time and bandwidth
* regular security updates
Find us at:
* [Blog](https://blog.linuxserver.io) - all the things you can do with our containers including How-To guides, opinions and much more!
* [Discord](https://discord.gg/YWrKVTn) - realtime support / chat with the community and the team.
* [Discourse](https://discourse.linuxserver.io) - post on our community forum.
* [Fleet](https://fleet.linuxserver.io) - an online web interface which displays all of our maintained images.
* [GitHub](https://github.com/linuxserver) - view the source for all of our repositories.
* [Open Collective](https://opencollective.com/linuxserver) - please consider helping us by either donating or contributing to our budget
# 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."
[](https://www.papermerge.com/)
## 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-\ |
| arm64 | ✅ | arm64v8-\ |
| armhf | ✅ | arm32v7-\ |
## 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
Here are some example snippets to help you get started creating a container.
### 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:
- :/config
- :/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 :/config \
-v :/data \
--restart unless-stopped \
lscr.io/linuxserver/papermerge:latest
```
## Parameters
Container images are configured using parameters passed at runtime (such as those above). These parameters are separated by a colon and indicate `:` 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.
| Parameter | Function |
| :----: | --- |
| `-p 8000` | http gui |
| `-e PUID=1000` | for UserID - see below for explanation |
| `-e PGID=1000` | for GroupID - see below for explanation |
| `-e TZ=Etc/UTC` | specify a timezone to use, see this [list](https://en.wikipedia.org/wiki/List_of_tz_database_time_zones#List). |
| `-e 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 |
| `-v /config` | Contains all relevant configuration files. |
| `-v /data` | Storage location for all papermerge data files. |
## 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`
## Updating Info
Most of our images are static, versioned, and require an image update and container recreation to update the app inside. With some exceptions (ie. nextcloud, plex), we do not recommend or support updating apps inside the container. Please consult the [Application Setup](#application-setup) section above to see if it is recommended for the image.
Below are the instructions for updating containers:
### Via Docker Compose
* Update all images: `docker-compose pull`
* or update a single image: `docker-compose pull papermerge`
* Let compose update all containers as necessary: `docker-compose up -d`
* or update a single container: `docker-compose up -d papermerge`
* You can also remove the old dangling images: `docker image prune`
### Via Docker Run
* Update the image: `docker pull lscr.io/linuxserver/papermerge:latest`
* Stop the running container: `docker stop papermerge`
* Delete the container: `docker rm papermerge`
* 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:
```bash
docker run --rm \
-v /var/run/docker.sock:/var/run/docker.sock \
containrrr/watchtower \
--run-once papermerge
```
* 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. In the long term, we highly recommend using [Docker Compose](https://docs.linuxserver.io/general/docker-compose).
### Image Update Notifications - Diun (Docker Image Update Notifier)
* We recommend [Diun](https://crazymax.dev/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:
```bash
git clone https://github.com/linuxserver/docker-papermerge.git
cd docker-papermerge
docker build \
--no-cache \
--pull \
-t lscr.io/linuxserver/papermerge:latest .
```
The ARM variants can be built on x86_64 hardware using `multiarch/qemu-user-static`
```bash
docker run --rm --privileged multiarch/qemu-user-static:register --reset
```
Once registered you can define the dockerfile to use with `-f Dockerfile.aarch64`.
## 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.