kopia lustrzana https://github.com/linuxserver/docker-documentation
159 wiersze
7.5 KiB
Markdown
Executable File
159 wiersze
7.5 KiB
Markdown
Executable File
# [linuxserver/papermerge](https://github.com/linuxserver/docker-papermerge)
|
|
|
|
[](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://microbadger.com/images/linuxserver/papermerge "Get your own version badge on microbadger.com")
|
|
[](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://lsio-ci.ams3.digitaloceanspaces.com/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
|
|
|
|
Our images support multiple architectures such as `x86-64`, `arm64` and `armhf`. 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 `linuxserver/papermerge` 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 | Tag |
|
|
| :----: | --- |
|
|
| x86-64 | amd64-latest |
|
|
| arm64 | arm64v8-latest |
|
|
| armhf | arm32v7-latest |
|
|
|
|
|
|
## Usage
|
|
|
|
Here are some example snippets to help you get started creating a container from this image.
|
|
|
|
### docker
|
|
|
|
```
|
|
docker create \
|
|
--name=papermerge \
|
|
-e PUID=1000 \
|
|
-e PGID=1000 \
|
|
-e TZ=America/New_York \
|
|
-p 8000:8000 \
|
|
-v </path/to/appdata/config>:/config \
|
|
-v </path/to/appdata/data>:/data \
|
|
--restart unless-stopped \
|
|
linuxserver/papermerge
|
|
```
|
|
|
|
|
|
### docker-compose
|
|
|
|
Compatible with docker-compose v2 schemas.
|
|
|
|
```yaml
|
|
---
|
|
version: "2.1"
|
|
services:
|
|
papermerge:
|
|
image: linuxserver/papermerge
|
|
container_name: papermerge
|
|
environment:
|
|
- PUID=1000
|
|
- PGID=1000
|
|
- TZ=America/New_York
|
|
volumes:
|
|
- </path/to/appdata/config>:/config
|
|
- </path/to/appdata/data>:/data
|
|
ports:
|
|
- 8000:8000
|
|
restart: unless-stopped
|
|
```
|
|
|
|
## 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 |
|
|
|
|
### Volume Mappings (`-v`)
|
|
|
|
| Volume | Function |
|
|
| :----: | --- |
|
|
| `/config` | Contains all relevant configuration files. |
|
|
| `/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:
|
|
|
|
```
|
|
-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:
|
|
|
|
```
|
|
$ id username
|
|
uid=1000(dockeruser) gid=1000(dockergroup) groups=1000(dockergroup)
|
|
```
|
|
|
|
## Application Setup
|
|
|
|
Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT
|
|
More info at [papermerge](https://www.papermerge.com/).
|
|
|
|
|
|
## Docker Mods
|
|
[](https://mods.linuxserver.io/?mod=papermerge "view available mods for this container.")
|
|
|
|
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) can be accessed via the dynamic badge 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" }}' linuxserver/papermerge`
|
|
|
|
## Versions
|
|
|
|
* **08.08.20:** - Initial Release.
|