description:Restrict upload ans user creation to one or more IP range (CIDR notation, /32 can be omitted)
schema:
type:list
default:[]
items:
- variable:ip
label:IP Entry
description:
schema:
type:string
required:true
default:""
- variable:files
label:Files
schema:
additional_attrs:true
type:dict
attrs:
- variable:max_file_size
label:Max File Size
schema:
type:string
required:true
default:10GB
- variable:max_files_per_upload
label:Max Files Per Upload
schema:
type:int
required:true
default:1000
- variable:default_ttl
label:Default TTL
schema:
type:string
required:true
default:30d
- variable:max_ttl
label:Max TTL
schema:
type:string
required:true
default:30d
- variable:data_backend
label:Data Backend
schema:
type:string
required:true
default:file
enum:
- value:file
description:File
- value:s3
description:S3
- value:gcs
description:Google Cloud Storage
- value:swift
description:Swift
- variable:gcs
label:Google Cloud Storage
schema:
additional_attrs:true
show_if:[["data_backend","=","gcs"]]
type:dict
attrs:
- variable:bucket
label:Bucket
schema:
type:string
required:true
default:""
- variable:folder
label:Folder
schema:
type:string
required:true
default:""
- variable:s3
label:S3
schema:
additional_attrs:true
show_if:[["data_backend","=","s3"]]
type:dict
attrs:
- variable:bucket
label:Bucket
schema:
type:string
required:true
default:""
- variable:endpoint
label:Endpoint
schema:
type:string
required:true
default:""
- variable:access_key_id
label:Access Key ID
schema:
type:string
required:true
private:true
default:""
- variable:secret_access_key
label:Secret Access Key
schema:
type:string
required:true
private:true
default:""
- variable:location
label:Location
schema:
type:string
required:true
default:""
- variable:prefix
label:Prefix
schema:
type:string
required:true
default:""
- variable:use_ssl
label:Use SSL
schema:
type:boolean
default:true
- variable:part_size
label:Part Size
description:Chunk size when file size is not known. Multiply by 10000 to get the max upload file size.
schema:
type:int
required:true
default:16000000
- variable:sse
label:SSE
description:SSE-C - Server-Side-Encryption with customer provided keys (Managed by Plik) / S3 - Server-Side-Encryption using S3 storage encryption (Managed by S3 Backend)
schema:
type:string
default:""
enum:
- value:""
description:None
- value:SSE-C
description:SSE-C
- value:S3
description:S3
- variable:swift
label:Swift
schema:
additional_attrs:true
show_if:[["data_backend","=","swift"]]
type:dict
attrs:
- variable:container
label:Container
schema:
type:string
required:true
default:""
- variable:auth_url
label:Auth URL
schema:
type:string
required:true
default:https://auth.swiftauthapi.xxx/v2.0/
- variable:username
label:Username
schema:
type:string
required:true
default:""
- variable:api_key
label:API Key
schema:
type:string
required:true
private:true
default:""
- variable:domain
label:Domain
description:Name of the domain (v3 auth only)
schema:
type:string
default:""
- variable:tenant
description:Name of the tenant (v2 auth only)
label:Tenant
schema:
type:string
default:""
- variable:features
label:Features
schema:
additional_attrs:true
type:dict
attrs:
- variable:authentication
label:Authentication
description:disabled -> no authentication / forced -> no anonymous upload / default -> enabled
schema:
type:string
required:true
default:disabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:one_shot
label:One Shot
description:Upload with files that are automatically deleted after the first download
schema:
type:string
required:true
default:enabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:removable
label:Removable
description:Upload with files that anybody can delete
schema:
type:string
required:true
default:enabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:stream
label:Stream
description:Upload with files that are not stored on the server
schema:
type:string
required:true
default:enabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:password
label:Password
description:Upload that are protected by HTTP basic auth login/password
schema:
type:string
required:true
default:enabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:comments
label:Comments
description:Upload with markdown comments / forced -> default
schema:
type:string
required:true
default:enabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:set_ttl
label:Set TTL
description:When disabled upload TTL is always set to DefaultTTL
schema:
type:string
required:true
default:enabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:extend_ttl
label:Extend TTL
description:Extend upload expiration date by TTL each time it is accessed
schema:
type:string
required:true
default:disabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:clients
label:Clients
description:Display the clients download button in the web UI
schema:
type:string
required:true
default:enabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:github
label:Github
description:Display the source code link in the web UI
schema:
type:string
required:true
default:enabled
enum:
- value:disabled
description:Disabled - Feature is always off
- value:enabled
description:Enabled - Feature is opt-in
- value:default
description:Default - Feature is opt-out
- value:forced
description:Forced - Feature is always on
- variable:third_party
label:Third Party
schema:
additional_attrs:true
type:dict
attrs:
- variable:google_api_client_id
label:Google API Client ID
schema:
type:string
private:true
default:""
- variable:google_api_secret
label:Google API Secret
schema:
type:string
private:true
default:""
- variable:google_valid_domains
label:Google Valid Domains
description:List of acceptable email domains for users
schema:
type:list
default:[]
items:
- variable:domain
label:Domain Entry
description:
schema:
type:string
required:true
default:""
- variable:ovh_api_key
label:OVH API Key
schema:
type:string
private:true
default:""
- variable:ovh_api_secret
label:OVH API Secret
schema:
type:string
private:true
default:""
- variable:ovh_api_endpoint
label:OVH API Secret
schema:
type:string
default:https://eu.api.ovh.com/1.0
- variable:TZ
label:Timezone
group:"General Settings"
schema:
type:string
default:"Etc/UTC"
$ref:
- "definitions/timezone"
- variable:envList
label:Extra Environment Variables
description:"Please be aware that some variables are set in the background, adding duplicates here might cause issues or prevent the app from starting..."
group:"General Settings"
schema:
type:list
default:[]
items:
- variable:envItem
label:Environment Variable
schema:
additional_attrs:true
type:dict
attrs:
- variable:name
label:Name
schema:
type:string
- variable:value
label:Value
schema:
type:string
- variable:service
group:Networking and Services
label:Configure Service(s)
schema:
additional_attrs:true
type:dict
attrs:
- variable:main
label:Main Service
description:The Primary service on which the healthcheck runs, often the webUI
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the Service
schema:
type:boolean
default:true
hidden:true
- variable:type
label:Service Type
description:"ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
schema:
type:string
default:LoadBalancer
enum:
- value:LoadBalancer
description:LoadBalancer (Expose Ports)
- value:ClusterIP
description:ClusterIP (Do Not Expose Ports)
- value:Simple
description:Deprecated CHANGE THIS
- variable:loadBalancerIP
label:LoadBalancer IP
description:"MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
schema:
show_if:[["type","=","LoadBalancer"]]
type:string
default:""
- variable:ports
label:"Service's Port(s) Configuration"
schema:
additional_attrs:true
type:dict
attrs:
- variable:main
label:Main Service Port Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:port
label:Port
description:This port exposes the container port on the service
schema:
type:int
default:10599
required:true
- variable:serviceexpert
group:Networking and Services
label:Show Expert Config
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:hostNetwork
group:Networking and Services
label:Host-Networking (Complicated)
schema:
type:boolean
default:false
- variable:externalInterfaces
description:Add External Interfaces
label:Add external Interfaces
group:Networking
schema:
type:list
items:
- variable:interfaceConfiguration
description:Interface Configuration
label:Interface Configuration
schema:
type:dict
$ref:
- "normalize/interfaceConfiguration"
attrs:
- variable:hostInterface
description:Please Specify Host Interface
label:Host Interface
schema:
type:string
required:true
$ref:
- "definitions/interface"
- variable:ipam
description:Define how IP Address will be managed
label:IP Address Management
schema:
type:dict
required:true
attrs:
- variable:type
description:Specify type for IPAM
label:IPAM Type
schema:
type:string
required:true
enum:
- value:dhcp
description:Use DHCP
- value:static
description:Use Static IP
show_subquestions_if:static
subquestions:
- variable:staticIPConfigurations
label:Static IP Addresses
schema:
type:list
items:
- variable:staticIP
label:Static IP
schema:
type:ipaddr
cidr:true
- variable:staticRoutes
label:Static Routes
schema:
type:list
items:
- variable:staticRouteConfiguration
label:Static Route Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:destination
label:Destination
schema:
type:ipaddr
cidr:true
required:true
- variable:gateway
label:Gateway
schema:
type:ipaddr
cidr:false
required:true
- variable:serviceList
label:Add Manual Custom Services
group:Networking and Services
schema:
type:list
default:[]
items:
- variable:serviceListEntry
label:Custom Service
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the service
schema:
type:boolean
default:true
hidden:true
- variable:name
label:Name
schema:
type:string
default:""
- variable:type
label:Service Type
description:"ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
schema:
type:string
default:LoadBalancer
enum:
- value:LoadBalancer
description:LoadBalancer (Expose Ports)
- value:ClusterIP
description:ClusterIP (Do Not Expose Ports)
- value:Simple
description:Deprecated CHANGE THIS
- variable:loadBalancerIP
label:LoadBalancer IP
description:"MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
schema:
show_if:[["type","=","LoadBalancer"]]
type:string
default:""
- variable:advancedsvcset
label:Show Advanced Service Settings
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:externalIPs
label:"External IP's"
description:"External IP's"
schema:
type:list
default:[]
items:
- variable:externalIP
label:External IP
schema:
type:string
- variable:ipFamilyPolicy
label:IP Family Policy
description:Specify the IP Policy
schema:
type:string
default:SingleStack
enum:
- value:SingleStack
description:SingleStack
- value:PreferDualStack
description:PreferDualStack
- value:RequireDualStack
description:RequireDualStack
- variable:ipFamilies
label:IP Families
description:(Advanced) The IP Families that should be used
schema:
type:list
default:[]
items:
- variable:ipFamily
label:IP Family
schema:
type:string
- variable:portsList
label:Additional Service Ports
schema:
type:list
default:[]
items:
- variable:portsListEntry
label:Custom ports
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the Port
schema:
type:boolean
default:true
hidden:true
- variable:name
label:Port Name
schema:
type:string
default:""
- variable:protocol
label:Port Type
schema:
type:string
default:TCP
enum:
- value:HTTP
description:HTTP
- value:HTTPS
description:HTTPS
- value:TCP
description:TCP
- value:UDP
description:UDP
- variable:targetPort
label:Target Port
description:This port exposes the container port on the service
schema:
type:int
required:true
- variable:port
label:Container Port
schema:
type:int
required:true
- variable:persistence
label:Integrated Persistent Storage
description:Integrated Persistent Storage
group:Storage and Persistence
schema:
additional_attrs:true
type:dict
attrs:
- variable:data
label:App Data Storage
description:Stores the Application Data.
schema:
additional_attrs:true
type:dict
attrs:
- variable:type
label:Type of Storage
description:Sets the persistence type, Anything other than PVC could break rollback!
schema:
type:string
default:pvc
enum:
- value:pvc
description:PVC
- value:hostPath
description:Host Path
- value:emptyDir
description:emptyDir
- value:nfs
description:NFS Share
- variable:server
label:NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:path
label:Path on NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:setPermissions
label:Automatic Permissions
description:Automatically set permissions on install
schema:
show_if:[["type","=","hostPath"]]
type:boolean
default:false
- variable:readOnly
label:Read Only
schema:
type:boolean
default:false
- variable:hostPath
label:Host Path
description:Path inside the container the storage is mounted
schema:
show_if:[["type","=","hostPath"]]
type:hostpath
- variable:medium
label:EmptyDir Medium
schema:
show_if:[["type","=","emptyDir"]]
type:string
default:""
enum:
- value:""
description:Default
- value:Memory
description:Memory
- variable:size
label:Size quotum of Storage (Do NOT REDUCE after installation)
description:This value can ONLY be INCREASED after the installation
schema:
show_if:[["type","=","pvc"]]
type:string
default:256Gi
- variable:persistenceList
label:Additional App Storage
group:Storage and Persistence
schema:
type:list
default:[]
items:
- variable:persistenceListEntry
label:Custom Storage
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enable the storage
schema:
type:boolean
default:true
hidden:true
- variable:type
label:Type of Storage
description:Sets the persistence type, Anything other than PVC could break rollback!
schema:
type:string
default:hostPath
enum:
- value:pvc
description:PVC
- value:hostPath
description:Host Path
- value:emptyDir
description:emptyDir
- value:nfs
description:NFS Share
- variable:server
label:NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:path
label:Path on NFS Server
schema:
show_if:[["type","=","nfs"]]
type:string
default:""
- variable:setPermissions
label:Automatic Permissions
description:Automatically set permissions on install
schema:
show_if:[["type","=","hostPath"]]
type:boolean
default:false
- variable:readOnly
label:Read Only
schema:
type:boolean
default:false
- variable:hostPath
label:Host Path
description:Path inside the container the storage is mounted
schema:
show_if:[["type","=","hostPath"]]
type:hostpath
- variable:mountPath
label:Mount Path
description:Path inside the container the storage is mounted