elestio4test/paperless-ngx repository overview

⁠

⁠Paperless-ngx, verified and packaged by Elestio

Paperless-ngx⁠ is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.

Deploy a fully managed Paperless-ngx⁠ on elest.io⁠ if you are interested in an open source all-in-one devops platform with the ability to manage git repositories, manage issues, and run continuous integrations.

⁠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/paperless-ngx.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

Run the project with the following command

docker-compose up -d

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

⁠Docker-compose

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

    version: "3.4"
    services:
    broker:
        image: docker.io/library/redis:7
        restart: unless-stopped
        volumes:
        - redisdata:/data

    db:
        image: docker.io/library/mariadb:10
        restart: unless-stopped
        volumes:
        - dbdata:/var/lib/mysql
        environment:
        MARIADB_HOST: paperless
        MARIADB_DATABASE: paperless
        MARIADB_USER: paperless
        MARIADB_PASSWORD: paperless
        MARIADB_ROOT_PASSWORD: paperless

    webserver:
        image: elestio4test/paperless-ngx:${SOFTWARE_VERSION_TAG}
        restart: unless-stopped
        depends_on:
        - db
        - broker
        ports:
        - "172.17.0.1:8000:8000"
        healthcheck:
        test: ["CMD", "curl", "-f", "http://172.17.0.1:8000"]
        interval: 30s
        timeout: 10s
        retries: 5
        volumes:
        - data:/usr/src/paperless/data
        - media:/usr/src/paperless/media
        - ./export:/usr/src/paperless/export
        - ./consume:/usr/src/paperless/consume
        env_file: .env
        environment:
        PAPERLESS_REDIS: redis://broker:6379
        PAPERLESS_DBENGINE: mariadb
        PAPERLESS_DBHOST: db
        PAPERLESS_DBUSER: paperless # only needed if non-default username
        PAPERLESS_DBPASS: paperless # only needed if non-default password
        PAPERLESS_DBPORT: 3306


    volumes:
    data:
    media:
    dbdata:
    redisdata:

⁠Environment variables

⁠Maintenance

⁠Logging

The Elestio Paperless-ngx 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

• Paperless-ngx Github repository⁠

• Paperless-ngx documentation⁠

• Elestio/Paperless-ngx Github repository⁠