apps/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: Labels Configuration
    description: Configure Labels for SFTPGo
  - name: Resources Configuration
    description: Configure Resources for SFTPGo

questions:
  - variable: sftpgo
    label: ""
    group: SFTPGo Configuration
    schema:
      type: dict
      attrs:
        - variable: image_selector
          label: Image
          description: The image to use for SFTPGo.
          schema:
            type: string
            default: image
            required: true
            enum:
              - value: image
                description: Normal Image
              - value: plugins_image
                description: Plugins Image
        - variable: stop_grace_period
          label: Stop Grace Period
          description: The time in seconds given to SFTPGo to stop before it is killed.
          schema:
            type: int
            min: 1
            default: 60
            required: true
        - variable: additional_envs
          label: Additional Environment Variables
          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
  - variable: run_as
    label: ""
    group: User and Group Configuration
    schema:
      type: dict
      attrs:
        - variable: user
          label: User ID
          description: The user id that SFTPGo files will be owned by.
          schema:
            type: int
            min: 568
            default: 568
            required: true
        - variable: group
          label: Group ID
          description: The group id that SFTPGo files will be owned by.
          schema:
            type: int
            min: 568
            default: 568
            required: true

  - variable: network
    label: ""
    group: Network Configuration
    schema:
      type: dict
      attrs:
        - variable: web_port
          label: WebUI Port
          schema:
            type: dict
            attrs:
              - variable: bind_mode
                label: Port Bind Mode
                description: |
                  The port bind mode.</br>
                  - Publish: The port will be published on the host for external access.</br>
                  - Expose: The port will be exposed for inter-container communication.</br>
                  - None: The port will not be exposed or published.</br>
                  Note: If the Dockerfile defines an EXPOSE directive,
                  the port will still be exposed for inter-container communication regardless of this setting.
                schema:
                  type: string
                  default: "published"
                  enum:
                    - value: "published"
                      description: Publish port on the host for external access
                    - value: "exposed"
                      description: Expose port for inter-container communication
                    - value: ""
                      description: None
              - variable: port_number
                label: Port Number
                schema:
                  type: int
                  default: 30112
                  min: 1
                  max: 65535
                  required: true
              - variable: host_ips
                label: Host IPs
                description: IPs on the host to bind this port
                schema:
                  type: list
                  show_if: [["bind_mode", "=", "published"]]
                  default: []
                  items:
                    - variable: host_ip
                      label: Host IP
                      schema:
                        type: string
                        required: true
                        $ref:
                          - definitions/node_bind_ip
        - variable: telemetry_port
          label: Telemetry Port
          schema:
            type: dict
            attrs:
              - variable: bind_mode
                label: Port Bind Mode
                description: |
                  The port bind mode.</br>
                  - Publish: The port will be published on the host for external access.</br>
                  - Expose: The port will be exposed for inter-container communication.</br>
                  - None: The port will not be exposed or published.</br>
                  Note: If the Dockerfile defines an EXPOSE directive,
                  the port will still be exposed for inter-container communication regardless of this setting.
                schema:
                  type: string
                  default: ""
                  enum:
                    - value: "published"
                      description: Publish port on the host for external access
                    - value: "exposed"
                      description: Expose port for inter-container communication
                    - value: ""
                      description: None
              - variable: port_number
                label: Port Number
                schema:
                  type: int
                  default: 30126
                  min: 1
                  max: 65535
                  required: true
              - variable: host_ips
                label: Host IPs
                description: IPs on the host to bind this port
                schema:
                  type: list
                  show_if: [["bind_mode", "=", "published"]]
                  default: []
                  items:
                    - variable: host_ip
                      label: Host IP
                      schema:
                        type: string
                        required: true
                        $ref:
                          - definitions/node_bind_ip
        - variable: host_network
          label: Host Network
          description: |
            Bind to the host network. It's recommended to keep this disabled.
          schema:
            type: boolean
            default: false
        - variable: certificate_id
          label: Certificate ID
          description: The certificate id to use for SFTPGo.
          schema:
            type: int
            "null": true
            $ref:
              - definitions/certificate
        - variable: sftpd_services
          label: SFTPD Services
          description: Enable one or more SFTPd services.
          schema:
            type: list
            default: []
            items:
              - variable: sftpd_entry
                label: SFTPD Entry
                schema:
                  type: dict
                  attrs:
                    - variable: enabled
                      label: Enabled
                      description: Enable the service.
                      schema:
                        type: boolean
                        default: true
                    - variable: port
                      label: Port
                      description: |
                        The port for the service.</br>
                        Port set here will be used both inside and outside the container.
                      schema:
                        type: dict
                        attrs:
                          - variable: bind_mode
                            label: Port Bind Mode
                            description: |
                              The port bind mode.</br>
                              - Publish: The port will be published on the host for external access.</br>
                              - Expose: The port will be exposed for inter-container communication.</br>
                              - None: The port will not be exposed or published.</br>
                              Note: If the Dockerfile defines an EXPOSE directive,
                              the port will still be exposed for inter-container communication regardless of this setting.
                            schema:
                              type: string
                              default: "published"
                              enum:
                                - value: "published"
                                  description: Publish port on the host for external access
                                - value: "exposed"
                                  description: Expose port for inter-container communication
                                - value: ""
                                  description: None
                          - variable: port_number
                            label: Port Number
                            schema:
                              type: int
                              required: true
                              $ref:
                                - definitions/port
                          - variable: host_ips
                            label: Host IPs
                            description: IPs on the host to bind this port
                            schema:
                              type: list
                              default: []
                              items:
                                - variable: host_ip
                                  label: Host IP
                                  schema:
                                    type: string
                                    required: true
                                    $ref:
                                      - definitions/node_bind_ip
        - variable: webdavd_services
          label: WebDAVD Services
          description: Enable one or more WebDAVD services.
          schema:
            type: list
            default: []
            items:
              - variable: webdavd_entry
                label: WebDAVD Entry
                schema:
                  type: dict
                  attrs:
                    - variable: enabled
                      label: Enabled
                      description: Enable the service.
                      schema:
                        type: boolean
                        default: true
                    - variable: port
                      label: Port
                      description: |
                        The port for the service.</br>
                        Port set here will be used both inside and outside the container.
                      schema:
                        type: dict
                        attrs:
                          - variable: bind_mode
                            label: Port Bind Mode
                            description: |
                              The port bind mode.</br>
                              - Publish: The port will be published on the host for external access.</br>
                              - Expose: The port will be exposed for inter-container communication.</br>
                              - None: The port will not be exposed or published.</br>
                              Note: If the Dockerfile defines an EXPOSE directive,
                              the port will still be exposed for inter-container communication regardless of this setting.
                            schema:
                              type: string
                              default: "published"
                              enum:
                                - value: "published"
                                  description: Publish port on the host for external access
                                - value: "exposed"
                                  description: Expose port for inter-container communication
                                - value: ""
                                  description: None
                          - variable: port_number
                            label: Port Number
                            schema:
                              type: int
                              required: true
                              $ref:
                                - definitions/port
                          - variable: host_ips
                            label: Host IPs
                            description: IPs on the host to bind this port
                            schema:
                              type: list
                              default: []
                              items:
                                - variable: host_ip
                                  label: Host IP
                                  schema:
                                    type: string
                                    required: true
                                    $ref:
                                      - definitions/node_bind_ip
        - variable: ftpd_services
          label: FTPD Services
          description: Enable one or more FTPD services.
          schema:
            type: list
            default: []
            items:
              - variable: ftpd_entry
                label: FTPD Entry
                schema:
                  type: dict
                  attrs:
                    - variable: enabled
                      label: Enabled
                      description: Enable the service.
                      schema:
                        type: boolean
                        default: true
                    - variable: port
                      label: Port
                      description: |
                        The port for the service.</br>
                        Port set here will be used both inside and outside the container.
                      schema:
                        type: dict
                        attrs:
                          - variable: bind_mode
                            label: Port Bind Mode
                            description: |
                              The port bind mode.</br>
                              - Publish: The port will be published on the host for external access.</br>
                              - Expose: The port will be exposed for inter-container communication.</br>
                              - None: The port will not be exposed or published.</br>
                              Note: If the Dockerfile defines an EXPOSE directive,
                              the port will still be exposed for inter-container communication regardless of this setting.
                            schema:
                              type: string
                              default: "published"
                              enum:
                                - value: "published"
                                  description: Publish port on the host for external access
                                - value: "exposed"
                                  description: Expose port for inter-container communication
                                - value: ""
                                  description: None
                          - variable: port_number
                            label: Port Number
                            schema:
                              type: int
                              required: true
                              $ref:
                                - definitions/port
                          - variable: host_ips
                            label: Host IPs
                            description: IPs on the host to bind this port
                            schema:
                              type: list
                              default: []
                              items:
                                - variable: host_ip
                                  label: Host IP
                                  schema:
                                    type: string
                                    required: true
                                    $ref:
                                      - definitions/node_bind_ip
        - variable: ftpd_passive_port_range
          label: FTPD Passive Port Range
          description: |
            The range of ports for passive FTPD services.</br>
            Note that you have to make sure that ports
            within the range are not used by other services.
          schema:
            type: dict
            show_if: [["ftpd_services", "!=", []]]
            attrs:
              - variable: bind_mode
                label: Port Bind Mode
                description: |
                  The port bind mode.</br>
                  - Publish: The port will be published on the host for external access.</br>
                  - Expose: The port will be exposed for inter-container communication.</br>
                  Note: If the Dockerfile defines an EXPOSE directive,
                  the port will still be exposed for inter-container communication regardless of this setting.
                schema:
                  type: string
                  default: "published"
                  enum:
                    - value: "published"
                      description: Publish port on the host for external access
                    - value: "exposed"
                      description: Expose port for inter-container communication
              - variable: start
                label: Start
                description: The start of the range.
                schema:
                  type: int
                  min: 1
                  max: 65535
                  required: true
              - variable: end
                label: End
                description: The end of the range.
                schema:
                  type: int
                  min: 1
                  max: 65535
                  required: true
              - variable: host_ips
                label: Host IPs
                description: IPs on the host to bind this port
                schema:
                  type: list
                  show_if: [["bind_mode", "=", "published"]]
                  default: []
                  items:
                    - variable: host_ip
                      label: Host IP
                      schema:
                        type: string
                        required: true
                        $ref:
                          - definitions/node_bind_ip

  - variable: storage
    label: ""
    group: Storage Configuration
    schema:
      type: dict
      attrs:
        - variable: config
          label: SFTPGo Config Storage
          description: The path to store SFTPGo Config.
          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: "ix_volume"
                  enum:
                    - value: "host_path"
                      description: Host Path (Path that already exists on the system)
                    - value: "ix_volume"
                      description: ixVolume (Dataset created automatically by the system)
              - variable: ix_volume_config
                label: ixVolume Configuration
                description: The configuration for the ixVolume dataset.
                schema:
                  type: dict
                  show_if: [["type", "=", "ix_volume"]]
                  $ref:
                    - "normalize/ix_volume"
                  attrs:
                    - variable: acl_enable
                      label: Enable ACL
                      description: Enable ACL for the storage.
                      schema:
                        type: boolean
                        default: false
                    - variable: dataset_name
                      label: Dataset Name
                      description: The name of the dataset to use for storage.
                      schema:
                        type: string
                        required: true
                        hidden: true
                        default: "config"
                    - variable: acl_entries
                      label: ACL Configuration
                      schema:
                        type: dict
                        show_if: [["acl_enable", "=", true]]
                        attrs: []
              - variable: host_path_config
                label: Host Path Configuration
                schema:
                  type: dict
                  show_if: [["type", "=", "host_path"]]
                  attrs:
                    - variable: acl_enable
                      label: Enable ACL
                      description: Enable ACL for the storage.
                      schema:
                        type: boolean
                        default: false
                    - variable: acl
                      label: ACL Configuration
                      schema:
                        type: dict
                        show_if: [["acl_enable", "=", true]]
                        attrs: []
                        $ref:
                          - "normalize/acl"
                    - variable: path
                      label: Host Path
                      description: The host path to use for storage.
                      schema:
                        type: hostpath
                        show_if: [["acl_enable", "=", false]]
                        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
                  default: "ix_volume"
                  enum:
                    - value: "host_path"
                      description: Host Path (Path that already exists on the system)
                    - value: "ix_volume"
                      description: ixVolume (Dataset created automatically by the system)
              - variable: ix_volume_config
                label: ixVolume Configuration
                description: The configuration for the ixVolume dataset.
                schema:
                  type: dict
                  show_if: [["type", "=", "ix_volume"]]
                  $ref:
                    - "normalize/ix_volume"
                  attrs:
                    - variable: acl_enable
                      label: Enable ACL
                      description: Enable ACL for the storage.
                      schema:
                        type: boolean
                        default: false
                    - variable: dataset_name
                      label: Dataset Name
                      description: The name of the dataset to use for storage.
                      schema:
                        type: string
                        required: true
                        hidden: true
                        default: "data"
                    - variable: acl_entries
                      label: ACL Configuration
                      schema:
                        type: dict
                        show_if: [["acl_enable", "=", true]]
                        attrs: []
              - variable: host_path_config
                label: Host Path Configuration
                schema:
                  type: dict
                  show_if: [["type", "=", "host_path"]]
                  attrs:
                    - variable: acl_enable
                      label: Enable ACL
                      description: Enable ACL for the storage.
                      schema:
                        type: boolean
                        default: false
                    - variable: acl
                      label: ACL Configuration
                      schema:
                        type: dict
                        show_if: [["acl_enable", "=", true]]
                        attrs: []
                        $ref:
                          - "normalize/acl"
                    - variable: path
                      label: Host Path
                      description: The host path to use for storage.
                      schema:
                        type: hostpath
                        show_if: [["acl_enable", "=", false]]
                        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
                  default: "ix_volume"
                  enum:
                    - value: "host_path"
                      description: Host Path (Path that already exists on the system)
                    - value: "ix_volume"
                      description: ixVolume (Dataset created automatically by the system)
              - variable: ix_volume_config
                label: ixVolume Configuration
                description: The configuration for the ixVolume dataset.
                schema:
                  type: dict
                  show_if: [["type", "=", "ix_volume"]]
                  $ref:
                    - "normalize/ix_volume"
                  attrs:
                    - variable: acl_enable
                      label: Enable ACL
                      description: Enable ACL for the storage.
                      schema:
                        type: boolean
                        default: false
                    - variable: dataset_name
                      label: Dataset Name
                      description: The name of the dataset to use for storage.
                      schema:
                        type: string
                        required: true
                        hidden: true
                        default: "data"
                    - variable: acl_entries
                      label: ACL Configuration
                      schema:
                        type: dict
                        show_if: [["acl_enable", "=", true]]
                        attrs: []
              - variable: host_path_config
                label: Host Path Configuration
                schema:
                  type: dict
                  show_if: [["type", "=", "host_path"]]
                  attrs:
                    - variable: acl_enable
                      label: Enable ACL
                      description: Enable ACL for the storage.
                      schema:
                        type: boolean
                        default: false
                    - variable: acl
                      label: ACL Configuration
                      schema:
                        type: dict
                        show_if: [["acl_enable", "=", true]]
                        attrs: []
                        $ref:
                          - "normalize/acl"
                    - variable: path
                      label: Host Path
                      description: The host path to use for storage.
                      schema:
                        type: hostpath
                        show_if: [["acl_enable", "=", false]]
                        required: true
        - variable: additional_storage
          label: Additional Storage
          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 as a volume.
                      schema:
                        type: string
                        required: true
                        default: "ix_volume"
                        enum:
                          - value: "host_path"
                            description: Host Path (Path that already exists on the system)
                          - value: "ix_volume"
                            description: ixVolume (Dataset created automatically by the system)
                          - value: "cifs"
                            description: SMB/CIFS Share (Mounts a volume to a SMB share)
                    - variable: read_only
                      label: Read Only
                      description: Mount the volume as read only.
                      schema:
                        type: boolean
                        default: false
                    - variable: mount_path
                      label: Mount Path
                      description: The path inside the container to mount the storage.
                      schema:
                        type: path
                        required: true
                    - variable: host_path_config
                      label: Host Path Configuration
                      schema:
                        type: dict
                        show_if: [["type", "=", "host_path"]]
                        attrs:
                          - variable: acl_enable
                            label: Enable ACL
                            description: Enable ACL for the storage.
                            schema:
                              type: boolean
                              default: false
                          - variable: acl
                            label: ACL Configuration
                            schema:
                              type: dict
                              show_if: [["acl_enable", "=", true]]
                              attrs: []
                              $ref:
                                - "normalize/acl"
                          - variable: path
                            label: Host Path
                            description: The host path to use for storage.
                            schema:
                              type: hostpath
                              show_if: [["acl_enable", "=", false]]
                              required: true
                    - variable: ix_volume_config
                      label: ixVolume Configuration
                      description: The configuration for the ixVolume dataset.
                      schema:
                        type: dict
                        show_if: [["type", "=", "ix_volume"]]
                        $ref:
                          - "normalize/ix_volume"
                        attrs:
                          - variable: acl_enable
                            label: Enable ACL
                            description: Enable ACL for the storage.
                            schema:
                              type: boolean
                              default: false
                          - variable: dataset_name
                            label: Dataset Name
                            description: The name of the dataset to use for storage.
                            schema:
                              type: string
                              required: true
                              default: "storage_entry"
                          - variable: acl_entries
                            label: ACL Configuration
                            schema:
                              type: dict
                              show_if: [["acl_enable", "=", true]]
                              attrs: []
                              $ref:
                                - "normalize/acl"
                    - variable: cifs_config
                      label: SMB Configuration
                      description: The configuration for the SMB dataset.
                      schema:
                        type: dict
                        show_if: [["type", "=", "cifs"]]
                        attrs:
                          - variable: server
                            label: Server
                            description: The server to mount the SMB share.
                            schema:
                              type: string
                              required: true
                          - variable: path
                            label: Path
                            description: The path to mount the SMB share.
                            schema:
                              type: string
                              required: true
                          - variable: username
                            label: Username
                            description: The username to use for the SMB share.
                            schema:
                              type: string
                              required: true
                          - variable: password
                            label: Password
                            description: The password to use for the SMB share.
                            schema:
                              type: string
                              required: true
                              private: true
                          - variable: domain
                            label: Domain
                            description: The domain to use for the SMB share.
                            schema:
                              type: string
  - variable: labels
    label: ""
    group: Labels Configuration
    schema:
      type: list
      default: []
      items:
        - variable: label
          label: Label
          schema:
            type: dict
            attrs:
              - variable: key
                label: Key
                schema:
                  type: string
                  required: true
              - variable: value
                label: Value
                schema:
                  type: string
                  required: true
              - variable: containers
                label: Containers
                description: Containers where the label should be applied
                schema:
                  type: list
                  items:
                    - variable: container
                      label: Container
                      schema:
                        type: string
                        required: true
                        enum:
                          - value: sftpgo
                            description: sftpgo

  - variable: resources
    label: ""
    group: Resources Configuration
    schema:
      type: dict
      attrs:
        - variable: limits
          label: Limits
          schema:
            type: dict
            attrs:
              - variable: cpus
                label: CPUs
                description: CPUs limit for SFTPGo.
                schema:
                  type: int
                  default: 2
                  required: true
              - variable: memory
                label: Memory (in MB)
                description: Memory limit for SFTPGo.
                schema:
                  type: int
                  default: 4096
                  required: true