Paperless ngx (#392)

* Added paperless-ngx with Tika support

* Squashed commit of the following:

commit 1c0b3abb0d
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Wed Apr 26 08:08:49 2023 -0400

    chore(deps): update grafana/grafana-oss docker tag to v9.5.1 (#398)

    * chore(deps): update grafana/grafana-oss docker tag to v9.5.1

    * Update app version

    ---------

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
    Co-authored-by: github-action update-app-version <githubaction@githubaction.com>

commit c86bbe9161
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Wed Apr 26 08:06:37 2023 -0400

    chore(deps): update lscr.io/linuxserver/jackett docker tag to v0.20.3996 (#396)

    * chore(deps): update lscr.io/linuxserver/jackett docker tag to v0.20.3996

    * Update app version

    ---------

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
    Co-authored-by: github-action update-app-version <githubaction@githubaction.com>

commit fe1dcaefed
Author: DrMxrcy <58747968+DrMxrcy@users.noreply.github.com>
Date:   Tue Apr 25 16:30:29 2023 -0400

    Add Package Rules to ignore Dependency Images (#394)

commit c0e1bcc18b
Author: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
Date:   Tue Apr 25 15:21:45 2023 -0400

    chore(deps): update 1dev/server docker tag to v8.1.3 (#389)

    * chore(deps): update 1dev/server docker tag to v8.1.3

    * Update app version

    ---------

    Co-authored-by: renovate[bot] <29139614+renovate[bot]@users.noreply.github.com>
    Co-authored-by: github-action update-app-version <githubaction@githubaction.com>

commit 8779ff2f3a
Author: imgbot[bot] <31301654+imgbot[bot]@users.noreply.github.com>
Date:   Tue Apr 25 15:20:45 2023 -0400

    [ImgBot] Optimize images (#391)

    *Total -- 176.57kb -> 165.21kb (6.43%)

    /apps/lidarr-deemix/metadata/logo.jpg -- 111.09kb -> 102.11kb (8.09%)
    /apps/kanboard/metadata/logo.jpg -- 52.36kb -> 50.06kb (4.4%)
    /apps/actual-budget/metadata/logo.jpg -- 13.11kb -> 13.05kb (0.49%)

    Signed-off-by: ImgBotApp <ImgBotHelp@gmail.com>
    Co-authored-by: ImgBotApp <ImgBotHelp@gmail.com>

commit 8f51624561
Author: DrMxrcy <58747968+DrMxrcy@users.noreply.github.com>
Date:   Tue Apr 25 13:11:00 2023 -0400

    Update Homarr to v0.12.1 (#393)

* chore(paperless-ngx): update logo and container name

---------

Co-authored-by: Sascha Claren <sascha@saschas-macbook-pro.local>
Co-authored-by: DrMxrcy <drmxrcy@gmail.com>
This commit is contained in:
sclaren 2023-04-26 19:49:16 +02:00 committed by GitHub
parent 1c0b3abb0d
commit 136ff1b408
No known key found for this signature in database
GPG Key ID: 4AEE18F83AFDEB23
4 changed files with 160 additions and 0 deletions

View File

@ -0,0 +1,46 @@
{
"$schema": "../schema.json",
"name": "Paperless-ngx",
"available": true,
"exposable": true,
"port": 8012,
"id": "paperless-ngx",
"tipi_version": 1,
"version": "1.14.0",
"categories": [
"utilities"
],
"description": "Paperless-ngx is a community-supported open-source document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.",
"short_desc": "Document Management System (DMS)",
"author": "Daniel Quinn, Jonas Winkler, and the Paperless-ngx team",
"source": "https://github.com/paperless-ngx/paperless-ngx",
"form_fields": [
{
"type": "text",
"label": "Administrator Username",
"required": true,
"min": 5,
"max": 20,
"hint": "Username for the paperless-ngx Admin user",
"env_variable": "PAPERLESS_ADMIN_USERNAME"
},
{
"type": "password",
"label": "Administrator password",
"required": true,
"min": 5,
"max": 64,
"hint": "Password for the paperless-ngx Admin user",
"env_variable": "PAPERLESS_ADMIN_PASSWORD"
},
{
"type": "text",
"label": "Enable Tika (1 or 0)",
"required": true,
"min": 1,
"max": 1,
"hint": "1 = yes, 2= no",
"env_variable": "PAPERLESS_TIKA_ENABLED"
}
]
}

View File

@ -0,0 +1,75 @@
version: '3.7'
services:
# Redis
broker:
image: docker.io/library/redis:7
restart: unless-stopped
volumes:
- ${APP_DATA_DIR}/data/redis:/data
networks:
- tipi_main_network
# Postgres SQL
db:
image: docker.io/library/postgres:13
restart: unless-stopped
volumes:
- ${APP_DATA_DIR}/data/postgres:/var/lib/postgresql/data
environment:
POSTGRES_DB: paperless
POSTGRES_USER: paperless
POSTGRES_PASSWORD: paperless
networks:
- tipi_main_network
gotenberg:
image: docker.io/gotenberg/gotenberg:7.8
restart: unless-stopped
# The gotenberg chromium route is used to convert .eml files. We do not
# want to allow external content like tracking pixels or even javascript.
command:
- "gotenberg"
- "--chromium-disable-javascript=true"
- "--chromium-allow-list=file:///tmp/.*"
networks:
- tipi_main_network
tika:
image: ghcr.io/paperless-ngx/tika:latest
restart: unless-stopped
networks:
- tipi_main_network
paperless-ngx:
container_name: paperless-ngx
image: ghcr.io/paperless-ngx/paperless-ngx:1.14
restart: unless-stopped
depends_on:
- db
- broker
ports:
- ${APP_PORT}:8000
volumes:
- ${APP_DATA_DIR}/data/paperless_data:/usr/src/paperless/data
- ${APP_DATA_DIR}/data/paperless_media:/usr/src/paperless/media
- ${APP_DATA_DIR}/data/paperless_export:/usr/src/paperless/export
- ${APP_DATA_DIR}/data/paperless_consume:/usr/src/paperless/consume
environment:
PAPERLESS_REDIS: redis://broker:6379
PAPERLESS_DBHOST: db
PAPERLESS_ADMIN_USER: ${PAPERLESS_ADMIN_USERNAME}
PAPERLESS_ADMIN_PASSWORD: ${PAPERLESS_ADMIN_PASSWORD}
PAPERLESS_TIKA_ENABLED: ${PAPERLESS_TIKA_ENABLED}
PAPERLESS_TIKA_GOTENBERG_ENDPOINT: http://gotenberg:3000
PAPERLESS_TIKA_ENDPOINT: http://tika:9998
PAPERLESS_URL: ${APP_PROTOCOL:-http}://${APP_DOMAIN}
COMPOSE_PROJECT_NAME: paperless-ngx
networks:
- tipi_main_network
labels:
traefik.enable: ${APP_EXPOSED}
traefik.http.routers.paperless-ngx.rule: Host(`${APP_DOMAIN}`)
traefik.http.routers.paperless-ngx.entrypoints: websecure
traefik.http.routers.paperless-ngx.service: paperless-ngx
traefik.http.routers.paperless-ngx.tls.certresolver: myresolver
traefik.http.services.paperless-ngx.loadbalancer.server.port: 8000

View File

@ -0,0 +1,39 @@
# Paperless-ngx
Paperless-ngx is a document management system that transforms your physical documents into a searchable online archive so you can keep, well, less paper.
## ! IMPORTANT - PLEASE READ !
- Please **be patient** during installation, it may take a few minutes to download and install all dependencies.
- Please wait a few seconds after Tipi says that the installation was finished, because Paperless-ngx needs some time to start.
- **Tika** is available in this App, however you need to decide if you want to use it or not. You may disable it because of performance reasons.
- Tika allows you to upload Office documents (MSOffice, LibreOffice, etc) and automatically creates PDF versions of these documents.
- If you disable Tika, you will not be able to upload these document types.
- See here for more Information about Tika: https://docs.paperless-ngx.com/configuration/#tika
![Dashboard](https://github.com/paperless-ngx/paperless-ngx/raw/main/resources/logo/web/png/Black%20logo%20-%20no%20background.png#gh-light-mode-only)
![Dashboard](https://raw.githubusercontent.com/paperless-ngx/paperless-ngx/main/docs/assets/screenshots/documents-smallcards.png#gh-light-mode-only)
- Organize and index your scanned documents with tags, correspondents, types, and more.
- Performs OCR on your documents, adds selectable text to image only documents and adds tags, correspondents and document types to your documents.
- Supports PDF documents, images, plain text files, and Office documents (Word, Excel, Powerpoint, and LibreOffice equivalents).
- Office document support is optional and provided by Apache Tika (see [configuration](https://docs.paperless-ngx.com/configuration/#tika))
- Paperless stores your documents plain on disk. Filenames and folders are managed by paperless and their format can be configured freely.
- Single page application front end.
- Includes a dashboard that shows basic statistics and has document upload.
- Filtering by tags, correspondents, types, and more.
- Customizable views can be saved and displayed on the dashboard.
- Full text search helps you find what you need.
- Auto completion suggests relevant words from your documents.
- Results are sorted by relevance to your search query.
- Highlighting shows you which parts of the document matched the query.
- Searching for similar documents ("More like this")
- Email processing: Paperless adds documents from your email accounts.
- Configure multiple accounts and filters for each account.
- When adding documents from mail, paperless can move these mail to a new folder, mark them as read, flag them as important or delete them.
- Machine learning powered document matching.
- Paperless-ngx learns from your documents and will be able to automatically assign tags, correspondents and types to documents once you've stored a few documents in paperless.
- Optimized for multi core systems: Paperless-ngx consumes multiple documents in parallel.
- The integrated sanity checker makes sure that your document archive is in good health.
- [More screenshots are available in the documentation](https://docs.paperless-ngx.com/#screenshots).

Binary file not shown.

After

Width:  |  Height:  |  Size: 34 KiB