description:Configure Network and Services for Container
- name:Storage and Persistence
description:Persist and Share Data that is Separate from the Container
- name:Ingress
description:Ingress Configuration
- name:Security and Permissions
description:Configure Security Context and Permissions
- name:Resources and Devices
description:"Specify Resources/Devices to be Allocated to Workload"
- name:Middlewares
description:Traefik Middlewares
- name:Metrics
description:Metrics
- name:VPN
description:VPN
- name:Addons
description:Addon Configuration
- name:Advanced
description:Advanced Configuration
- name:Documentation
description:Documentation
portals:{}
questions:
- variable:global
label:Global Settings
group:"General Settings"
schema:
type:dict
hidden:true
attrs:
- variable:isSCALE
label:Flag this is SCALE
schema:
type:boolean
default:true
hidden:true
- variable:controller
group:"General Settings"
label:""
schema:
additional_attrs:true
type:dict
attrs:
- variable:replicas
description:Number of desired pod replicas
label:Desired Replicas
schema:
type:int
required:true
default:1
- variable:customextraargs
group:"General Settings"
label:"Extra Args"
description:"Do not click this unless you know what you are doing"
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:extraArgs
label:Extra Args
schema:
type:list
default:[]
items:
- variable:arg
label:Arg
schema:
type:string
- variable:icloudpd
group:App Configuration
label:iCloud PD Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:apple_id
label:Apple ID
description:This is the Apple ID that will be used when downloading files.
schema:
type:string
required:true
default:""
- variable:authentication_type
label:Authentication Type
description:This is the type of authentication that is enabled on your iCloud account
schema:
type:string
default:2FA
enum:
- value:2FA
description:2FA
- value:Web
description:Web
- variable:icloud_china
label:iCloud China
description:Set this to true to use icloud.com.cm instead of icloud.com as the download source.
schema:
type:boolean
default:true
- variable:synchronisation_interval
label:Synchronization Interval
description:This is the number of seconds between synchronizations.
schema:
type:int
default:86400
- variable:synchronisation_delay
label:Synchronization Delay
description:This is the number of minutes to delay the first synchronization.
schema:
type:int
default:86400
- variable:notification_days
label:Notification Days
description:When your cookie is nearing expiration, this is the number of days in advance it should notify you.
schema:
type:int
default:7
- variable:photo_size
label:Photo Size
description:Image size to download
schema:
type:string
default:original
enum:
- value:original
description:original
- value:medium
description:medium
- value:thumb
description:thumb
- variable:live_photo_size
label:Live Photo Size
description:Live photo file size to download.
schema:
type:string
default:original
enum:
- value:original
description:original
- value:medium
description:medium
- value:thumb
description:thumb
- variable:recent_only
label:Recent Only
description:Set this to an integer number to only download this many recently added photos. Set to 0 to download all
schema:
type:int
default:0
- variable:until_found
label:Until Found
description:Set this to an integer number to only download the most recently added photos, until n number of previously downloaded consecutive photos are found. Set to 0 to download all
schema:
type:int
default:0
- variable:photo_album
label:Photo Album
description:Set this to the name of an album to only download photos from a single album. Set to empty to download all
schema:
type:string
default:""
- variable:set_exif_datetime
label:Set EXIF Date Time
description:Write the DateTimeOriginal EXIF tag from file creation date.
schema:
type:boolean
default:false
- variable:convert_heic_to_jpeg
label:Convert HEIC to JPEG
description:Set this to True to convert downloaded HEIC files to JPEG, while also retaining the original.
schema:
type:boolean
default:false
- variable:jpeg_quality
label:JPEG Quality
description:If HEIC to JPEG conversion is enabled, this variable will let you set the quality of the converted file by specifying a number from 0 (lowest quality) to 100 (highest quality)
schema:
type:int
default:90
- variable:skip_check
label:Skip Check
description:Set this to True skip the check for new files. The check can have issues with large libraries.
schema:
type:boolean
default:false
- variable:skip_live_photos
label:Skip Live Photos
description:If this is set, it will skip downloading live photos.
schema:
type:boolean
default:false
- variable:skip_videos
label:Skip Videos
description:If this is set, it will skip downloading videos.
schema:
type:boolean
default:false
- variable:auto_delete
label:Auto Delete
description:Scans the "Recently Deleted" folder and deletes any files found in there.
schema:
type:boolean
default:false
- variable:download_notifications
label:Download Notifications
description:Specifies whether notifications with a short summary should be sent for file downloads.
schema:
type:boolean
default:false
- variable:delete_notifications
label:Delete Notifications
description:Specifies whether notifications with a short summary should be sent for file deletions.
schema:
type:boolean
default:false
- variable:delete_accompanying
label:Delete Accompanying
description:Tells the script to delete files which accompany the HEIC files that are downloaded.
schema:
type:boolean
default:false
- variable:delete_empty_directories
label:Delete Empty Directories
description:Tells the script to delete any empty directories it finds in the download path.
schema:
type:boolean
default:false
- variable:command_line_options
label:Command Line Options
description:This is for additional command line options you want to pass to the iCloud PD application.
schema:
type:string
default:""
- variable:notification_type
label:Notification Type
description:This specifies the method that is used to send notifications. You need to manually add the environments variables
for your selected notification type, using the "Extra Environment Variables Section"
More info about the variables needed here. https://github.com/boredazfcuk/docker-icloudpd/blob/master/NOTIFICATIONS.md
schema:
type:string
default:NoType
enum:
- value:""
description:Notype
- value:Prowl
description:Prowl
- value:Pushover
description:Pushover
- value:Telegram
description:Telegram
- value:Webhook
description:Webhook
- value:Openhab
description:Openhab
- value:Dingtalk
description:Dingtalk
- value:Discord
description:Discord
- value:IYUU
description:IYUU
- value:WeCom
description:WeCom
- value:Gotify
description:Gotify
- value:Bark
description:Bark
- 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: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:config
label:Config Storage
description:Stores Applications Configuration
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:data
label:Data Storage
description:Stores iCloud Downloaded 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
