|
|
@@ -0,0 +1,476 @@
|
|
|
+groups:
|
|
|
+ - name: Paperless-ngx Configuration
|
|
|
+ description: Configure Paperless-ngx
|
|
|
+ - name: User and Group Configuration
|
|
|
+ description: Configure User and Group for Paperless-ngx
|
|
|
+ - name: Network Configuration
|
|
|
+ description: Configure Network for Paperless-ngx
|
|
|
+ - name: Storage Configuration
|
|
|
+ description: Configure Storage for Paperless-ngx
|
|
|
+ - name: Resources Configuration
|
|
|
+ description: Configure Resources for Paperless-ngx
|
|
|
+
|
|
|
+portals:
|
|
|
+ web_portal:
|
|
|
+ protocols:
|
|
|
+ - "$kubernetes-resource_configmap_portal_protocol"
|
|
|
+ host:
|
|
|
+ - "$kubernetes-resource_configmap_portal_host"
|
|
|
+ ports:
|
|
|
+ - "$kubernetes-resource_configmap_portal_port"
|
|
|
+ path: "$kubernetes-resource_configmap_portal_path"
|
|
|
+
|
|
|
+questions:
|
|
|
+ - variable: TZ
|
|
|
+ group: Paperless-ngx Configuration
|
|
|
+ label: Timezone
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ default: Etc/UTC
|
|
|
+ required: true
|
|
|
+ $ref:
|
|
|
+ - definitions/timezone
|
|
|
+
|
|
|
+ - variable: paperlessConfig
|
|
|
+ label: ""
|
|
|
+ group: Paperless-ngx Configuration
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: adminUser
|
|
|
+ label: Admin User
|
|
|
+ description: |
|
|
|
+ The admin user for Paperless-ngx.</br>
|
|
|
+ It is only used for the initial installation.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ default: ""
|
|
|
+ immutable: true
|
|
|
+ required: true
|
|
|
+ - variable: adminPassword
|
|
|
+ label: Admin Password
|
|
|
+ description: |
|
|
|
+ The admin password for Paperless-ngx.</br>
|
|
|
+ It is only used for the initial installation.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ default: ""
|
|
|
+ immutable: true
|
|
|
+ required: true
|
|
|
+ private: true
|
|
|
+ - variable: adminMail
|
|
|
+ label: Admin Mail
|
|
|
+ description: |
|
|
|
+ The admin mail for Paperless-ngx.</br>
|
|
|
+ It is only used for the initial installation.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ default: ""
|
|
|
+ immutable: true
|
|
|
+ required: true
|
|
|
+ - variable: enableTrash
|
|
|
+ label: Enable Trash
|
|
|
+ description: |
|
|
|
+ Enable the trash feature for Paperless-ngx.</br>
|
|
|
+ When enabled, documents will be moved to the trash instead of being deleted.
|
|
|
+ schema:
|
|
|
+ type: boolean
|
|
|
+ default: true
|
|
|
+ - variable: additionalEnvs
|
|
|
+ label: Additional Environment Variables
|
|
|
+ description: Configure additional environment variables for Paperless-ngx.
|
|
|
+ schema:
|
|
|
+ type: list
|
|
|
+ default: []
|
|
|
+ items:
|
|
|
+ - variable: env
|
|
|
+ label: Environment Variable
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: name
|
|
|
+ label: Name
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+ - variable: value
|
|
|
+ label: Value
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+
|
|
|
+ - variable: paperlessID
|
|
|
+ label: ""
|
|
|
+ group: User and Group Configuration
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: user
|
|
|
+ label: User ID
|
|
|
+ description: The user id that Paperless-ngx files will be owned by.
|
|
|
+ schema:
|
|
|
+ type: int
|
|
|
+ min: 568
|
|
|
+ default: 568
|
|
|
+ required: true
|
|
|
+ - variable: group
|
|
|
+ label: Group ID
|
|
|
+ description: The group id that Paperless-ngx files will be owned by.
|
|
|
+ schema:
|
|
|
+ type: int
|
|
|
+ min: 568
|
|
|
+ default: 568
|
|
|
+ required: true
|
|
|
+
|
|
|
+ - variable: paperlessNetwork
|
|
|
+ label: ""
|
|
|
+ group: Network Configuration
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: webPort
|
|
|
+ label: Web Port
|
|
|
+ description: The port for the Paperless-ngx Web UI.
|
|
|
+ schema:
|
|
|
+ type: int
|
|
|
+ default: 30070
|
|
|
+ min: 9000
|
|
|
+ max: 65535
|
|
|
+ required: true
|
|
|
+ - variable: hostNetwork
|
|
|
+ label: Host Network
|
|
|
+ description: |
|
|
|
+ Bind to the host network. It's recommended to keep this disabled.</br>
|
|
|
+ schema:
|
|
|
+ type: boolean
|
|
|
+ default: false
|
|
|
+
|
|
|
+ - variable: paperlessStorage
|
|
|
+ label: ""
|
|
|
+ group: Storage Configuration
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: data
|
|
|
+ label: Paperless-ngx Data Storage
|
|
|
+ description: The path to store Paperless-ngx Data.
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: type
|
|
|
+ label: Type
|
|
|
+ description: |
|
|
|
+ ixVolume: Is dataset created automatically by the system.</br>
|
|
|
+ Host Path: Is a path that already exists on the system.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+ default: "ixVolume"
|
|
|
+ enum:
|
|
|
+ - value: "hostPath"
|
|
|
+ description: Host Path (Path that already exists on the system)
|
|
|
+ - value: "ixVolume"
|
|
|
+ description: ixVolume (Dataset created automatically by the system)
|
|
|
+ - variable: datasetName
|
|
|
+ label: Dataset Name
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ show_if: [["type", "=", "ixVolume"]]
|
|
|
+ required: true
|
|
|
+ hidden: true
|
|
|
+ immutable: true
|
|
|
+ default: "data"
|
|
|
+ $ref:
|
|
|
+ - "normalize/ixVolume"
|
|
|
+ - variable: hostPath
|
|
|
+ label: Host Path
|
|
|
+ schema:
|
|
|
+ type: hostpath
|
|
|
+ show_if: [["type", "=", "hostPath"]]
|
|
|
+ immutable: true
|
|
|
+ required: true
|
|
|
+ - variable: media
|
|
|
+ label: Paperless-ngx Media Storage
|
|
|
+ description: The path to store Paperless-ngx Media.
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: type
|
|
|
+ label: Type
|
|
|
+ description: |
|
|
|
+ ixVolume: Is dataset created automatically by the system.</br>
|
|
|
+ Host Path: Is a path that already exists on the system.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+ default: "ixVolume"
|
|
|
+ enum:
|
|
|
+ - value: "hostPath"
|
|
|
+ description: Host Path (Path that already exists on the system)
|
|
|
+ - value: "ixVolume"
|
|
|
+ description: ixVolume (Dataset created automatically by the system)
|
|
|
+ - variable: datasetName
|
|
|
+ label: Dataset Name
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ show_if: [["type", "=", "ixVolume"]]
|
|
|
+ required: true
|
|
|
+ hidden: true
|
|
|
+ immutable: true
|
|
|
+ default: "media"
|
|
|
+ $ref:
|
|
|
+ - "normalize/ixVolume"
|
|
|
+ - variable: hostPath
|
|
|
+ label: Host Path
|
|
|
+ schema:
|
|
|
+ type: hostpath
|
|
|
+ show_if: [["type", "=", "hostPath"]]
|
|
|
+ immutable: true
|
|
|
+ required: true
|
|
|
+ - variable: consume
|
|
|
+ label: Paperless-ngx Consumption Storage
|
|
|
+ description: The path to store Paperless-ngx Data for Consumption.
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: type
|
|
|
+ label: Type
|
|
|
+ description: |
|
|
|
+ ixVolume: Is dataset created automatically by the system.</br>
|
|
|
+ Host Path: Is a path that already exists on the system.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+ default: "ixVolume"
|
|
|
+ enum:
|
|
|
+ - value: "hostPath"
|
|
|
+ description: Host Path (Path that already exists on the system)
|
|
|
+ - value: "ixVolume"
|
|
|
+ description: ixVolume (Dataset created automatically by the system)
|
|
|
+ - variable: datasetName
|
|
|
+ label: Dataset Name
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ show_if: [["type", "=", "ixVolume"]]
|
|
|
+ required: true
|
|
|
+ hidden: true
|
|
|
+ immutable: true
|
|
|
+ default: "consume"
|
|
|
+ $ref:
|
|
|
+ - "normalize/ixVolume"
|
|
|
+ - variable: hostPath
|
|
|
+ label: Host Path
|
|
|
+ schema:
|
|
|
+ type: hostpath
|
|
|
+ show_if: [["type", "=", "hostPath"]]
|
|
|
+ immutable: true
|
|
|
+ required: true
|
|
|
+ - variable: trash
|
|
|
+ label: Paperless-ngx Trash Storage
|
|
|
+ description: |
|
|
|
+ The path to store Paperless-ngx Trash.</br>
|
|
|
+ This is only used when the trash feature is enabled.
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: type
|
|
|
+ label: Type
|
|
|
+ description: |
|
|
|
+ ixVolume: Is dataset created automatically by the system.</br>
|
|
|
+ Host Path: Is a path that already exists on the system.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+ default: "ixVolume"
|
|
|
+ enum:
|
|
|
+ - value: "hostPath"
|
|
|
+ description: Host Path (Path that already exists on the system)
|
|
|
+ - value: "ixVolume"
|
|
|
+ description: ixVolume (Dataset created automatically by the system)
|
|
|
+ - variable: datasetName
|
|
|
+ label: Dataset Name
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ show_if: [["type", "=", "ixVolume"]]
|
|
|
+ required: true
|
|
|
+ hidden: true
|
|
|
+ immutable: true
|
|
|
+ default: "trash"
|
|
|
+ $ref:
|
|
|
+ - "normalize/ixVolume"
|
|
|
+ - variable: hostPath
|
|
|
+ label: Host Path
|
|
|
+ schema:
|
|
|
+ type: hostpath
|
|
|
+ show_if: [["type", "=", "hostPath"]]
|
|
|
+ immutable: true
|
|
|
+ required: true
|
|
|
+
|
|
|
+ - variable: pgData
|
|
|
+ label: Paperless-ngx Postgres Data Storage
|
|
|
+ description: The path to store Paperless-ngx Postgres Data.
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: type
|
|
|
+ label: Type
|
|
|
+ description: |
|
|
|
+ ixVolume: Is dataset created automatically by the system.</br>
|
|
|
+ Host Path: Is a path that already exists on the system.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+ default: ixVolume
|
|
|
+ enum:
|
|
|
+ - value: hostPath
|
|
|
+ description: Host Path (Path that already exists on the system)
|
|
|
+ - value: ixVolume
|
|
|
+ description: ixVolume (Dataset created automatically by the system)
|
|
|
+ - variable: datasetName
|
|
|
+ label: Dataset Name
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ show_if: [["type", "=", "ixVolume"]]
|
|
|
+ required: true
|
|
|
+ hidden: true
|
|
|
+ immutable: true
|
|
|
+ default: pgData
|
|
|
+ $ref:
|
|
|
+ - "normalize/ixVolume"
|
|
|
+ - variable: hostPath
|
|
|
+ label: Host Path
|
|
|
+ schema:
|
|
|
+ type: hostpath
|
|
|
+ show_if: [["type", "=", "hostPath"]]
|
|
|
+ immutable: true
|
|
|
+ required: true
|
|
|
+ - variable: pgBackup
|
|
|
+ label: Paperless-ngx Postgres Backup Storage
|
|
|
+ description: The path to store Paperless-ngx Postgres Backup.
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: type
|
|
|
+ label: Type
|
|
|
+ description: |
|
|
|
+ ixVolume: Is dataset created automatically by the system.</br>
|
|
|
+ Host Path: Is a path that already exists on the system.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+ default: ixVolume
|
|
|
+ enum:
|
|
|
+ - value: hostPath
|
|
|
+ description: Host Path (Path that already exists on the system)
|
|
|
+ - value: ixVolume
|
|
|
+ description: ixVolume (Dataset created automatically by the system)
|
|
|
+ - variable: datasetName
|
|
|
+ label: Dataset Name
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ show_if: [["type", "=", "ixVolume"]]
|
|
|
+ required: true
|
|
|
+ hidden: true
|
|
|
+ immutable: true
|
|
|
+ default: pgBackup
|
|
|
+ $ref:
|
|
|
+ - "normalize/ixVolume"
|
|
|
+ - variable: hostPath
|
|
|
+ label: Host Path
|
|
|
+ schema:
|
|
|
+ type: hostpath
|
|
|
+ show_if: [["type", "=", "hostPath"]]
|
|
|
+ immutable: true
|
|
|
+ required: true
|
|
|
+
|
|
|
+ - variable: additionalStorages
|
|
|
+ label: Additional Storage
|
|
|
+ description: Additional storage for Paperless-ngx.
|
|
|
+ schema:
|
|
|
+ type: list
|
|
|
+ default: []
|
|
|
+ items:
|
|
|
+ - variable: storageEntry
|
|
|
+ label: Storage Entry
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: type
|
|
|
+ label: Type
|
|
|
+ description: |
|
|
|
+ ixVolume: Is dataset created automatically by the system.</br>
|
|
|
+ Host Path: Is a path that already exists on the system.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ required: true
|
|
|
+ default: "ixVolume"
|
|
|
+ enum:
|
|
|
+ - value: "hostPath"
|
|
|
+ description: Host Path (Path that already exists on the system)
|
|
|
+ - value: "ixVolume"
|
|
|
+ description: ixVolume (Dataset created automatically by the system)
|
|
|
+ - variable: mountPath
|
|
|
+ label: Mount Path
|
|
|
+ description: The path inside the container to mount the storage.
|
|
|
+ schema:
|
|
|
+ type: path
|
|
|
+ required: true
|
|
|
+ - variable: hostPath
|
|
|
+ label: Host Path
|
|
|
+ description: The host path to use for storage.
|
|
|
+ schema:
|
|
|
+ type: hostpath
|
|
|
+ show_if: [["type", "=", "hostPath"]]
|
|
|
+ required: true
|
|
|
+ - variable: datasetName
|
|
|
+ label: Dataset Name
|
|
|
+ description: The name of the dataset to use for storage.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ show_if: [["type", "=", "ixVolume"]]
|
|
|
+ required: true
|
|
|
+ immutable: true
|
|
|
+ default: "storage_entry"
|
|
|
+ $ref:
|
|
|
+ - "normalize/ixVolume"
|
|
|
+
|
|
|
+ - variable: resources
|
|
|
+ group: Resources Configuration
|
|
|
+ label: ""
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: limits
|
|
|
+ label: Limits
|
|
|
+ schema:
|
|
|
+ type: dict
|
|
|
+ attrs:
|
|
|
+ - variable: cpu
|
|
|
+ label: CPU
|
|
|
+ description: CPU limit for Paperless-ngx.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ max_length: 6
|
|
|
+ valid_chars: '^(0\.[1-9]|[1-9][0-9]*)(\.[0-9]|m?)$'
|
|
|
+ valid_chars_error: |
|
|
|
+ Valid CPU limit formats are</br>
|
|
|
+ - Plain Integer - eg. 1</br>
|
|
|
+ - Float - eg. 0.5</br>
|
|
|
+ - Milicpu - eg. 500m
|
|
|
+ default: "4000m"
|
|
|
+ required: true
|
|
|
+ - variable: memory
|
|
|
+ label: Memory
|
|
|
+ description: Memory limit for Paperless-ngx.
|
|
|
+ schema:
|
|
|
+ type: string
|
|
|
+ max_length: 12
|
|
|
+ valid_chars: '^[1-9][0-9]*([EPTGMK]i?|e[0-9]+)?$'
|
|
|
+ valid_chars_error: |
|
|
|
+ Valid Memory limit formats are</br>
|
|
|
+ - Suffixed with E/P/T/G/M/K - eg. 1G</br>
|
|
|
+ - Suffixed with Ei/Pi/Ti/Gi/Mi/Ki - eg. 1Gi</br>
|
|
|
+ - Plain Integer in bytes - eg. 1024</br>
|
|
|
+ - Exponent - eg. 134e6
|
|
|
+ default: "8Gi"
|
|
|
+ required: true
|
Stavros Kois