2845 lines
124 KiB
YAML
2845 lines
124 KiB
YAML
groups:
|
|
- name: Container Image
|
|
description: Image to be used for container
|
|
- name: General Settings
|
|
description: General Deployment Settings
|
|
- name: Workload Settings
|
|
description: Workload Settings
|
|
- name: App Configuration
|
|
description: App Specific Config Options
|
|
- name: Networking and Services
|
|
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: Addons
|
|
description: Addon Configuration
|
|
- name: Advanced
|
|
description: Advanced Configuration
|
|
- name: Postgresql
|
|
description: Postgresql
|
|
- name: Documentation
|
|
description: Documentation
|
|
portals:
|
|
open:
|
|
protocols:
|
|
- "$kubernetes-resource_configmap_tcportal-open_protocol"
|
|
host:
|
|
- "$kubernetes-resource_configmap_tcportal-open_host"
|
|
ports:
|
|
- "$kubernetes-resource_configmap_tcportal-open_port"
|
|
path: "$kubernetes-resource_configmap_tcportal-open_path"
|
|
questions:
|
|
- variable: global
|
|
group: General Settings
|
|
label: "Global Settings"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: stopAll
|
|
label: Stop All
|
|
description: "Stops All Running pods and hibernates cnpg"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: workload
|
|
group: "Workload Settings"
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: main
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: type
|
|
label: Type (Advanced)
|
|
schema:
|
|
type: string
|
|
default: Deployment
|
|
enum:
|
|
- value: Deployment
|
|
description: Deployment
|
|
- value: DaemonSet
|
|
description: DaemonSet
|
|
|
|
- variable: replicas
|
|
label: Replicas (Advanced)
|
|
description: Set the number of Replicas
|
|
schema:
|
|
type: int
|
|
show_if: [["type", "!=", "DaemonSet"]]
|
|
default: 1
|
|
- variable: podSpec
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: containers
|
|
label: Containers
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: main
|
|
label: Main Container
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- 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..."
|
|
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: extraArgs
|
|
label: Extra Args
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: arg
|
|
label: Arg
|
|
schema:
|
|
type: string
|
|
- variable: advanced
|
|
label: Show Advanced Settings
|
|
description: Advanced settings are not covered by TrueCharts Support
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: command
|
|
label: Command
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: param
|
|
label: Param
|
|
schema:
|
|
type: string
|
|
|
|
- variable: TZ
|
|
label: Timezone
|
|
group: "General Settings"
|
|
schema:
|
|
type: string
|
|
default: "Etc/UTC"
|
|
$ref:
|
|
- "definitions/timezone"
|
|
- variable: podOptions
|
|
group: "General Settings"
|
|
label: "Global Pod Options (Advanced)"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: expertPodOpts
|
|
label: "Expert - Pod Options"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: hostNetwork
|
|
label: "Host Networking"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: dnsConfig
|
|
label: "DNS Configuration"
|
|
schema:
|
|
type: dict
|
|
additional_attrs: true
|
|
attrs:
|
|
- variable: options
|
|
label: "Options"
|
|
schema:
|
|
type: list
|
|
default: [{"name": "ndots", "value": "1"}]
|
|
items:
|
|
- variable: optionsEntry
|
|
label: "Option Entry"
|
|
schema:
|
|
type: dict
|
|
additional_attrs: true
|
|
attrs:
|
|
- variable: name
|
|
label: "Name"
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: value
|
|
label: "Value"
|
|
schema:
|
|
type: string
|
|
- variable: nameservers
|
|
label: "Nameservers"
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: nsEntry
|
|
label: "Nameserver Entry"
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: searches
|
|
label: "Searches"
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: searchEntry
|
|
label: "Search Entry"
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: expertIngressClass
|
|
label: Expert Mode
|
|
group: App Configuration
|
|
description: |
|
|
Expert Mode contains settings like: </br>
|
|
- IngressClass </br>
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: ingressClass
|
|
label: "ingressClass"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: "Enable"
|
|
description: "When enabled, ingressClass will match the entered name of this app"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: isDefaultClass
|
|
label: "isDefaultClass"
|
|
schema:
|
|
type: boolean
|
|
show_if: [["enabled", "=", true]]
|
|
default: false
|
|
- variable: logs
|
|
label: "Logs"
|
|
group: "App Configuration"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: general
|
|
label: "General Logs"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: level
|
|
label: "Log Level"
|
|
schema:
|
|
type: string
|
|
default: "ERROR"
|
|
enum:
|
|
- value: "INFO"
|
|
description: "Info"
|
|
- value: "WARN"
|
|
description: "Warnings"
|
|
- value: "ERROR"
|
|
description: "Errors"
|
|
- value: "FATAL"
|
|
description: "Fatal Errors"
|
|
- value: "PANIC"
|
|
description: "Panics"
|
|
- value: "DEBUG"
|
|
description: "Debug"
|
|
- variable: format
|
|
label: "General Log format"
|
|
schema:
|
|
type: string
|
|
default: "common"
|
|
enum:
|
|
- value: "common"
|
|
description: "Common Log Format"
|
|
- value: "json"
|
|
description: "JSON"
|
|
- variable: access
|
|
label: "Access Logs"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: "Enable"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: enabledFilters
|
|
label: "Enable Filters"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: filters
|
|
label: "Filters"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: statuscodes
|
|
label: "Status codes"
|
|
schema:
|
|
type: string
|
|
default: "200,300-302"
|
|
- variable: retryattempts
|
|
label: "retryattempts"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- variable: minduration
|
|
label: "minduration"
|
|
schema:
|
|
type: string
|
|
default: "10ms"
|
|
- variable: fields
|
|
label: "Fields"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: general
|
|
label: "General"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: defaultmode
|
|
label: "Default Mode"
|
|
schema:
|
|
type: string
|
|
default: "keep"
|
|
enum:
|
|
- value: "keep"
|
|
description: "Keep"
|
|
- value: "drop"
|
|
description: "Drop"
|
|
- variable: headers
|
|
label: "Headers"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: defaultmode
|
|
label: "Default Mode"
|
|
schema:
|
|
type: string
|
|
default: "drop"
|
|
enum:
|
|
- value: "keep"
|
|
description: "Keep"
|
|
- value: "drop"
|
|
description: "Drop"
|
|
- variable: format
|
|
label: "Access Log format"
|
|
schema:
|
|
type: string
|
|
default: "common"
|
|
enum:
|
|
- value: "common"
|
|
description: "Common Log Format"
|
|
- value: "json"
|
|
description: "JSON"
|
|
- variable: middlewares
|
|
label: ""
|
|
group: "Middlewares"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: basicAuth
|
|
label: basicAuth
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: basicAuthEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: users
|
|
label: Users
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: usersEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: username
|
|
label: Username
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: password
|
|
label: Password
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: forwardAuth
|
|
label: forwardAuth
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: basicAuthEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: address
|
|
label: Address
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: trustForwardHeader
|
|
label: trustForwardHeader
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: tls
|
|
label: TLS
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: insecureSkipVerify
|
|
label: insecureSkipVerify (expert)
|
|
description: >-
|
|
This disables all TLS certificate validation on communications with the authentication endpoint.
|
|
This could be a security risk and should only be used if you know what you are doing.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: authResponseHeadersRegex
|
|
label: authResponseHeadersRegex
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: authResponseHeaders
|
|
label: authResponseHeaders
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: authResponseHeadersEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: authRequestHeaders
|
|
label: authRequestHeaders
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: authRequestHeadersEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: buffering
|
|
label: Buffering
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: bufferingEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: maxRequestBodyBytes
|
|
label: Max Request Body Bytes
|
|
description: Leave empty and it won't be set
|
|
schema:
|
|
type: string
|
|
valid_chars: '^[0-9]*$'
|
|
default: ""
|
|
- variable: memRequestBodyBytes
|
|
label: Mem Request Body Bytes
|
|
description: Leave empty and it won't be set
|
|
schema:
|
|
type: string
|
|
valid_chars: '^[0-9]*$'
|
|
default: ""
|
|
- variable: maxResponseBodyBytes
|
|
label: Max Response Body Bytes
|
|
description: Leave empty and it won't be set
|
|
schema:
|
|
type: string
|
|
valid_chars: '^[0-9]*$'
|
|
default: ""
|
|
- variable: memResponseBodyBytes
|
|
label: Mem Response Body Bytes
|
|
description: Leave empty and it won't be set
|
|
schema:
|
|
type: string
|
|
valid_chars: '^[0-9]*$'
|
|
default: ""
|
|
- variable: retryExpression
|
|
label: Retry Expression
|
|
description: Leave empty and it won't be set
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: customRequestHeaders
|
|
label: Custom Request Headers
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: customRequestHeadersEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: headers
|
|
label: Headers to Add
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: name
|
|
label: Header Name
|
|
description: Name of custom header to be added to requests, eg. X-Custom-Header
|
|
pattern: ^[a-zA-Z0-9_\-]*$
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: value
|
|
label: Header Value
|
|
description: The value of the header. If the value is empty, the header will be removed.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: customResponseHeaders
|
|
label: Custom Response Headers
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: customResponseHeadersEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: headers
|
|
label: Headers to Add
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: name
|
|
label: Header Name
|
|
description: Name of custom header to be added to responses, eg. X-Custom-Header
|
|
pattern: ^[a-zA-Z0-9_\-]*$
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: value
|
|
label: Header Value
|
|
description: The value of the header. If the value is empty, the header will be removed.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: customFrameOptionsValue
|
|
label: Custom Frame Options Value
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: customFrameOptionsValueEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: value
|
|
label: X-Frame-Options Header Value
|
|
description: The value of the header.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: chain
|
|
label: Chain
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: chainEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: middlewares
|
|
label: Middlewares to Chain
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: redirectScheme
|
|
label: redirectScheme
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: redirectSchemeEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: scheme
|
|
label: Scheme
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: https
|
|
enum:
|
|
- value: https
|
|
description: https
|
|
- value: http
|
|
description: http
|
|
- variable: permanent
|
|
label: Permanent
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: rateLimit
|
|
label: rateLimit
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: rateLimitEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: average
|
|
label: Average
|
|
schema:
|
|
type: int
|
|
required: true
|
|
default: 300
|
|
- variable: burst
|
|
label: Burst
|
|
schema:
|
|
type: int
|
|
required: true
|
|
default: 200
|
|
- variable: redirectRegex
|
|
label: redirectRegex
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: redirectRegexEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: regex
|
|
label: Regex
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: replacement
|
|
label: Replacement
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: permanent
|
|
label: Permanent
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: stripPrefixRegex
|
|
label: stripPrefixRegex
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: stripPrefixRegexEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: regex
|
|
label: Regex
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: regexEntry
|
|
label: Regex
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: ipWhiteList
|
|
label: ipWhiteList
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: ipWhiteListEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: sourceRange
|
|
label: Source Range
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: sourceRangeEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: ipStrategy
|
|
label: IP Strategy
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: depth
|
|
label: Depth
|
|
schema:
|
|
type: int
|
|
required: true
|
|
- variable: excludedIPs
|
|
label: Excluded IPs
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: excludedIPsEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: themePark
|
|
label: theme.park
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: themeParkEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
description: This is a 3rd party plugin and not maintained by TrueCharts,
|
|
for more information go to <a href="https://github.com/packruler/traefik-themepark">traefik-themepark</a>
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: appName
|
|
label: App Name
|
|
description: Lower case, name of the app to be themed.
|
|
<br />Go to <a href="https://docs.theme-park.dev/themes/">https://docs.theme-park.dev/themes/</a> to see supported apps.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: themeName
|
|
label: Theme Name
|
|
description: Lower case, name of the theme to be applied.
|
|
<br />Go to <a href="https://docs.theme-park.dev/theme-options/">https://docs.theme-park.dev/theme-options/</a> to see supported themes.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: baseUrl
|
|
label: Base URL
|
|
description: Replace `https://theme-park.dev` URL for self-hosting reference.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: https://theme-park.dev
|
|
- variable: addons
|
|
label: Addons
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: addonEntry
|
|
label: Addon
|
|
description: Currently only supports 'darker' and '4k-logo' for *arr apps.
|
|
<br />Go to <a href="https://docs.theme-park.dev/themes/addons/">https://docs.theme-park.dev/themes/addons/</a> for Addon information.
|
|
<br />Go to <a href="https://github.com/packruler/traefik-themepark">https://github.com/packruler/traefik-themepark</a> for more context on plugin
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: realIP
|
|
label: Real IP
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: realIPEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: excludedNetworks
|
|
label: Excluded Networks
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: excludedNetEntry
|
|
label: Excluded Network Entry
|
|
description: Network to exclude setting it to X-Real-Ip
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: geoBlock
|
|
label: GeoBlock
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: geoBlockEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
description: This is a 3rd party plugin and not maintained by TrueCharts,
|
|
for more information go to <a href="https://github.com/PascalMinder/geoblock">geoblock</a>
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: allowLocalRequests
|
|
label: Allow Local Requests
|
|
description: If set to true, will not block request from Private IP Ranges
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- variable: logLocalRequests
|
|
label: Log Local Requests
|
|
description: If set to true, will log every connection from any IP in the private IP range
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: logAllowedRequests
|
|
label: Log Allowed Requests
|
|
description: If set to true, will show a log message with the IP and the country of origin if a request is allowed.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: logApiRequests
|
|
label: Log API Requests
|
|
description: If set to true, will show a log message for every API hit.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: api
|
|
label: API
|
|
description: Defines the API URL for the IP to Country resolution. The IP to fetch can be added with {ip} to the URL.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: https://get.geojs.io/v1/ip/country/{ip}
|
|
- variable: apiTimeoutMs
|
|
label: API Timeout in ms
|
|
description: Timeout for the call to the api uri.
|
|
schema:
|
|
type: int
|
|
required: true
|
|
default: 500
|
|
- variable: cacheSize
|
|
label: Cache Size
|
|
description: Defines the max size of the LRU (least recently used) cache.
|
|
schema:
|
|
type: int
|
|
required: true
|
|
default: 25
|
|
- variable: forceMonthlyUpdate
|
|
label: Force Monthly Update
|
|
description: Even if an IP stays in the cache for a period of a month (about 30 x 24 hours), it must be fetch again after a month.
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- variable: allowUnknownCountries
|
|
label: Allow Unknown Countries
|
|
description: Some IP addresses have no country associated with them. If this option is set to true, all IPs with no associated country are also allowed.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: unknownCountryApiResponse
|
|
label: Unknown Countries API Response
|
|
description: The API uri can be customized. This options allows to customize the response string of the API when a IP with no associated country is requested.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: nil
|
|
- variable: blackListMode
|
|
label: Blacklist Mode
|
|
description: When set to true the filter logic is inverted, i.e. requests originating from countries listed in the countries list are blocked.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: countries
|
|
description: Country codes (2 characters) from which connections to the service should be allowed or blocked, based on the mode.
|
|
label: Countries
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: countryEntry
|
|
label: Country
|
|
description: Country codes (2 characters) from which connections to the service should be allowed or blocked, based on the mode.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
# Allow only 2 Characters
|
|
valid_chars: '^[a-zA-Z]{2}$'
|
|
default: ""
|
|
- variable: addPrefix
|
|
label: Add Prefix
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: addPrefixEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: prefix
|
|
label: Prefix
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: modsecurity
|
|
label: modsecurity
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: modsecurityEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
description: This is a 3rd party plugin and not maintained by TrueCharts,
|
|
for more information go to <a href="https://github.com/acouvreur/traefik-modsecurity-plugin">traefik-modsecurity-plugin</a>
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: modSecurityUrl
|
|
label: ModSecurity Url
|
|
description: It's the URL for the owasp/modsecurity container.
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: "https://someurl"
|
|
- variable: timeoutMillis
|
|
label: timeout Millis
|
|
description: timeout in milliseconds for the http client to talk with modsecurity container. (
|
|
schema:
|
|
type: int
|
|
required: true
|
|
default: 2
|
|
- variable: maxBodySize
|
|
label: maxBody Size
|
|
description: it's the maximum limit for requests body size. Requests exceeding this value will be rejected using HTTP 413 Request Entity Too Large. Zero means "use default value".
|
|
schema:
|
|
type: int
|
|
required: true
|
|
default: 0
|
|
- variable: service
|
|
group: "Networking and Services"
|
|
label: "Configure Service Entrypoint"
|
|
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)
|
|
- 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 Entrypoint Configuration"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: port
|
|
label: "Entrypoints Port"
|
|
schema:
|
|
type: int
|
|
default: 9000
|
|
required: true
|
|
- variable: tcp
|
|
label: "TCP Service"
|
|
description: "The tcp Entrypoint service"
|
|
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)
|
|
- 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: web
|
|
label: "web Entrypoint Configuration"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: port
|
|
label: "Entrypoints Port"
|
|
schema:
|
|
type: int
|
|
default: 9080
|
|
required: true
|
|
- variable: advanced
|
|
label: Show Advanced Settings
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: redirectPort
|
|
label: "Redirect to Port"
|
|
schema:
|
|
type: int
|
|
- variable: redirectTo
|
|
label: "Redirect to Entrypoint"
|
|
schema:
|
|
type: string
|
|
default: "websecure"
|
|
- variable: forwardedHeaders
|
|
label: Accept Forwarded Headers
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enable
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: trustedIPs
|
|
label: Trusted IPs
|
|
description: Trust Forwarded Headers from specific IPs.
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: trustedIPsEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: insecureMode
|
|
label: Insecure Mode
|
|
description: Always Trust Forwarded Headers
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: proxyProtocol
|
|
label: Accept Proxy Protocol connections
|
|
description: If Proxy Protocol header parsing is enabled for the entry point, this entry point can accept connections with or without Proxy Protocol headers.
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enable
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: trustedIPs
|
|
label: Trusted IPs
|
|
description: Only IPs in trustedIPs will lead to remote client address replacement
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: trustedIPsEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: insecureMode
|
|
label: Insecure Mode
|
|
description: Trust every incoming connection
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: websecure
|
|
label: "websecure Entrypoints Configuration"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: port
|
|
label: "Entrypoints Port"
|
|
schema:
|
|
type: int
|
|
default: 9443
|
|
required: true
|
|
- variable: advanced
|
|
label: Show Advanced Settings
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: redirectPort
|
|
label: "Redirect to Port"
|
|
schema:
|
|
type: int
|
|
- variable: redirectTo
|
|
label: "Redirect to Entrypoint"
|
|
schema:
|
|
type: string
|
|
- variable: forwardedHeaders
|
|
label: Accept Forwarded Headers
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enable
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: trustedIPs
|
|
label: Trusted IPs
|
|
description: Trust Forwarded Headers from specific IPs.
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: trustedIPsEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: insecureMode
|
|
label: Insecure Mode
|
|
description: Always Trust Forwarded Headers
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: proxyProtocol
|
|
label: Accept Proxy Protocol connections
|
|
description: If Proxy Protocol header parsing is enabled for the entry point, this entry point can accept connections with or without Proxy Protocol headers.
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enable
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: trustedIPs
|
|
label: Trusted IPs
|
|
description: Only IPs in trustedIPs will lead to remote client address replacement
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: trustedIPsEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: insecureMode
|
|
label: Insecure Mode
|
|
description: Trust every incoming connection
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: tls
|
|
label: "websecure Entrypoints Configuration"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
hidden: true
|
|
attrs:
|
|
- variable: enabled
|
|
label: "Enabled"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
hidden: true
|
|
- variable: portsList
|
|
label: "Additional TCP Entrypoints"
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: portsListEntry
|
|
label: "Custom Entrypoints"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: "Enable the port"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
hidden: true
|
|
- variable: name
|
|
label: "Entrypoints Name"
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: protocol
|
|
label: "Entrypoints Type"
|
|
schema:
|
|
type: string
|
|
default: "tcp"
|
|
enum:
|
|
- value: http
|
|
description: "HTTP"
|
|
- value: "https"
|
|
description: "HTTPS"
|
|
- value: tcp
|
|
description: "TCP"
|
|
- variable: port
|
|
label: "Port"
|
|
description: "This port exposes the container port on the service"
|
|
schema:
|
|
type: int
|
|
required: true
|
|
- variable: tls
|
|
label: "websecure Entrypoints Configuration"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: "Enabled"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- variable: redirectPort
|
|
label: "Redirect to Port"
|
|
schema:
|
|
type: int
|
|
- variable: redirectTo
|
|
label: "Redirect to Entrypoint"
|
|
schema:
|
|
type: string
|
|
- variable: forwardedHeaders
|
|
label: Accept Forwarded Headers
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enable
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: trustedIPs
|
|
label: Trusted IPs
|
|
description: Trust Forwarded Headers from specific IPs.
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: trustedIPsEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: insecureMode
|
|
label: Insecure Mode
|
|
description: Always Trust Forwarded Headers
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: proxyProtocol
|
|
label: Accept Proxy Protocol connections
|
|
description: If Proxy Protocol header parsing is enabled for the entry point, this entry point can accept connections with or without Proxy Protocol headers.
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enable
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: trustedIPs
|
|
label: Trusted IPs
|
|
description: Only IPs in trustedIPs will lead to remote client address replacement
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: trustedIPsEntry
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: insecureMode
|
|
label: Insecure Mode
|
|
description: Trust every incoming connection
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: ingress
|
|
label: ""
|
|
group: Ingress
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: main
|
|
label: "Main Ingress"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enable Ingress
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: hosts
|
|
label: Hosts
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: hostEntry
|
|
label: Host
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: host
|
|
label: HostName
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
required: true
|
|
- variable: paths
|
|
label: Paths
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: pathEntry
|
|
label: Host
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: path
|
|
label: Path
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: "/"
|
|
- variable: pathType
|
|
label: Path Type
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: Prefix
|
|
- variable: certificateIssuer
|
|
label: Cert-Manager clusterIssuer
|
|
description: 'add the name of your cert-manager clusterIssuer here for automatic tls certificates. Cannot be used combined with tls option below'
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: middlewares
|
|
label: Traefik Middlewares
|
|
description: Add previously created Traefik Middlewares to this Ingress
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
required: true
|
|
- variable: advanced
|
|
label: Show Advanced Settings
|
|
description: Advanced settings are not covered by TrueCharts Support
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: entrypoint
|
|
label: (Advanced) Traefik Entrypoint
|
|
description: Entrypoint used by Traefik when using Traefik as Ingress Provider
|
|
schema:
|
|
type: string
|
|
default: websecure
|
|
show_if: [["advanced", "=", true]]
|
|
required: true
|
|
- variable: ingressClassName
|
|
label: (Advanced/Optional) IngressClass Name
|
|
schema:
|
|
type: string
|
|
show_if: [["advanced", "=", true]]
|
|
default: ""
|
|
- variable: tls
|
|
label: TLS-Settings
|
|
schema:
|
|
type: list
|
|
show_if: [["advanced", "=", true]]
|
|
default: []
|
|
items:
|
|
- variable: tlsEntry
|
|
label: Host
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: hosts
|
|
label: Certificate Hosts
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: host
|
|
label: Host
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
required: true
|
|
|
|
- variable: certificateIssuer
|
|
label: Use Cert-Manager clusterIssuer
|
|
description: 'add the name of your cert-manager clusterIssuer here for automatic tls certificates.'
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: scaleCert
|
|
label: Use TrueNAS SCALE Certificate (Deprecated)
|
|
schema:
|
|
show_if: [["certificateIssuer", "=", ""]]
|
|
type: int
|
|
$ref:
|
|
- "definitions/certificate"
|
|
- variable: secretName
|
|
label: Use Custom Secret (Advanced)
|
|
schema:
|
|
show_if: [["certificateIssuer", "=", ""]]
|
|
type: string
|
|
default: ""
|
|
- variable: ingressList
|
|
label: Add Manual Custom Ingresses
|
|
group: Ingress
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: ingressListEntry
|
|
label: Custom Ingress
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enable Ingress
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
hidden: true
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: ingressClassName
|
|
label: IngressClass Name
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: hosts
|
|
label: Hosts
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: hostEntry
|
|
label: Host
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: host
|
|
label: HostName
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
required: true
|
|
- variable: paths
|
|
label: Paths
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: pathEntry
|
|
label: Host
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: path
|
|
label: Path
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: "/"
|
|
- variable: pathType
|
|
label: Path Type
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: Prefix
|
|
- variable: service
|
|
label: Linked Service
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Service Name
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: port
|
|
label: Service Port
|
|
schema:
|
|
type: int
|
|
- variable: clusterIssuer
|
|
label: clusterIssuer
|
|
description: 'add the name of your cert-manager clusterIssuer here for automatic tls certificates. Cannot be used combined with tls option below'
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: tls
|
|
label: TLS-Settings
|
|
schema:
|
|
type: list
|
|
default: []
|
|
show_if: [["clusterIssuer", "=", ""]]
|
|
items:
|
|
- variable: tlsEntry
|
|
label: Host
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: hosts
|
|
label: Certificate Hosts
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: host
|
|
label: Host
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
required: true
|
|
- variable: clusterIssuer
|
|
label: Use Cert-Manager clusterIssuer
|
|
description: 'add the name of your Cert-Manager clusterIssuer here for automatic tls certificates.'
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: scaleCert
|
|
label: Use TrueNAS SCALE Certificate (Deprecated)
|
|
schema:
|
|
show_if: [["clusterIssuer", "=", ""]]
|
|
type: int
|
|
$ref:
|
|
- "definitions/certificate"
|
|
- variable: secretName
|
|
label: Use Custom Secret (Advanced)
|
|
schema:
|
|
type: string
|
|
show_if: [["clusterIssuer", "=", ""]]
|
|
default: ""
|
|
- variable: entrypoint
|
|
label: Traefik Entrypoint
|
|
description: Entrypoint used by Traefik when using Traefik as Ingress Provider
|
|
schema:
|
|
type: string
|
|
default: websecure
|
|
required: true
|
|
- variable: middlewares
|
|
label: Traefik Middlewares
|
|
description: Add previously created Traefik Middlewares to this Ingress
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
required: true
|
|
- variable: securityContext
|
|
group: Security and Permissions
|
|
label: Security Context
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: container
|
|
label: Container
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
# Settings from questions.yaml get appended here on a per-app basis
|
|
- variable: runAsUser
|
|
label: "runAsUser"
|
|
description: "The UserID of the user running the application"
|
|
schema:
|
|
type: int
|
|
default: 568
|
|
- variable: runAsGroup
|
|
label: "runAsGroup"
|
|
description: "The groupID of the user running the application"
|
|
schema:
|
|
type: int
|
|
default: 568
|
|
# Settings from questions.yaml get appended here on a per-app basis
|
|
- variable: PUID
|
|
label: Process User ID - PUID
|
|
description: When supported by the container, this sets the User ID running the Application Process. Not supported by all Apps
|
|
schema:
|
|
type: int
|
|
show_if: [["runAsUser", "=", 0]]
|
|
default: 568
|
|
- variable: UMASK
|
|
label: UMASK
|
|
description: When supported by the container, this sets the UMASK for the App. Not supported by all Apps
|
|
schema:
|
|
type: string
|
|
default: "0022"
|
|
- variable: advanced
|
|
label: Show Advanced Settings
|
|
description: Advanced settings are not covered by TrueCharts Support
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: privileged
|
|
label: "Privileged mode"
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: readOnlyRootFilesystem
|
|
label: "ReadOnly Root Filesystem"
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- variable: pod
|
|
label: Pod
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: fsGroupChangePolicy
|
|
label: "When should we take ownership?"
|
|
schema:
|
|
type: string
|
|
default: OnRootMismatch
|
|
enum:
|
|
- value: OnRootMismatch
|
|
description: OnRootMismatch
|
|
- value: Always
|
|
description: Always
|
|
- variable: supplementalGroups
|
|
label: Supplemental Groups
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: supplementalGroupsEntry
|
|
label: Supplemental Group
|
|
schema:
|
|
type: int
|
|
# Settings from questions.yaml get appended here on a per-app basis
|
|
- variable: fsGroup
|
|
label: "fsGroup"
|
|
description: "The group that should own ALL storage."
|
|
schema:
|
|
type: int
|
|
default: 568
|
|
|
|
- variable: resources
|
|
group: Resources and Devices
|
|
label: "Resource Limits"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: limits
|
|
label: Advanced Limit Resource Consumption
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: cpu
|
|
label: CPU
|
|
description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/manual/SCALE/validation"
|
|
schema:
|
|
type: string
|
|
default: 4000m
|
|
valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$'
|
|
- variable: memory
|
|
label: RAM
|
|
description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/manual/SCALE/validation"
|
|
schema:
|
|
type: string
|
|
default: 8Gi
|
|
valid_chars: '^(?!^0(e[0-9]|[EPTGMK]i?|)$)([0-9]+)(|[EPTGMK]i?|e[0-9]+)$'
|
|
- variable: requests
|
|
label: "Minimum Resources Required (request)"
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
hidden: true
|
|
attrs:
|
|
- variable: cpu
|
|
label: CPU
|
|
description: "1000m means 1 hyperthread. Detailed info: https://truecharts.org/manual/SCALE/validation"
|
|
schema:
|
|
type: string
|
|
default: 10m
|
|
hidden: true
|
|
valid_chars: '^(?!^0(\.0|m|)$)([0-9]+)(\.[0-9]|m?)$'
|
|
- variable: memory
|
|
label: "RAM"
|
|
description: "1Gi means 1 Gibibyte RAM. Detailed info: https://truecharts.org/manual/SCALE/validation"
|
|
schema:
|
|
type: string
|
|
default: 50Mi
|
|
hidden: true
|
|
valid_chars: '^(?!^0(e[0-9]|[EPTGMK]i?|)$)([0-9]+)(|[EPTGMK]i?|e[0-9]+)$'
|
|
- variable: deviceList
|
|
label: Mount USB Devices
|
|
group: Resources and Devices
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: deviceListEntry
|
|
label: Device
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enable the Storage
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- variable: type
|
|
label: (Advanced) Type of Storage
|
|
description: Sets the persistence type
|
|
schema:
|
|
type: string
|
|
default: device
|
|
hidden: true
|
|
- variable: readOnly
|
|
label: readOnly
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: hostPath
|
|
label: Host Device Path
|
|
description: Path to the device on the host system
|
|
schema:
|
|
type: path
|
|
- variable: mountPath
|
|
label: Container Device Path
|
|
description: Path inside the container the device is mounted
|
|
schema:
|
|
type: string
|
|
default: "/dev/ttyACM0"
|
|
- variable: scaleGPU
|
|
label: GPU Configuration
|
|
group: Resources and Devices
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: scaleGPUEntry
|
|
label: GPU
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
# Specify GPU configuration
|
|
- variable: gpu
|
|
label: Select GPU
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
$ref:
|
|
- "definitions/gpuConfiguration"
|
|
attrs: []
|
|
- variable: workaround
|
|
label: "Workaround"
|
|
schema:
|
|
type: string
|
|
default: workaround
|
|
hidden: true
|
|
- variable: metrics
|
|
group: Metrics
|
|
label: Prometheus Metrics
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: main
|
|
label: Main Metrics
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enabled
|
|
description: Enable Prometheus Metrics
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: prometheusRule
|
|
label: PrometheusRule
|
|
description: Enable and configure Prometheus Rules for the App.
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enabled
|
|
description: Enable Prometheus Metrics
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
# TODO: Rule List section
|
|
# - variable: horizontalPodAutoscaler
|
|
# group: Advanced
|
|
# label: (Advanced) Horizontal Pod Autoscaler
|
|
# schema:
|
|
# type: list
|
|
# default: []
|
|
# items:
|
|
# - variable: hpaEntry
|
|
# label: HPA Entry
|
|
# schema:
|
|
# additional_attrs: true
|
|
# type: dict
|
|
# attrs:
|
|
# - variable: name
|
|
# label: Name
|
|
# schema:
|
|
# type: string
|
|
# required: true
|
|
# default: ""
|
|
# - variable: enabled
|
|
# label: Enabled
|
|
# schema:
|
|
# type: boolean
|
|
# default: false
|
|
# show_subquestions_if: true
|
|
# subquestions:
|
|
# - variable: target
|
|
# label: Target
|
|
# description: Deployment name, Defaults to Main Deployment
|
|
# schema:
|
|
# type: string
|
|
# default: ""
|
|
# - variable: minReplicas
|
|
# label: Minimum Replicas
|
|
# schema:
|
|
# type: int
|
|
# default: 1
|
|
# - variable: maxReplicas
|
|
# label: Maximum Replicas
|
|
# schema:
|
|
# type: int
|
|
# default: 5
|
|
# - variable: targetCPUUtilizationPercentage
|
|
# label: Target CPU Utilization Percentage
|
|
# schema:
|
|
# type: int
|
|
# default: 80
|
|
# - variable: targetMemoryUtilizationPercentage
|
|
# label: Target Memory Utilization Percentage
|
|
# schema:
|
|
# type: int
|
|
# default: 80
|
|
- variable: networkPolicy
|
|
group: Advanced
|
|
label: (Advanced) Network Policy
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: netPolicyEntry
|
|
label: Network Policy Entry
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
default: ""
|
|
- variable: enabled
|
|
label: Enabled
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: policyType
|
|
label: Policy Type
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
enum:
|
|
- value: ""
|
|
description: Default
|
|
- value: ingress
|
|
description: Ingress
|
|
- value: egress
|
|
description: Egress
|
|
- value: ingress-egress
|
|
description: Ingress and Egress
|
|
- variable: egress
|
|
label: Egress
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: egressEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: to
|
|
label: To
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: toEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: ipBlock
|
|
label: IP Block
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: cidr
|
|
label: CIDR
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: except
|
|
label: Except
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: exceptint
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
- variable: namespaceSelector
|
|
label: Namespace Selector
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: matchExpressions
|
|
label: Match Expressions
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: expressionEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: key
|
|
label: Key
|
|
schema:
|
|
type: string
|
|
- variable: operator
|
|
label: Operator
|
|
schema:
|
|
type: string
|
|
default: TCP
|
|
enum:
|
|
- value: In
|
|
description: In
|
|
- value: NotIn
|
|
description: NotIn
|
|
- value: Exists
|
|
description: Exists
|
|
- value: DoesNotExist
|
|
description: DoesNotExist
|
|
- variable: values
|
|
label: Values
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: value
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
- variable: podSelector
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: matchExpressions
|
|
label: Match Expressions
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: expressionEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: key
|
|
label: Key
|
|
schema:
|
|
type: string
|
|
- variable: operator
|
|
label: Operator
|
|
schema:
|
|
type: string
|
|
default: TCP
|
|
enum:
|
|
- value: In
|
|
description: In
|
|
- value: NotIn
|
|
description: NotIn
|
|
- value: Exists
|
|
description: Exists
|
|
- value: DoesNotExist
|
|
description: DoesNotExist
|
|
- variable: values
|
|
label: Values
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: value
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
- variable: ports
|
|
label: Ports
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: portsEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: port
|
|
label: Port
|
|
schema:
|
|
type: int
|
|
- variable: endPort
|
|
label: End Port
|
|
schema:
|
|
type: int
|
|
- variable: protocol
|
|
label: Protocol
|
|
schema:
|
|
type: string
|
|
default: TCP
|
|
enum:
|
|
- value: TCP
|
|
description: TCP
|
|
- value: UDP
|
|
description: UDP
|
|
- value: SCTP
|
|
description: SCTP
|
|
- variable: ingress
|
|
label: Ingress
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: ingressEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: from
|
|
label: From
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: fromEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: ipBlock
|
|
label: IP Block
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: cidr
|
|
label: CIDR
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: except
|
|
label: Except
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: exceptint
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
- variable: namespaceSelector
|
|
label: Namespace Selector
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: matchExpressions
|
|
label: Match Expressions
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: expressionEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: key
|
|
label: Key
|
|
schema:
|
|
type: string
|
|
- variable: operator
|
|
label: Operator
|
|
schema:
|
|
type: string
|
|
default: TCP
|
|
enum:
|
|
- value: In
|
|
description: In
|
|
- value: NotIn
|
|
description: NotIn
|
|
- value: Exists
|
|
description: Exists
|
|
- value: DoesNotExist
|
|
description: DoesNotExist
|
|
- variable: values
|
|
label: Values
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: value
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
- variable: podSelector
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: matchExpressions
|
|
label: Match Expressions
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: expressionEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: key
|
|
label: Key
|
|
schema:
|
|
type: string
|
|
- variable: operator
|
|
label: Operator
|
|
schema:
|
|
type: string
|
|
default: TCP
|
|
enum:
|
|
- value: In
|
|
description: In
|
|
- value: NotIn
|
|
description: NotIn
|
|
- value: Exists
|
|
description: Exists
|
|
- value: DoesNotExist
|
|
description: DoesNotExist
|
|
- variable: values
|
|
label: Values
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: value
|
|
label: ""
|
|
schema:
|
|
type: string
|
|
- variable: ports
|
|
label: Ports
|
|
schema:
|
|
type: list
|
|
default: []
|
|
items:
|
|
- variable: portsEntry
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: port
|
|
label: Port
|
|
schema:
|
|
type: int
|
|
- variable: endPort
|
|
label: End Port
|
|
schema:
|
|
type: int
|
|
- variable: protocol
|
|
label: Protocol
|
|
schema:
|
|
type: string
|
|
default: TCP
|
|
enum:
|
|
- value: TCP
|
|
description: TCP
|
|
- value: UDP
|
|
description: UDP
|
|
- value: SCTP
|
|
description: SCTP
|
|
- variable: addons
|
|
group: Addons
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: codeserver
|
|
label: Codeserver
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enabled
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: service
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- 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: NodePort
|
|
description: Deprecated CHANGE THIS
|
|
- value: ClusterIP
|
|
description: ClusterIP
|
|
- value: LoadBalancer
|
|
description: LoadBalancer
|
|
- 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: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: codeserver
|
|
label: ""
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: port
|
|
label: Port
|
|
schema:
|
|
type: int
|
|
default: 36107
|
|
- variable: envList
|
|
label: Codeserver Environment Variables
|
|
schema:
|
|
type: list
|
|
show_if: [["type", "!=", "disabled"]]
|
|
default: []
|
|
items:
|
|
- variable: envItem
|
|
label: Environment Variable
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: value
|
|
label: Value
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: netshoot
|
|
label: Netshoot
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: enabled
|
|
label: Enabled
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
show_subquestions_if: true
|
|
subquestions:
|
|
- variable: envList
|
|
label: Netshoot Environment Variables
|
|
schema:
|
|
type: list
|
|
show_if: [["type", "!=", "disabled"]]
|
|
default: []
|
|
items:
|
|
- variable: envItem
|
|
label: Environment Variable
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: value
|
|
label: Value
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: vpn
|
|
label: VPN
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: type
|
|
label: Type
|
|
schema:
|
|
type: string
|
|
default: disabled
|
|
enum:
|
|
- value: disabled
|
|
description: disabled
|
|
- value: gluetun
|
|
description: Gluetun
|
|
- value: tailscale
|
|
description: Tailscale
|
|
- value: openvpn
|
|
description: OpenVPN (Deprecated)
|
|
- value: wireguard
|
|
description: Wireguard (Deprecated)
|
|
- variable: openvpn
|
|
label: OpenVPN Settings
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
show_if: [["type", "=", "openvpn"]]
|
|
attrs:
|
|
- variable: username
|
|
label: Authentication Username (Optional)
|
|
description: Authentication Username, Optional
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: password
|
|
label: Authentication Password
|
|
description: Authentication Credentials
|
|
schema:
|
|
type: string
|
|
show_if: [["username", "!=", ""]]
|
|
default: ""
|
|
required: true
|
|
- variable: tailscale
|
|
label: Tailscale Settings
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
show_if: [["type", "=", "tailscale"]]
|
|
attrs:
|
|
- variable: authkey
|
|
label: Authentication Key
|
|
description: Provide an auth key to automatically authenticate the node as your user account.
|
|
schema:
|
|
type: string
|
|
private: true
|
|
default: ""
|
|
- variable: auth_once
|
|
label: Auth Once
|
|
description: Only attempt to log in if not already logged in.
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- variable: accept_dns
|
|
label: Accept DNS
|
|
description: Accept DNS configuration from the admin console.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: userspace
|
|
label: Userspace
|
|
description: Userspace Networking mode allows running Tailscale where you do not have access to create a VPN tunnel device.
|
|
schema:
|
|
type: boolean
|
|
default: false
|
|
- variable: routes
|
|
label: Routes
|
|
description: Expose physical subnet routes to your entire Tailscale network.
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: dest_ip
|
|
label: Destination IP
|
|
description: Tells the DNAT mechanism which Destination IP to set in the IP header, and where to send packets that are matched.
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: sock5_server
|
|
label: Sock5 Server
|
|
description: The address on which to listen for SOCKS5 proxying into the tailscale net.
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: outbound_http_proxy_listen
|
|
label: Outbound HTTP Proxy Listen
|
|
description: The address on which to listen for HTTP proxying into the tailscale net.
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: extra_args
|
|
label: Extra Args
|
|
description: Extra Args
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: daemon_extra_args
|
|
label: Tailscale Daemon Extra Args
|
|
description: Tailscale Daemon Extra Args
|
|
schema:
|
|
type: string
|
|
default: ""
|
|
- variable: killSwitch
|
|
label: Enable Killswitch
|
|
schema:
|
|
type: boolean
|
|
show_if: [["type", "!=", "disabled"]]
|
|
default: true
|
|
- variable: excludedNetworks_IPv4
|
|
label: Killswitch Excluded IPv4 networks
|
|
description: List of Killswitch Excluded IPv4 Addresses
|
|
schema:
|
|
type: list
|
|
show_if: [["type", "!=", "disabled"]]
|
|
default: []
|
|
items:
|
|
- variable: networkv4
|
|
label: IPv4 Network
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: excludedNetworks_IPv6
|
|
label: Killswitch Excluded IPv6 networks
|
|
description: "List of Killswitch Excluded IPv6 Addresses"
|
|
schema:
|
|
type: list
|
|
show_if: [["type", "!=", "disabled"]]
|
|
default: []
|
|
items:
|
|
- variable: networkv6
|
|
label: IPv6 Network
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: configFile
|
|
label: VPN Config File Location
|
|
schema:
|
|
type: string
|
|
show_if: [["type", "!=", "disabled"]]
|
|
default: ""
|
|
|
|
- variable: envList
|
|
label: VPN Environment Variables
|
|
schema:
|
|
type: list
|
|
show_if: [["type", "!=", "disabled"]]
|
|
default: []
|
|
items:
|
|
- variable: envItem
|
|
label: Environment Variable
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: name
|
|
label: Name
|
|
schema:
|
|
type: string
|
|
required: true
|
|
- variable: value
|
|
label: Value
|
|
schema:
|
|
type: string
|
|
required: true
|
|
max_length: 10240
|
|
- variable: docs
|
|
group: Documentation
|
|
label: Please read the documentation at https://truecharts.org
|
|
description: Please read the documentation at
|
|
<br /><a href="https://truecharts.org">https://truecharts.org</a>
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: confirmDocs
|
|
label: I have checked the documentation
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
- variable: donateNag
|
|
group: Documentation
|
|
label: Please consider supporting TrueCharts, see https://truecharts.org/sponsor
|
|
description: Please consider supporting TrueCharts, see
|
|
<br /><a href="https://truecharts.org/sponsor">https://truecharts.org/sponsor</a>
|
|
schema:
|
|
additional_attrs: true
|
|
type: dict
|
|
attrs:
|
|
- variable: confirmDonate
|
|
label: I have considered donating
|
|
schema:
|
|
type: boolean
|
|
default: true
|
|
hidden: true
|