# yaml-language-server: $schema=https://schema.zeabur.app/template.json apiVersion: zeabur.com/v1 kind: Template metadata: name: Paperless-ngx spec: description: | Paperless-ngx is a self-hosted document management system that transforms physical documents into a searchable online archive. Features OCR, full-text search, automatic tagging, and document matching. Uses SQLite by default with no external database required. coverImage: https://avatars.githubusercontent.com/u/99562962?v=4 icon: https://avatars.githubusercontent.com/u/99562962?v=4 variables: - key: PUBLIC_DOMAIN type: DOMAIN name: Domain description: The domain to access Paperless-ngx tags: - Tool - Document readme: | # Paperless-ngx A self-hosted document management system that transforms physical documents into a searchable online archive. Scan, index, and archive all your paper documents with OCR and full-text search. ## What You Can Do After Deployment Visit your domain and log in with the superuser account you configured via environment variables. **Document ingestion:** Upload documents through the web UI, email, or drop files into the consume volume. Supported formats include PDF, images, Office documents, and plain text. **OCR and search:** All documents are automatically processed with OCR (Tesseract) and indexed for full-text search. Find any document instantly by searching its content, tags, correspondents, or document types. **Organization:** Create tags, correspondents, document types, and storage paths. Paperless-ngx can automatically assign these based on matching rules you define. **Workflows:** Set up automatic processing rules that trigger on document consumption — assign tags, set correspondents, move to storage paths, or run custom scripts. **Multi-user:** Create multiple user accounts with granular permissions for shared document management. ## First-Time Setup Set `PAPERLESS_ADMIN_USER` and `PAPERLESS_ADMIN_PASSWORD` environment variables to create the initial superuser account. If not set, you will need to create one via the management command. ## Configuration - **Language:** Set `PAPERLESS_OCR_LANGUAGE` to your language code (e.g., `eng`, `chi_tra`, `jpn`, `deu`) - **Time zone:** Set `PAPERLESS_TIME_ZONE` (e.g., `Asia/Taipei`, `America/New_York`) - **Secret key:** `PAPERLESS_SECRET_KEY` is auto-generated — change it for production use ## License GPL-3.0 — [GitHub](https://github.com/paperless-ngx/paperless-ngx) services: - name: paperless-ngx icon: https://avatars.githubusercontent.com/u/99562962?v=4 template: PREBUILT_V2 spec: source: image: ghcr.io/paperless-ngx/paperless-ngx:2.20.13 ports: - id: web port: 8000 type: HTTP volumes: - id: data dir: /usr/src/paperless/data - id: media dir: /usr/src/paperless/media - id: consume dir: /usr/src/paperless/consume env: PAPERLESS_ADMIN_PASSWORD: default: ${PASSWORD} PAPERLESS_ADMIN_USER: default: admin PAPERLESS_OCR_LANGUAGE: default: eng PAPERLESS_SECRET_KEY: default: ${PASSWORD} PAPERLESS_TIME_ZONE: default: UTC PAPERLESS_URL: default: https://${ZEABUR_WEB_URL} domainKey: PUBLIC_DOMAIN localization: es-ES: description: | Paperless-ngx es un sistema de gestión documental autoalojado que transforma documentos físicos en un archivo digital con búsqueda. Incluye OCR, búsqueda de texto completo, etiquetado automático y coincidencia de documentos. Usa SQLite por defecto sin necesidad de base de datos externa. variables: - key: PUBLIC_DOMAIN type: STRING name: Dominio description: El dominio para acceder a Paperless-ngx readme: | # Paperless-ngx Sistema de gestión documental autoalojado. Escanea, indexa y archiva todos tus documentos con OCR y búsqueda de texto completo. ## Qué puedes hacer después del despliegue Visita tu dominio e inicia sesión con la cuenta de superusuario configurada en las variables de entorno. **Ingesta de documentos:** Sube documentos por la interfaz web, correo electrónico o coloca archivos en el volumen consume. Soporta PDF, imágenes, documentos Office y texto plano. **OCR y búsqueda:** Todos los documentos se procesan automáticamente con OCR y se indexan para búsqueda de texto completo. **Organización:** Crea etiquetas, corresponsales, tipos de documento y rutas de almacenamiento con reglas de asignación automática. ## Configuración inicial Establece `PAPERLESS_ADMIN_USER` y `PAPERLESS_ADMIN_PASSWORD` para crear la cuenta de administrador inicial. ## Configuración - Idioma: establece `PAPERLESS_OCR_LANGUAGE` a `spa` - Zona horaria: establece `PAPERLESS_TIME_ZONE` a `Europe/Madrid` ## Licencia GPL-3.0 — [GitHub](https://github.com/paperless-ngx/paperless-ngx) id-ID: description: | Paperless-ngx adalah sistem manajemen dokumen self-hosted yang mengubah dokumen fisik menjadi arsip online yang dapat dicari. Dilengkapi OCR, pencarian teks lengkap, penandaan otomatis, dan pencocokan dokumen. Menggunakan SQLite secara default tanpa perlu database eksternal. variables: - key: PUBLIC_DOMAIN type: STRING name: Domain description: Domain untuk mengakses Paperless-ngx readme: | # Paperless-ngx Sistem manajemen dokumen self-hosted. Pindai, indeks, dan arsipkan semua dokumen kertas Anda dengan OCR dan pencarian teks lengkap. ## Apa yang bisa dilakukan setelah deploy Buka domain Anda dan login dengan akun superuser yang dikonfigurasi melalui variabel lingkungan. **Impor dokumen:** Upload melalui antarmuka web, email, atau letakkan file di volume consume. Mendukung PDF, gambar, dokumen Office, dan teks biasa. **OCR dan pencarian:** Semua dokumen diproses OCR secara otomatis dan diindeks untuk pencarian teks lengkap. **Organisasi:** Buat tag, koresponden, tipe dokumen, dan jalur penyimpanan dengan aturan pencocokan otomatis. ## Pengaturan awal Set `PAPERLESS_ADMIN_USER` dan `PAPERLESS_ADMIN_PASSWORD` untuk membuat akun admin awal. ## Konfigurasi - Bahasa: set `PAPERLESS_OCR_LANGUAGE` ke `ind` - Zona waktu: set `PAPERLESS_TIME_ZONE` ke `Asia/Jakarta` ## Lisensi GPL-3.0 — [GitHub](https://github.com/paperless-ngx/paperless-ngx) ja-JP: description: | Paperless-ngxはセルフホストの文書管理システムです。紙の文書を検索可能なオンラインアーカイブに変換します。OCR、全文検索、自動タグ付け、文書マッチング機能を搭載。デフォルトでSQLiteを使用し、外部データベース不要。 variables: - key: PUBLIC_DOMAIN type: STRING name: ドメイン description: Paperless-ngxにアクセスするためのドメイン readme: | # Paperless-ngx セルフホストの文書管理システム。紙の文書をスキャン、インデックス化、アーカイブし、OCRと全文検索で管理できます。 ## デプロイ後にできること ドメインにアクセスし、環境変数で設定したスーパーユーザーアカウントでログインします。 **文書取り込み：** WebUI、メール、またはconsumeボリュームへのファイル配置で取り込み。PDF、画像、Officeドキュメント、プレーンテキストに対応。 **OCRと検索：** すべての文書は自動的にOCR処理され、全文検索インデックスが作成されます。 **整理：** タグ、取引先、文書タイプ、保存パスを作成し、マッチングルールで自動割り当て。 ## 初期設定 `PAPERLESS_ADMIN_USER` と `PAPERLESS_ADMIN_PASSWORD` を設定して初期管理者アカウントを作成してください。 ## 設定 - 言語：`PAPERLESS_OCR_LANGUAGE` を `jpn` に設定 - タイムゾーン：`PAPERLESS_TIME_ZONE` を `Asia/Tokyo` に設定 ## ライセンス GPL-3.0 — [GitHub](https://github.com/paperless-ngx/paperless-ngx) ko-KR: description: | Paperless-ngx는 셀프호스팅 문서 관리 시스템으로, 종이 문서를 검색 가능한 온라인 아카이브로 변환합니다. OCR, 전문 검색, 자동 태그 지정, 문서 매칭 기능을 제공합니다. 기본적으로 SQLite를 사용하며 외부 데이터베이스가 필요 없습니다. variables: - key: PUBLIC_DOMAIN type: STRING name: 도메인 description: Paperless-ngx에 접속할 도메인 readme: | # Paperless-ngx 셀프호스팅 문서 관리 시스템. 종이 문서를 스캔, 인덱싱, 아카이빙하여 OCR과 전문 검색으로 관리할 수 있습니다. ## 배포 후 할 수 있는 것 도메인에 접속하여 환경 변수로 설정한 슈퍼유저 계정으로 로그인합니다. **문서 수집:** 웹 UI, 이메일 또는 consume 볼륨에 파일을 넣어 수집. PDF, 이미지, Office 문서, 일반 텍스트 지원. **OCR 및 검색:** 모든 문서가 자동으로 OCR 처리되고 전문 검색 인덱스가 생성됩니다. **정리:** 태그, 거래처, 문서 유형, 저장 경로를 만들고 매칭 규칙으로 자동 할당. ## 초기 설정 `PAPERLESS_ADMIN_USER`와 `PAPERLESS_ADMIN_PASSWORD` 환경 변수를 설정하여 초기 관리자 계정을 생성하세요. ## 설정 - 언어: `PAPERLESS_OCR_LANGUAGE`를 `kor`로 설정 - 시간대: `PAPERLESS_TIME_ZONE`을 `Asia/Seoul`로 설정 ## 라이선스 GPL-3.0 — [GitHub](https://github.com/paperless-ngx/paperless-ngx) th-TH: description: | Paperless-ngx คือระบบจัดการเอกสารแบบ self-hosted ที่แปลงเอกสารกระดาษเป็นคลังเอกสารออนไลน์ที่ค้นหาได้ รองรับ OCR การค้นหาแบบเต็มข้อความ การติดแท็กอัตโนมัติ และการจับคู่เอกสาร ใช้ SQLite เป็นค่าเริ่มต้นโดยไม่ต้องใช้ฐานข้อมูลภายนอก variables: - key: PUBLIC_DOMAIN type: STRING name: โดเมน description: โดเมนสำหรับเข้าถึง Paperless-ngx readme: | # Paperless-ngx ระบบจัดการเอกสารแบบ self-hosted สแกน จัดทำดัชนี และเก็บถาวรเอกสารกระดาษทั้งหมดด้วย OCR และการค้นหาแบบเต็มข้อความ ## สิ่งที่ทำได้หลังจากติดตั้ง เข้าสู่โดเมนของคุณและล็อกอินด้วยบัญชี superuser ที่ตั้งค่าผ่านตัวแปรสภาพแวดล้อม **นำเข้าเอกสาร:** อัปโหลดผ่านเว็บ อีเมล หรือวางไฟล์ใน consume volume รองรับ PDF รูปภาพ เอกสาร Office และข้อความธรรมดา **OCR และค้นหา:** เอกสารทั้งหมดถูกประมวลผล OCR อัตโนมัติและจัดทำดัชนีสำหรับการค้นหาแบบเต็มข้อความ **จัดระเบียบ:** สร้างแท็ก ผู้ติดต่อ ประเภทเอกสาร และเส้นทางการจัดเก็บ พร้อมกฎการจับคู่อัตโนมัติ ## การตั้งค่าเริ่มต้น ตั้ง `PAPERLESS_ADMIN_USER` และ `PAPERLESS_ADMIN_PASSWORD` เพื่อสร้างบัญชีผู้ดูแลระบบเริ่มต้น ## การตั้งค่า - ภาษา: ตั้ง `PAPERLESS_OCR_LANGUAGE` เป็น `tha` - เขตเวลา: ตั้ง `PAPERLESS_TIME_ZONE` เป็น `Asia/Bangkok` ## สัญญาอนุญาต GPL-3.0 — [GitHub](https://github.com/paperless-ngx/paperless-ngx) zh-CN: description: | Paperless-ngx 是自托管的文档管理系统，将纸质文档转换为可搜索的在线档案库。支持 OCR、全文搜索、自动标签和文档匹配。默认使用 SQLite，无需外部数据库。 variables: - key: PUBLIC_DOMAIN type: STRING name: 域名 description: 访问 Paperless-ngx 的域名 readme: | # Paperless-ngx 自托管的文档管理系统，将纸质文档转换为可搜索的在线档案库。 ## 部署后可以做什么 打开域名并使用环境变量设置的超级用户账号登录。 **文档导入：** 通过网页界面上传、电子邮件，或将文件放入 consume 卷。支持 PDF、图片、Office 文档和纯文本。 **OCR 与搜索：** 所有文档自动进行 OCR 处理并建立全文索引。通过内容、标签、通讯录或文档类型即时搜索。 **整理：** 创建标签、通讯录、文档类型和存储路径。可定义匹配规则自动分配。 ## 首次设置 设置 `PAPERLESS_ADMIN_USER` 和 `PAPERLESS_ADMIN_PASSWORD` 环境变量来创建初始管理员账号。 ## 设置 - 语言：将 `PAPERLESS_OCR_LANGUAGE` 设为 `chi_sim`（简体中文） - 时区：将 `PAPERLESS_TIME_ZONE` 设为 `Asia/Shanghai` ## 授权 GPL-3.0 — [GitHub](https://github.com/paperless-ngx/paperless-ngx) zh-TW: description: | Paperless-ngx 是自架的文件管理系統，將紙本文件轉換為可搜尋的線上檔案庫。支援 OCR 文字辨識、全文搜尋、自動標籤和文件比對。預設使用 SQLite，無需外部資料庫。 variables: - key: PUBLIC_DOMAIN type: STRING name: 網域 description: 存取 Paperless-ngx 的網域 readme: | # Paperless-ngx 自架的文件管理系統，將紙本文件轉換為可搜尋的線上檔案庫。掃描、索引和歸檔所有紙本文件，支援 OCR 和全文搜尋。 ## 部署後可以做什麼 開啟網域並使用環境變數設定的超級使用者帳號登入。 **文件匯入：** 透過網頁介面上傳、電子郵件，或將檔案放入 consume 磁碟區。支援 PDF、圖片、Office 文件和純文字。 **OCR 與搜尋：** 所有文件自動進行 OCR 處理並建立全文索引。透過內容、標籤、通訊錄或文件類型即時搜尋。 **整理：** 建立標籤、通訊錄、文件類型和儲存路徑。可定義比對規則自動指派。 **工作流程：** 設定文件匯入時的自動處理規則——指派標籤、設定通訊錄、移動到儲存路徑。 ## 首次設定 設定 `PAPERLESS_ADMIN_USER` 和 `PAPERLESS_ADMIN_PASSWORD` 環境變數來建立初始管理員帳號。 ## 設定 - **語言：** 將 `PAPERLESS_OCR_LANGUAGE` 設為 `chi_tra`（繁體中文） - **時區：** 將 `PAPERLESS_TIME_ZONE` 設為 `Asia/Taipei` ## 授權 GPL-3.0 — [GitHub](https://github.com/paperless-ngx/paperless-ngx)