elestio/papermerge repository overview

⁠

⁠Papermerge, verified and packaged by Elestio

Papermerge⁠ is a open source document management system designed to work with scanned documents (also called digital archives).

Deploy a fully managed papermerge⁠ on elest.io⁠ if you want automated backups, reverse proxy with SSL termination, firewall, automated OS & Software updates, and a team of Linux experts and open source enthusiasts to ensure your services are always safe, and functional.

⁠Why use Elestio images?

• Elestio stays in sync with updates from the original source and quickly releases new versions of this image through our automated processes.
• Elestio images provide timely access to the most recent bug fixes and features.
• Our team performs quality control checks to ensure the products we release meet our high standards.

⁠Usage

⁠Git clone

You can deploy it easily with the following command:

git clone https://github.com/elestio-examples/papermerge.git

Copy the .env file from tests folder to the project directory

cp ./tests/.env ./.env

Edit the .env file with your own values.

Create data folders with correct permissions

mkdir -p ./pgdata
chown -R 1000:1000 ./pgdata

Run the project with the following command

./scripts/preInstall.sh
docker-compose up -d

You can access the Web UI at: http://your-domain:12000

⁠Docker-compose

Here are some example snippets to help you get started creating a container.

version: "3.9"

services:
    app:
        image: elestio4test/papermerge:latest
        environment:
            - PAPERMERGE__MAIN__SECRET_KEY=${PAPERMERGE__SECURITY__SECRET_KEY}
            - DJANGO_SUPERUSER_PASSWORD=${PAPERMERGE__AUTH__PASSWORD}
            - PAPERMERGE__DATABASE__TYPE=postgres
            - PAPERMERGE__DATABASE__USER=${POSTGRES_USER}
            - PAPERMERGE__DATABASE__PASSWORD=${POSTGRES_PASSWORD}
            - PAPERMERGE__DATABASE__NAME=${POSTGRES_DB}
            - PAPERMERGE__DATABASE__HOST=db
        ports:
            - 172.17.0.1:12000:8000
        depends_on:
            - db
    db:
        restart: always
        image: elestio/postgres:15
        environment:
            POSTGRES_USER: ${POSTGRES_USER}
            POSTGRES_PASSWORD: ${POSTGRES_PASSWORD}
            POSTGRES_DB: ${POSTGRES_DB}
        ports:
            - 172.17.0.1:56225:5432
        volumes:
            - ./storage/postgres_data:/var/lib/postgresql/data/

⁠Environment variables

⁠Maintenance

⁠Logging

The Elestio papermerge Docker image sends the container logs to stdout. To view the logs, you can use the following command:

docker-compose logs -f

To stop the stack you can use the following command:

docker-compose down

⁠Backup and Restore with Docker Compose

To make backup and restore operations easier, we are using folder volume mounts. You can simply stop your stack with docker-compose down, then backup all the files and subfolders in the folder near the docker-compose.yml file.

Creating a ZIP Archive For example, if you want to create a ZIP archive, navigate to the folder where you have your docker-compose.yml file and use this command:

zip -r myarchive.zip .

Restoring from ZIP Archive To restore from a ZIP archive, unzip the archive into the original folder using the following command:

unzip myarchive.zip -d /path/to/original/folder

Starting Your Stack Once your backup is complete, you can start your stack again with the following command:

docker-compose up -d

That's it! With these simple steps, you can easily backup and restore your data volumes using Docker Compose.

⁠Links

• Papermerge documentation⁠

• Papermerge Github repository⁠

• Elestio/Papermerge Github repository⁠