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:pialert
group:App Configuration
label:PiAlert Configuration
schema:
additional_attrs:true
type:dict
attrs:
- variable:general
label:General
schema:
additional_attrs:true
type:dict
attrs:
- variable:dark_mode
label:Dark Mode
description:Forces dark mode by creating a <setting_darkmode> file in the container
schema:
type:boolean
default:true
- variable:web_protection
label:Web Protection
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:web_password
label:Web Password
schema:
type:string
default:""
private:true
required:true
- variable:print_log
label:Print Log
schema:
type:boolean
default:false
- variable:report_dashboard_url
label:Report Dashboard URL
schema:
type:string
default:""
required:true
- variable:days_to_keep_events
label:Days to Keep Events
schema:
type:int
default:90
required:true
- variable:scan_cycle_minutes
label:Scan Cycle Minutes
schema:
type:int
default:5
required:true
- variable:included_sections
label:Included Sections
description:Empty list, will add all sections
schema:
type:list
default:[]
items:
- variable:section
label:Section
schema:
type:string
default:""
required:true
enum:
- value:internet
description:Internet
- value:new_devices
description:New Devices
- value:down_devices
description:Down Devices
- value:events
description:Events
- variable:scan_subnets
label:Scan Subnets
description:CIDR format is <192.168.1.0/24> and interface format is <eth0>
schema:
type:list
required:true
default:[]
items:
- variable:subnet
label:Subnet
schema:
additional_attrs:true
type:dict
attrs:
- variable:cidr
label:CIDR
schema:
type:string
default:""
required:true
- variable:interface
label:Interface
schema:
type:string
default:""
required:true
- variable:pushsafer
label:PushSafer
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enabled
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:token
label:Token
schema:
type:string
default:""
private:true
required:true
- variable:apprise
label:Apprise
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enabled
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:host
label:Host
schema:
type:string
default:""
required:true
- variable:url
label:URL
schema:
type:string
default:""
required:true
- variable:ntfy
label:ntfy
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enabled
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:host
label:Host
schema:
type:string
default:""
required:true
- variable:topic
label:Topic
schema:
type:string
default:""
required:true
- variable:user
label:Username
schema:
type:string
default:""
- variable:password
label:Password
schema:
type:string
default:""
- variable:webhook
label:Webhook
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enabled
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:url
label:URL
schema:
type:string
default:""
required:true
- variable:payload
label:Payload
schema:
type:string
default:json
required:true
enum:
- value:json
description:JSON
- value:html
description:HTML
- value:text
description:TEXT
- variable:method
label:Method
schema:
type:string
default:GET
- variable:email
label:Email
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enabled
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:server
label:Server
schema:
type:string
default:""
required:true
- variable:port
label:Port
schema:
type:int
default:587
required:true
- variable:report_to
label:Report To
schema:
type:string
default:""
required:true
- variable:report_from
label:Report From
schema:
type:string
default:""
required:true
- variable:skip_login
label:Skip Login
schema:
type:boolean
default:false
- variable:skip_tls
label:Skip TLS
schema:
type:boolean
default:false
- variable:user
label:Username
schema:
type:string
default:""
- variable:password
label:Password
schema:
type:string
default:""
- variable:mqtt
label:MQTT
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enabled
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:broker
label:Broker
schema:
type:string
default:""
required:true
- variable:port
label:Port
schema:
type:int
default:587
required:true
- variable:user
label:Username
schema:
type:string
default:""
- variable:password
label:Password
schema:
type:string
default:""
- variable:qos
label:QOS
schema:
type:int
default:0
required:true
- variable:delay_sec
label:Delay Sec
schema:
type:int
default:2
required:true
- variable:dyndns
label:DynDNS
schema:
additional_attrs:true
type:dict
attrs:
- variable:enabled
label:Enabled
schema:
type:boolean
default:false
show_subquestions_if:true
subquestions:
- variable:domain
label:Domain
schema:
type:string
default:""
required:true
- variable:force
label:Force
schema:
type:boolean
default:false
- variable:timeout
label:Timeout
schema:
type:int
default:20
required:true
- variable:days_data
label:Days Data
schema:
type:int
default:7
required:true
- variable:days_data
label:Days Data
schema:
type:int
default:7
required:true
- variable:run
label:Run
schema:
type:string
default:once
required:true
- variable:run_timeout
label:Run Timeout
schema:
type:int
default:300
required:true
- variable:run_schedule
label:Run Schedule
schema:
type:string
default:"0 4 * * *"
required:true
- variable:pihole
label:PiHole
schema:
additional_attrs:true
type:dict
attrs:
- variable:pihole_active
label:PiHole Active (Not covered by support)
description:If enabled you need to map '/etc/pihole/pihole-FTL.db' with additional storage. Not covered by support
schema:
type:boolean
default:false
- variable:dhcp_active
label:DHCP Active (Not covered by support)
description:If enabled you need to map '/etc/pihole/dhcp.leases' with additional storage. Not covered by support
schema:
type:boolean
default:false
- 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:10600
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:true
- 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:App Config Storage
description:Stores the Application 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:db
label:App DB Storage
description:Stores the Application DB.
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