docs(paperless): document Office ingestion support
Document Paperless Tika/Gotenberg sidecars, supported Office/OpenDocument ingestion formats, stack paths, validation/deploy procedure, and verification commands. Updates service inventory and architecture overview so PD docs match the deployed documents stack.
This commit is contained in:
@@ -41,7 +41,7 @@ Full homelab stack as of 2026-05-09. All 6 expansion phases are complete and dep
|
||||
|
||||
### Productivity Layer
|
||||
- **Immich** (2283) — photo management; library on Serenity NFS
|
||||
- **Paperless-NGX** (8083) — document management
|
||||
- **Paperless-NGX** (8083) — document management; uses internal Tika + Gotenberg sidecars for Office/OpenDocument text extraction and conversion
|
||||
- **Karakeep** (3100) — bookmarks / read-later
|
||||
- **n8n** (5678) — workflow automation
|
||||
- **KitchenOwl** (8086), **DoneTick** (2021) — household and task management
|
||||
|
||||
@@ -55,7 +55,7 @@ All homelab services, their hosts, ports, and current status.
|
||||
| Service | Port | Status |
|
||||
|---------|------|--------|
|
||||
| Immich | 2283 | ✅ Active |
|
||||
| Paperless-NGX | 8083 | ✅ Active |
|
||||
| Paperless-NGX | 8083 | ✅ Active; DOCX/Office ingestion via internal Tika + Gotenberg sidecars |
|
||||
| Karakeep | 3100 | ✅ Active |
|
||||
| n8n | 5678 | ✅ Active |
|
||||
| KitchenOwl | 8086 | ✅ Active |
|
||||
|
||||
49
docs/operations/PAPERLESS.md
Normal file
49
docs/operations/PAPERLESS.md
Normal file
@@ -0,0 +1,49 @@
|
||||
# Paperless-NGX Operations
|
||||
|
||||
## Stack Location
|
||||
|
||||
- Compose path on PD: `/mnt/docker-ssd/docker/compose/documents/docker-compose.yaml`
|
||||
- Appdata: `/mnt/docker-ssd/docker/appdata/paperless/`
|
||||
- Consume source: `/mnt/unraid/data/paperless/consume`
|
||||
- Consume container path: `/usr/src/paperless/consume`
|
||||
|
||||
## Office Document Ingestion
|
||||
|
||||
Paperless-NGX uses internal-only Tika and Gotenberg sidecars:
|
||||
|
||||
- Tika endpoint: `http://tika:9998`
|
||||
- Gotenberg endpoint: `http://gotenberg:3000`
|
||||
- Network: `documents_paperless_internal`
|
||||
- Host ports: none
|
||||
- Resource limits: Tika `512m`, Gotenberg `256m`
|
||||
|
||||
This enables ingestion/extraction for Office and OpenDocument files such as:
|
||||
|
||||
- `.docx`, `.doc`
|
||||
- `.pptx`, `.xlsx`
|
||||
- `.odt`, `.ods`, `.odp`
|
||||
|
||||
## Deploy / Restart Procedure
|
||||
|
||||
Validate before changing running containers:
|
||||
|
||||
```bash
|
||||
cd /mnt/docker-ssd/docker/compose/documents
|
||||
docker compose --env-file .env config
|
||||
```
|
||||
|
||||
Deploy with compose only:
|
||||
|
||||
```bash
|
||||
docker compose --env-file .env down && docker compose --env-file .env up -d
|
||||
```
|
||||
|
||||
Never use `systemctl restart docker` on PD for this stack.
|
||||
|
||||
## Verification
|
||||
|
||||
```bash
|
||||
docker compose --env-file .env ps
|
||||
docker logs paperless --tail 200 | grep -Ei 'tika|gotenberg'
|
||||
docker exec paperless sh -lc 'echo "$PAPERLESS_TIKA_ENABLED $PAPERLESS_TIKA_ENDPOINT $PAPERLESS_TIKA_GOTENBERG_ENDPOINT"; mount | grep /usr/src/paperless/consume'
|
||||
```
|
||||
Reference in New Issue
Block a user