Skip to main content

documents

documents — ɳSelf documentation.

Documents Plugin

Document management with templates, versioning, and share tokens. Pro plugin.

Requires: Basic license tier or higher. nself license set nself_pro_...

Install

nself license set nself_pro_xxxxx...
nself plugin install documents

What It Does

Manages documents stored in MinIO with metadata, versioning, and access control. Create document templates for consistent formatting, generate share links with configurable expiry and permissions, and track document access via share tokens. Supports PDF, DOCX, and plain text formats.

Configuration

Env VarDefaultDescription
DOCUMENTS_PORT3106Documents service port
DOCUMENTS_STORAGE_BUCKETnoneMinIO bucket for documents
DOCUMENTS_SHARE_TTL604800Default share link TTL (7 days)
DOCUMENTS_MAX_FILE_SIZE50MBMaximum document size

Ports

PortPurpose
3106Documents REST API

Database Tables

5 tables added to your Postgres database:

  • np_documents_documents: document metadata
  • np_documents_versions: version history
  • np_documents_templates: document templates
  • np_documents_shares: share token records
  • np_documents_access_log: document access log

Nginx Routes

RouteTarget
/documents/Document management API
/documents/share/{token}Share link access