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:plausible
group:"App Configuration"
label:"Plausible Configuration"
schema:
additional_attrs:true
type:dict
attrs:
- variable:BASE_URL
label:BASE_URL
description:The hosting URL of the server, used for URL generation. In production systems, this should be your ingress host.
schema:
type:string
default:http://localhost
required:true
- variable:DISABLE_AUTH
label:DISABLE_AUTH
description:Disables authentication completely, no registration, login will be shown.
schema:
type:boolean
default:false
- variable:DISABLE_REGISTRATION
label:DISABLE_REGISTRATION
description:Disables registration of new users, keep your admin credentials handy ;)
schema:
type:boolean
default:false
- variable:ADMIN_USER_NAME
label:ADMIN_USER_NAME
description:Admin user's name (First Install Only)
schema:
type:string
default:admin
required:true
- variable:ADMIN_USER_EMAIL
label:ADMIN_USER_EMAIL
description:The default ("admin") user email (First Install Only)
schema:
type:string
default:admin@example.com
required:true
- variable:ADMIN_USER_PWD
label:ADMIN_USER_PWD
description:The default ("admin") user password (First Install Only)
schema:
type:string
default:""
required:true
private:true
- variable:CLICKHOUSE_FLUSH_INTERVAL_MS
label:CLICKHOUSE_FLUSH_INTERVAL_MS
description:nterval (in milliseconds) between flushing events and sessions data to Clickhouse. Consult Clickhouse docs before changing it.
schema:
type:int
default:5000
required:true
- variable:CLICKHOUSE_MAX_BUFFER_SIZE
label:CLICKHOUSE_MAX_BUFFER_SIZE
description:Maximum size of the buffer of events or sessions. Consult Clickhouse docs before changing it.
schema:
type:int
default:10000
required:true
- variable:MAILER_EMAIL
label:MAILER_EMAIL
description:The email id to use for as from address of all communications from Plausible.
schema:
type:string
default:hello@plausible.local
required:true
- variable:SMTP_HOST_ADDR
label:SMTP_HOST_ADDR
description:The host address of your smtp server.
schema:
type:string
default:localhost
required:true
- variable:SMTP_HOST_PORT
label:SMTP_HOST_PORT
description:The port of your smtp server.
schema:
type:int
default:25
required:true
- variable:SMTP_USER_NAME
label:SMTP_USER_NAME
description:The username/email in case SMTP auth is enabled.
schema:
type:string
default:""
- variable:SMTP_USER_PWD
label:SMTP_USER_PWD
description:The password in case SMTP auth is enabled.
schema:
type:string
default:""
private:true
- variable:SMTP_HOST_SSL_ENABLED
label:SMTP_HOST_SSL_ENABLED
description:If SSL is enabled for SMTP connection
schema:
type:boolean
default:false
- variable:SMTP_RETRIES
label:SMTP_RETRIES
description:Number of retries to make until mailer gives up.
schema:
type:int
default:2
required:true
- variable:MAILER_ADAPTER
label:MAILER_ADAPTER
description:Mailer Adapter
schema:
type:string
required:true
default:Bamboo.SMTPAdapter
enum:
- value:Bamboo.SMTPAdapter
description:Bamboo.SMTPAdapter
- value:Bamboo.PostmarkAdapter
description:Bamboo.PostmarkAdapter
- variable:POSTMARK_API_KEY
label:POSTMARK_API_KEY
description:Enter your API key.
schema:
type:string
default:""
private:true
- variable:GOOGLE_CLIENT_ID
label:GOOGLE_CLIENT_ID
description:The Client ID from the Google API Console for your Plausible Analytics project
schema:
type:string
default:""
- variable:GOOGLE_CLIENT_SECRET
label:GOOGLE_CLIENT_SECRET
description:The Client Secret from the Google API Console for your Plausible Analytics project
schema:
type:string
default:""
private:true
- variable:LOG_LEVEL
label:LOG_LEVEL
description:Logging Level
schema:
type:string
required:true
default:warn
enum:
- value:debug
description:debug
- value:info
description:info
- value:warn
description:warn
- value:error
description:error
- 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:10277
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: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