|
# docker-compose file for running paperless from the Docker Hub.
|
|
# This file contains everything paperless needs to run.
|
|
# Paperless supports amd64, arm and arm64 hardware.
|
|
#
|
|
# All compose files of paperless configure paperless in the following way:
|
|
#
|
|
# - Paperless is (re)started on system boot, if it was running before shutdown.
|
|
# - Docker volumes for storing data are managed by Docker.
|
|
# - Folders for importing and exporting files are created in the same directory
|
|
# as this file and mounted to the correct folders inside the container.
|
|
# - Paperless listens on port 8000.
|
|
#
|
|
# In addition to that, this docker-compose file adds the following optional
|
|
# configurations:
|
|
#
|
|
# - Instead of SQLite (default), PostgreSQL is used as the database server.
|
|
#
|
|
# To install and update paperless with this file, do the following:
|
|
#
|
|
# - Copy this file as 'docker-compose.yml' and the files 'docker-compose.env'
|
|
# and '.env' into a folder.
|
|
# - Run 'docker-compose pull'.
|
|
# - Run 'docker-compose run --rm webserver createsuperuser' to create a user.
|
|
# - Run 'docker-compose up -d'.
|
|
#
|
|
# For more extensive installation and update instructions, refer to the
|
|
# documentation.
|
|
# https://paperless-ng.readthedocs.io/en/latest/configuration.html
|
|
|
|
version: "3.4"
|
|
services:
|
|
broker:
|
|
container_name: ${PAPERLESS_BROKER_CONTAINER_NAME:-paperless_broker}
|
|
image: redis:6.0
|
|
restart: unless-stopped
|
|
|
|
core:
|
|
container_name: ${PAPERLESS_CORE_CONTAINER_NAME:-paperless_core}
|
|
image: jonaswinkler/paperless-ng:${PAPERLESS_VERSION:-latest}
|
|
restart: unless-stopped
|
|
depends_on:
|
|
- broker
|
|
ports:
|
|
- ${PAPERLESS_HOST_IP_ADDRESS:-127.0.0.1}:${PAPERLESS_HOST_PORT:-8800}:8000
|
|
volumes:
|
|
- ./consume:/usr/src/paperless/consume
|
|
- ./data:/usr/src/paperless/data
|
|
- ./export:/usr/src/paperless/export
|
|
- ./media:/usr/src/paperless/media
|
|
env_file: docker-compose.env
|
|
environment:
|
|
PAPERLESS_ADMIN_USER: ${PAPERLESS_ADMIN_USER:-sysadmin}
|
|
PAPERLESS_ADMIN_PASSWORD: ${PAPERLESS_ADMIN_PASSWORD:-password}
|
|
PAPERLESS_REDIS: redis://broker:6379
|
|
PAPERLESS_DBHOST: ${PAPERLESS_DB_HOST:?err}
|
|
PAPERLESS_DBPORT: ${PAPERLESS_DB_PORT:?err}
|
|
PAPERLESS_DBNAME: ${PAPERLESS_DB_NAME:?err}
|
|
PAPERLESS_DBUSER: ${PAPERLESS_DB_USER:?err}
|
|
PAPERLESS_DBPASS: ${PAPERLESS_DB_PASSWORD:?err}
|