https://github.com/bodsch/docker-paperless

Scan, index, and archive all of your paper documents / Inofficial container for the the-paperless-project
https://github.com/bodsch/docker-paperless

docker documents ocr office paperless

Last synced: 7 months ago
JSON representation

Scan, index, and archive all of your paper documents / Inofficial container for the the-paperless-project

• Host: GitHub
• URL: https://github.com/bodsch/docker-paperless
• Owner: bodsch
• License: gpl-3.0
• Created: 2019-01-07T07:01:24.000Z (almost 7 years ago)
• Default Branch: master
• Last Pushed: 2019-09-15T13:04:45.000Z (about 6 years ago)
• Last Synced: 2025-01-09T05:38:35.085Z (9 months ago)
• Topics: docker, documents, ocr, office, paperless
• Language: Shell
• Homepage:
• Size: 36.1 KB
• Stars: 0
• Watchers: 2
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

README

          
# docker-paperless

Scan, index, and archive all of your paper documents

Inofficial container for the [paperless project](https://github.com/the-paperless-project/paperless)

This container is similar to the paperles project including a healthcheck and small optimizations.

# Status

[![Docker Pulls](https://img.shields.io/docker/pulls/bodsch/docker-paperless.svg?branch)][hub]

[![Image Size](https://images.microbadger.com/badges/image/bodsch/docker-paperless.svg?branch)][microbadger]

[![Build Status](https://travis-ci.org/bodsch/docker-paperless.svg?branch)][travis]

[hub]: https://hub.docker.com/r/bodsch/docker-paperless/

[microbadger]: https://microbadger.com/images/bodsch/docker-paperless

[travis]: https://travis-ci.org/bodsch/docker-paperless

# Build

Your can use the included Makefile.

To build the Container: `make`

To remove the builded Docker Image: `make clean`

Starts the Container: `make run`

Starts the Container with Login Shell: `make shell`

Entering the Container: `make exec`

Stop (but **not kill**): `make stop`

Create a valide `docker-compose.yml`: `make compose-file`

After then, you can build and run the containers with docker-compose.

# Project Documentation

It's all available on [ReadTheDocs](https://paperless.readthedocs.io/).

# Docker Hub

You can find the Container also at  [DockerHub](https://hub.docker.com/r/bodsch/docker-paperless)

## get

`docker pull bodsch/docker-paperless`

# supported Environment Vars

- `PAPERLESS_OCR_LANGUAGES`  (default: empty)

- `PAPERLESS_PASSPHRASE`  (default: empty)

- `PAPERLESS_CONSUMPTION_DIR` (default: empty)

- `PAPERLESS_CONSUME_MAIL_HOST` (default: empty)

- `USERMAP_UID` (default: `1000`)

- `USERMAP_GID` (default: `1000`)

# Ports

- 8000