truenas/library/ix-dev/community/sftpgo/questions.yaml

groups:
  - name: SFTPGo Configuration
    description: Configure SFTPGo
  - name: User and Group Configuration
    description: Configure User and Group for SFTPGo
  - name: Network Configuration
    description: Configure Network for SFTPGo
  - name: Storage Configuration
    description: Configure Storage for SFTPGo
  - name: Resources Configuration
    description: Configure Resources for SFTPGo

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: sftpgoConfig
    label: ""
    group: SFTPGo Configuration
    schema:
      type: dict
      attrs:
        - variable: imageSelector
          label: Image Selector
          description: The image to use for SFTPGo.
          schema:
            type: string
            default: "image"
            required: true
            enum:
              - value: "image"
                description: Default Image
              - value: "pluginsImage"
                description: Plugins Image
        - variable: graceTime
          label: Grace Time
          description: The time in seconds to wait for connections to close before shutting down.
          schema:
            type: int
            default: 60
            min: 1
            required: true
        - variable: additionalEnvs
          label: Additional Environment Variables
          description: Configure additional environment variables for SFTPGo.
          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: sftpgoRunAs
    label: ""
    group: User and Group Configuration
    schema:
      type: dict
      attrs:
        - variable: user
          label: User ID
          description: The user id that SFTPGo will run as.
          schema:
            type: int
            min: 2
            default: 568
            required: true
        - variable: group
          label: Group ID
          description: The group id that SFTPGo will run as.
          schema:
            type: int
            min: 2
            default: 568
            required: true

  - variable: sftpgoNetwork
    label: ""
    group: Network Configuration
    schema:
      type: dict
      attrs:
        - 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: certificateID
          label: Certificate
          description: The certificate to use for SFTPGo WebUI
          schema:
            type: int
            "null": true
            $ref:
              - "definitions/certificate"
        - variable: webPort
          label: Web Port
          description: The port for the SFTPGo Web UI.
          schema:
            type: int
            default: 30086
            min: 9000
            max: 65535
            required: true
        - variable: webdavdServices
          label: WebDAVd Services
          description: Enable one or more WebDAVd services.
          schema:
            type: list
            default: []
            items:
              - variable: webdavdServiceEntry
                label: WebDAVd Service Entry
                schema:
                  type: dict
                  attrs:
                    - variable: enabled
                      label: Enabled
                      description: Enable this WebDAVd service.
                      schema:
                        type: boolean
                        default: false
                    - variable: port
                      label: Port
                      description: The port for WebDAVd.
                      schema:
                        type: int
                        default: 30089
                        min: 9000
                        max: 65535
                        required: true
        - variable: sftpdServices
          label: SFTPd Services
          description: Enable one or more SFTPd services.
          schema:
            type: list
            default: []
            items:
              - variable: sftpdServiceEntry
                label: SFTPd Service Entry
                schema:
                  type: dict
                  attrs:
                    - variable: enabled
                      label: Enabled
                      description: Enable this SFTPd service.
                      schema:
                        type: boolean
                        default: false
                    - variable: port
                      label: Port
                      description: The port for SFTPd.
                      schema:
                        type: int
                        default: 30087
                        min: 9000
                        max: 65535
                        required: true
        - variable: ftpdServices
          label: FTPd Services
          description: Enable one or more FTPd services.
          schema:
            type: list
            default: []
            items:
              - variable: ftpdServiceEntry
                label: FTPd Service Entry
                schema:
                  type: dict
                  attrs:
                    - variable: enabled
                      label: Enabled
                      description: Enable this FTPd service.
                      schema:
                        type: boolean
                        default: false
                    - variable: port
                      label: Port
                      description: The port for FTPd.
                      schema:
                        type: int
                        default: 30088
                        min: 9000
                        max: 65535
                        required: true
        - variable: ftpdPassivePortRange
          label: FTPd Passive Port Range
          description: The port range for FTPd passive connections.
          schema:
            type: dict
            show_if: [["ftpdServices", "!=", []]]
            attrs:
              - variable: start
                label: Start
                description: The start of the port range.
                schema:
                  type: int
                  default: 50000
                  min: 9000
                  max: 65535
                  required: true
              - variable: end
                label: End
                description: The end of the port range.
                schema:
                  type: int
                  default: 50001
                  min: 9000
                  max: 65535
                  required: true

  - variable: sftpgoStorage
    label: ""
    group: Storage Configuration
    schema:
      type: dict
      attrs:
        - variable: config
          label: SFTPGo Config Storage
          description: The path to store SFTPGo Configuration.
          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
                  immutable: 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: "config"
                  $ref:
                    - "normalize/ixVolume"
              - variable: hostPath
                label: Host Path
                schema:
                  type: hostpath
                  show_if: [["type", "=", "hostPath"]]
                  required: true
        - variable: data
          label: SFTPGo Data Storage
          description: The path to store SFTPGo 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
                  immutable: 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"]]
                  required: true
        - variable: backups
          label: SFTPGo Backups Storage
          description: The path to store SFTPGo Backups.
          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
                  immutable: 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: "backups"
                  $ref:
                    - "normalize/ixVolume"
              - variable: hostPath
                label: Host Path
                schema:
                  type: hostpath
                  show_if: [["type", "=", "hostPath"]]
                  required: true
        - variable: additionalStorages
          label: Additional Storage
          description: Additional storage for SFTPGo.
          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.</br>
                        SMB Share: Is a SMB share that is mounted to a persistent volume claim.
                      schema:
                        type: string
                        required: true
                        default: "ixVolume"
                        immutable: true
                        enum:
                          - value: "hostPath"
                            description: Host Path (Path that already exists on the system)
                          - value: "ixVolume"
                            description: ixVolume (Dataset created automatically by the system)
                          - value: "smb-pv-pvc"
                            description: SMB Share (Mounts a persistent volume claim to a SMB share)
                    - 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: server
                      label: Server
                      description: The server for the SMB share.
                      schema:
                        type: string
                        show_if: [["type", "=", "smb-pv-pvc"]]
                        required: true
                    - variable: share
                      label: Share
                      description: The share name for the SMB share.
                      schema:
                        type: string
                        show_if: [["type", "=", "smb-pv-pvc"]]
                        required: true
                    - variable: domain
                      label: Domain (Optional)
                      description: The domain for the SMB share.
                      schema:
                        type: string
                        show_if: [["type", "=", "smb-pv-pvc"]]
                    - variable: username
                      label: Username
                      description: The username for the SMB share.
                      schema:
                        type: string
                        show_if: [["type", "=", "smb-pv-pvc"]]
                        required: true
                    - variable: password
                      label: Password
                      description: The password for the SMB share.
                      schema:
                        type: string
                        show_if: [["type", "=", "smb-pv-pvc"]]
                        required: true
                        private: true
                    - variable: size
                      label: Size (in Gi)
                      description: The size of the volume quota.
                      schema:
                        type: int
                        show_if: [["type", "=", "smb-pv-pvc"]]
                        required: true
                        min: 1
                        default: 1

  - 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 SFTPGo.
                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 SFTPGo.
                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