From 425b72b4e929078138267ac2aff3834100016515 Mon Sep 17 00:00:00 2001 From: LinuxServer-CI Date: Fri, 16 Apr 2021 05:11:45 +0100 Subject: [PATCH] Bot Updating Documentation --- images/docker-papermerge.md | 27 +++++++++++---------------- 1 file changed, 11 insertions(+), 16 deletions(-) diff --git a/images/docker-papermerge.md b/images/docker-papermerge.md index 6d1279b8e..ba47fbd9f 100755 --- a/images/docker-papermerge.md +++ b/images/docker-papermerge.md @@ -1,6 +1,9 @@ --- title: papermerge --- + + + # [linuxserver/papermerge](https://github.com/linuxserver/docker-papermerge) [![GitHub Stars](https://img.shields.io/github/stars/linuxserver/docker-papermerge.svg?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&logo=github)](https://github.com/linuxserver/docker-papermerge) @@ -15,7 +18,6 @@ title: papermerge [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/). @@ -30,6 +32,10 @@ The architectures supported by this image are: | arm64 | arm64v8-latest | | armhf | arm32v7-latest | +## Application Setup + +Default login is admin:admin via the webui, accessible at http://SERVERIP:PORT +More info at [papermerge](https://www.papermerge.com/). ## Usage @@ -61,7 +67,7 @@ services: ### docker cli -``` +```bash docker run -d \ --name=papermerge \ -e PUID=1000 \ @@ -75,7 +81,6 @@ docker run -d \ ghcr.io/linuxserver/papermerge ``` - ## Parameters Docker 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. @@ -86,7 +91,6 @@ Docker images are configured using parameters passed at runtime (such as those a | :----: | --- | | `8000` | http gui | - ### Environment Variables (`-e`) | Env | Function | @@ -103,15 +107,13 @@ Docker images are configured using parameters passed at runtime (such as those a | `/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: -``` +```bash -e FILE__PASSWORD=/run/secrets/mysecretpassword ``` @@ -122,7 +124,6 @@ Will set the environment variable `PASSWORD` based on the contents of the `/run/ 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`. @@ -131,23 +132,17 @@ Ensure any volume directories on the host are owned by the same user you specify 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) ``` -## 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 + [![Docker Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=papermerge&query=%24.mods%5B%27papermerge%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](https://mods.linuxserver.io/?mod=papermerge "view available mods for this container.") [![Docker Universal Mods](https://img.shields.io/badge/dynamic/yaml?color=94398d&labelColor=555555&logoColor=ffffff&style=for-the-badge&label=universal&query=%24.mods%5B%27universal%27%5D.mod_count&url=https%3A%2F%2Fraw.githubusercontent.com%2Flinuxserver%2Fdocker-mods%2Fmaster%2Fmod-list.yml)](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: