mirror of
https://github.com/paperless-ngx/paperless-ngx.git
synced 2025-04-02 13:45:10 -05:00
c8ee35692c
* Replaces references to docker-compose (the v1 executable) with docker compose (the v2 plugin) as well as fixing up some referenes between the tool vs the command * Update docs/setup.md Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com> * Replaces references to docker-compose (the v1 executable) with docker compose (the v2 plugin) as well as fixing up some referenes between the tool vs the command --------- Co-authored-by: shamoon <4887959+shamoon@users.noreply.github.com>
82 lines
2.4 KiB
YAML
82 lines
2.4 KiB
YAML
# 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), MariaDB 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.
|
|
|
|
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: ghcr.io/paperless-ngx/paperless-ngx:latest
|
|
restart: unless-stopped
|
|
depends_on:
|
|
- db
|
|
- broker
|
|
ports:
|
|
- "8000:8000"
|
|
healthcheck:
|
|
test: ["CMD", "curl", "-f", "http://localhost: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: docker-compose.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:
|