groups:
- name: Container Image
description: Image to be used for container
- name: General Settings
description: General Deployment 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: VPN
description: VPN
- name: Addons
description: Addon Configuration
- name: Advanced
description: Advanced Configuration
- name: Documentation
description: Documentation
portals:
open:
protocols:
- "$kubernetes-resource_configmap_portal_protocol"
host:
- "$kubernetes-resource_configmap_portal_host"
ports:
- "$kubernetes-resource_configmap_portal_port"
questions:
- variable: global
label: Global Settings
group: "General Settings"
schema:
type: dict
hidden: true
attrs:
- variable: isSCALE
label: Flag this is SCALE
schema:
type: boolean
default: true
hidden: true
- variable: controller
group: "General Settings"
label: ""
schema:
additional_attrs: true
type: dict
attrs:
- variable: replicas
description: Number of desired pod replicas
label: Desired Replicas
schema:
type: int
required: true
default: 1
- variable: customextraargs
group: "General Settings"
label: "Extra Args"
description: "Do not click this unless you know what you are doing"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: extraArgs
label: Extra Args
schema:
type: list
default: []
items:
- variable: arg
label: Arg
schema:
type: string
- variable: weblate
group: "App Configuration"
label: "Weblate Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: general
label: "General Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: WEBLATE_SITE_DOMAIN
label: "WEBLATE_SITE_DOMAIN"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
required: true
default: ""
- variable: WEBLATE_SITE_TITLE
label: "WEBLATE_SITE_TITLE (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_ADMIN_NAME
label: "WEBLATE_ADMIN_NAME (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_ADMIN_EMAIL
label: "WEBLATE_ADMIN_EMAIL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_ADMIN_PASSWORD
label: "WEBLATE_ADMIN_PASSWORD (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_ENABLE_HTTPS
label: "WEBLATE_ENABLE_HTTPS"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_IP_PROXY_HEADER
label: "WEBLATE_IP_PROXY_HEADER (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_SECURE_PROXY_SSL_HEADER
label: "WEBLATE_SECURE_PROXY_SSL_HEADER (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_AUTO_UPDATE
label: "WEBLATE_AUTO_UPDATE (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
enum:
- value: ""
description: "none"
- value: "remote"
description: "remote"
- value: "full"
description: "full"
- variable: WEBLATE_SERVER_EMAIL
label: "WEBLATE_SERVER_EMAIL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_SERVER_EMAIL
label: "WEBLATE_SERVER_EMAIL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_DEFAULT_FROM_EMAIL
label: "WEBLATE_DEFAULT_FROM_EMAIL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_CONTACT_FORM
label: "WEBLATE_CONTACT_FORM (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
enum:
- value: ""
description: "Default"
- value: "reply-to"
description: "reply-to"
- value: "from"
description: "from"
- variable: WEBLATE_ALLOWED_HOSTS
label: "WEBLATE_ALLOWED_HOSTS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_REGISTRATION_OPEN
label: "WEBLATE_REGISTRATION_OPEN"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: true
- variable: WEBLATE_REGISTRATION_ALLOW_BACKENDS
label: "WEBLATE_REGISTRATION_ALLOW_BACKENDS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_REQUIRE_LOGIN
label: "WEBLATE_REQUIRE_LOGIN"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_LOGIN_REQUIRED_URLS_EXCEPTIONS
label: "WEBLATE_LOGIN_REQUIRED_URLS_EXCEPTIONS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_ADD_LOGIN_REQUIRED_URLS_EXCEPTIONS
label: "WEBLATE_ADD_LOGIN_REQUIRED_URLS_EXCEPTIONS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_REMOVE_LOGIN_REQUIRED_URLS_EXCEPTIONS
label: "WEBLATE_REMOVE_LOGIN_REQUIRED_URLS_EXCEPTIONS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_GOOGLE_ANALYTICS_ID
label: "WEBLATE_GOOGLE_ANALYTICS_ID (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_GITHUB_USERNAME
label: "WEBLATE_GITHUB_USERNAME (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_GITHUB_TOKEN
label: "WEBLATE_GITHUB_TOKEN (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_GITLAB_USERNAME
label: "WEBLATE_GITLAB_USERNAME (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_GITLAB_TOKEN
label: "WEBLATE_GITLAB_TOKEN (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_PAGURE_USERNAME
label: "WEBLATE_PAGURE_USERNAME (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_PAGURE_TOKEN
label: "WEBLATE_PAGURE_TOKEN (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SIMPLIFY_LANGUAGES
label: "WEBLATE_SIMPLIFY_LANGUAGES"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: true
- variable: WEBLATE_DEFAULT_ACCESS_CONTROL
label: "WEBLATE_DEFAULT_ACCESS_CONTROL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_DEFAULT_RESTRICTED_COMPONENT
label: "WEBLATE_DEFAULT_RESTRICTED_COMPONENT"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_DEFAULT_TRANSLATION_PROPAGATION
label: "WEBLATE_DEFAULT_TRANSLATION_PROPAGATION"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: true
- variable: WEBLATE_DEFAULT_COMMITER_EMAIL
label: "WEBLATE_DEFAULT_COMMITER_EMAIL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_DEFAULT_COMMITER_NAME
label: "WEBLATE_DEFAULT_COMMITER_NAME (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_DEFAULT_SHARED_TM
label: "WEBLATE_DEFAULT_SHARED_TM"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: true
- variable: WEBLATE_AKISMET_API_KEY
label: "WEBLATE_AKISMET_API_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_GPG_IDENTITY
label: "WEBLATE_GPG_IDENTITY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_URL_PREFIX
label: "WEBLATE_URL_PREFIX (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_SILENCED_SYSTEM_CHECKS
label: "WEBLATE_SILENCED_SYSTEM_CHECKS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_CSP_SCRIPT_SRC
label: "WEBLATE_CSP_SCRIPT_SRC (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_CSP_IMG_SRC
label: "WEBLATE_CSP_IMG_SRC (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_CSP_CONNECT_SRC
label: "WEBLATE_CSP_CONNECT_SRC (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_CSP_STYLE_SRC
label: "WEBLATE_CSP_STYLE_SRC (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_CSP_FONT_SRC
label: "WEBLATE_CSP_FONT_SRC (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_LICENSE_FILTER
label: "WEBLATE_LICENSE_FILTER (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_LICENSE_REQUIRED
label: "WEBLATE_LICENSE_REQUIRED"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_WEBSITE_REQUIRED
label: "WEBLATE_WEBSITE_REQUIRED"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: true
- variable: WEBLATE_HIDE_VERSION
label: "WEBLATE_HIDE_VERSION"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_BASIC_LANGUAGES
label: "WEBLATE_BASIC_LANGUAGES (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_DEFAULT_AUTO_WATCH
label: "WEBLATE_DEFAULT_AUTO_WATCH"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: true
- variable: WEBLATE_RATELIMIT_ATTEMPTS
label: "WEBLATE_RATELIMIT_ATTEMPTS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_RATELIMIT_LOCKOUT
label: "WEBLATE_RATELIMIT_LOCKOUT (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_RATELIMIT_WINDOW
label: "WEBLATE_RATELIMIT_WINDOW (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_ENABLE_AVATARS
label: "WEBLATE_ENABLE_AVATARS"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: true
- variable: WEBLATE_LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH
label: "WEBLATE_LIMIT_TRANSLATION_LENGTH_BY_SOURCE_LENGTH"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: true
- variable: WEBLATE_SSH_EXTRA_ARGS
label: "WEBLATE_SSH_EXTRA_ARGS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_BORG_EXTRA_ARGS
label: "WEBLATE_BORG_EXTRA_ARGS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_DATABASE_BACKUP
label: "WEBLATE_DATABASE_BACKUP (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: "plain"
enum:
- value: "plain"
description: "plain"
- value: "compressed"
description: "compressed"
- value: "none"
description: "none"
- variable: WEBLATE_DEBUG
label: "WEBLATE_DEBUG"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_LOGLEVEL
label: "WEBLATE_LOGLEVEL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: machinetranslate
label: "Machine Translation Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Machine Translation Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_MT_APERTIUM_APY
label: "WEBLATE_MT_APERTIUM_APY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_AWS_REGION
label: "WEBLATE_MT_AWS_REGION (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_AWS_ACCESS_KEY_ID
label: "WEBLATE_MT_AWS_ACCESS_KEY_ID (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_MT_AWS_SECRET_ACCESS_KEY
label: "WEBLATE_MT_AWS_SECRET_ACCESS_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_MT_DEEPL_KEY
label: "WEBLATE_MT_DEEPL_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_MT_DEEPL_API_URL
label: "WEBLATE_MT_DEEPL_API_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_LIBRETRANSLATE_KEY
label: "WEBLATE_MT_LIBRETRANSLATE_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_MT_LIBRETRANSLATE_API_URL
label: "WEBLATE_MT_LIBRETRANSLATE_API_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_GOOGLE_KEY
label: "WEBLATE_MT_GOOGLE_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_MT_GOOGLE_CREDENTIALS
label: "WEBLATE_MT_GOOGLE_CREDENTIALS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_GOOGLE_PROJECT
label: "WEBLATE_MT_GOOGLE_PROJECT (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_GOOGLE_LOCATION
label: "WEBLATE_MT_GOOGLE_LOCATION (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_MICROSOFT_COGNITIVE_KEY
label: "WEBLATE_MT_MICROSOFT_COGNITIVE_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_MT_MICROSOFT_ENDPOINT_URL
label: "WEBLATE_MT_MICROSOFT_ENDPOINT_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_MICROSOFT_REGION
label: "WEBLATE_MT_MICROSOFT_REGION (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_MICROSOFT_BASE_URL
label: "WEBLATE_MT_MICROSOFT_BASE_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_MODERNMT_KEY
label: "WEBLATE_MT_MODERNMT_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_MT_MYMEMORY_ENABLED
label: "WEBLATE_MT_MYMEMORY_ENABLED"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_MT_GLOSBE_ENABLED
label: "WEBLATE_MT_GLOSBE_ENABLED"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_MT_MICROSOFT_TERMINOLOGY_ENABLED
label: "WEBLATE_MT_MICROSOFT_TERMINOLOGY_ENABLED"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_MT_SAP_BASE_URL
label: "WEBLATE_MT_SAP_BASE_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_SAP_SANDBOX_APIKEY
label: "WEBLATE_MT_SAP_SANDBOX_APIKEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_MT_SAP_USERNAME
label: "WEBLATE_MT_SAP_USERNAME (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_MT_SAP_PASSWORD
label: "WEBLATE_MT_SAP_PASSWORD (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_MT_SAP_USE_MT
label: "WEBLATE_MT_SAP_USE_MT"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: auth
label: "Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: ldap
label: "LDAP Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show LDAP Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_AUTH_LDAP_SERVER_URI
label: "WEBLATE_AUTH_LDAP_SERVER_URI (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_AUTH_LDAP_USER_DN_TEMPLATE
label: "WEBLATE_AUTH_LDAP_USER_DN_TEMPLATE (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_AUTH_LDAP_USER_ATTR_MAP
label: "WEBLATE_AUTH_LDAP_USER_ATTR_MAP (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_AUTH_LDAP_BIND_DN
label: "WEBLATE_AUTH_LDAP_BIND_DN (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_AUTH_LDAP_BIND_PASSWORD
label: "WEBLATE_AUTH_LDAP_BIND_PASSWORD (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_AUTH_LDAP_CONNECTION_OPTION_REFERRALS
label: "WEBLATE_AUTH_LDAP_CONNECTION_OPTION_REFERRALS"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_AUTH_LDAP_USER_SEARCH
label: "WEBLATE_AUTH_LDAP_USER_SEARCH (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_AUTH_LDAP_USER_SEARCH_FILTER
label: "WEBLATE_AUTH_LDAP_USER_SEARCH_FILTER (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_AUTH_LDAP_USER_SEARCH_UNION
label: "WEBLATE_AUTH_LDAP_USER_SEARCH_UNION (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_AUTH_LDAP_USER_SEARCH_UNION_DELIMITER
label: "WEBLATE_AUTH_LDAP_USER_SEARCH_UNION_DELIMITER (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: github
label: "Github Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Github Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_GITHUB_KEY
label: "WEBLATE_SOCIAL_AUTH_GITHUB_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GITHUB_SECRET
label: "WEBLATE_SOCIAL_AUTH_GITHUB_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GITHUB_ORG_KEY
label: "WEBLATE_SOCIAL_AUTH_GITHUB_ORG_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GITHUB_ORG_SECRET
label: "WEBLATE_SOCIAL_AUTH_GITHUB_ORG_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GITHUB_ORG_NAME
label: "WEBLATE_SOCIAL_AUTH_GITHUB_ORG_NAME (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GITHUB_TEAM_KEY
label: "WEBLATE_SOCIAL_AUTH_GITHUB_TEAM_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GITHUB_TEAM_SECRET
label: "WEBLATE_SOCIAL_AUTH_GITHUB_TEAM_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GITHUB_TEAM_ID
label: "WEBLATE_SOCIAL_AUTH_GITHUB_TEAM_ID (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: bitbucket
label: "Bitbucket Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Bitbucket Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_BITBUCKET_KEY
label: "WEBLATE_SOCIAL_AUTH_BITBUCKET_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_BITBUCKET_SECRET
label: "WEBLATE_SOCIAL_AUTH_BITBUCKET_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: facebook
label: "Facebook Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Facebook Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_FACEBOOK_KEY
label: "WEBLATE_SOCIAL_AUTH_FACEBOOK_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_FACEBOOK_SECRET
label: "WEBLATE_SOCIAL_AUTH_FACEBOOK_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: google
label: "Google Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Google Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_KEY
label: "WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET
label: "WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS
label: "WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_DOMAINS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_EMAILS
label: "WEBLATE_SOCIAL_AUTH_GOOGLE_OAUTH2_WHITELISTED_EMAILS (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: gitlab
label: "Gitlab Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Gitlab Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_GITLAB_KEY
label: "WEBLATE_SOCIAL_AUTH_GITLAB_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GITLAB_SECRET
label: "WEBLATE_SOCIAL_AUTH_GITLAB_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_GITLAB_API_URL
label: "WEBLATE_SOCIAL_AUTH_GITLAB_API_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: azure
label: "Azure AD Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Azure AD Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_KEY
label: "WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET
label: "WEBLATE_SOCIAL_AUTH_AZUREAD_OAUTH2_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: azuretenant
label: "Azure AD with Tenant Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Azure AD with Tenant Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_KEY
label: "WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_SECRET
label: "WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_TENANT_ID
label: "WEBLATE_SOCIAL_AUTH_AZUREAD_TENANT_OAUTH2_TENANT_ID (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: keycloak
label: "Keycloak Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Keycloak Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_KEYCLOAK_KEY
label: "WEBLATE_SOCIAL_AUTH_KEYCLOAK_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_KEYCLOAK_SECRET
label: "WEBLATE_SOCIAL_AUTH_KEYCLOAK_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_KEYCLOAK_PUBLIC_KEY
label: "WEBLATE_SOCIAL_AUTH_KEYCLOAK_PUBLIC_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SOCIAL_AUTH_KEYCLOAK_ALGORITHM
label: "WEBLATE_SOCIAL_AUTH_KEYCLOAK_ALGORITHM (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_SOCIAL_AUTH_KEYCLOAK_AUTHORIZATION_URL
label: "WEBLATE_SOCIAL_AUTH_KEYCLOAK_AUTHORIZATION_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_SOCIAL_AUTH_KEYCLOAK_ACCESS_TOKEN_URL
label: "WEBLATE_SOCIAL_AUTH_KEYCLOAK_ACCESS_TOKEN_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: linux
label: "Linux Vendors Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Linux Vendors Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_FEDORA
label: "WEBLATE_SOCIAL_AUTH_FEDORA"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_SOCIAL_AUTH_OPENSUSE
label: "WEBLATE_SOCIAL_AUTH_OPENSUSE"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_SOCIAL_AUTH_UBUNTU
label: "WEBLATE_SOCIAL_AUTH_UBUNTU"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: slack
label: "Slack Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Slack Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SOCIAL_AUTH_SLACK_KEY
label: "WEBLATE_SOCIAL_AUTH_SLACK_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: SOCIAL_AUTH_SLACK_SECRET
label: "SOCIAL_AUTH_SLACK_SECRET (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: saml
label: "SAML Authentication Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show SAML Authentication Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_SAML_IDP_ENTITY_ID
label: "WEBLATE_SAML_IDP_ENTITY_ID (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_SAML_IDP_URL
label: "WEBLATE_SAML_IDP_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_SAML_IDP_X509CERT
label: "WEBLATE_SAML_IDP_X509CERT (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: email
label: "Email Server Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Email Server Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_EMAIL_HOST
label: "WEBLATE_EMAIL_HOST (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_EMAIL_PORT
label: "WEBLATE_EMAIL_PORT (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_EMAIL_HOST_USER
label: "WEBLATE_EMAIL_HOST_USER (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_EMAIL_HOST_PASSWORD
label: "WEBLATE_EMAIL_HOST_PASSWORD (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: WEBLATE_EMAIL_USE_SSL
label: "WEBLATE_EMAIL_USE_SSL"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_EMAIL_USE_TLS
label: "WEBLATE_EMAIL_USE_TLS"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: boolean
default: false
- variable: WEBLATE_EMAIL_BACKEND
label: "WEBLATE_EMAIL_BACKEND (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: siteintegration
label: "Site Integration Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Site Integration Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_GET_HELP_URL
label: "WEBLATE_GET_HELP_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_STATUS_URL
label: "WEBLATE_STATUS_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_LEGAL_URL
label: "WEBLATE_LEGAL_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_PRIVACY_URL
label: "WEBLATE_PRIVACY_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: errorreporting
label: "Error Reporting Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Error Reporting Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: ROLLBAR_KEY
label: "ROLLBAR_KEY (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
private: true
default: ""
- variable: ROLLBAR_ENVIRONMENT
label: "ROLLBAR_ENVIRONMENT (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: SENTRY_DSN
label: "SENTRY_DSN (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: SENTRY_ENVIRONMENT
label: "SENTRY_ENVIRONMENT (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: localization
label: "Localization CDN Configuration"
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: "Show Localization CDN Settings"
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: WEBLATE_LOCALIZE_CDN_URL
label: "WEBLATE_LOCALIZE_CDN_URL (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- variable: WEBLATE_LOCALIZE_CDN_PATH
label: "WEBLATE_LOCALIZE_CDN_PATH (Leave empty for default)"
description: "Visit https://docs.weblate.org/en/ on section Environment Variables for more info"
schema:
type: string
default: ""
- 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: 10158
required: true
- variable: serviceexpert
group: Networking and Services
label: Show Expert Config
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: hostNetwork
group: Networking and Services
label: Host-Networking (Complicated)
schema:
type: boolean
default: false
- variable: externalInterfaces
description: Add External Interfaces
label: Add external Interfaces
group: Networking
schema:
type: list
items:
- variable: interfaceConfiguration
description: Interface Configuration
label: Interface Configuration
schema:
type: dict
$ref:
- "normalize/interfaceConfiguration"
attrs:
- variable: hostInterface
description: Please Specify Host Interface
label: Host Interface
schema:
type: string
required: true
$ref:
- "definitions/interface"
- variable: ipam
description: Define how IP Address will be managed
label: IP Address Management
schema:
type: dict
required: true
attrs:
- variable: type
description: Specify type for IPAM
label: IPAM Type
schema:
type: string
required: true
enum:
- value: dhcp
description: Use DHCP
- value: static
description: Use Static IP
show_subquestions_if: static
subquestions:
- variable: staticIPConfigurations
label: Static IP Addresses
schema:
type: list
items:
- variable: staticIP
label: Static IP
schema:
type: ipaddr
cidr: true
- variable: staticRoutes
label: Static Routes
schema:
type: list
items:
- variable: staticRouteConfiguration
label: Static Route Configuration
schema:
additional_attrs: true
type: dict
attrs:
- variable: destination
label: Destination
schema:
type: ipaddr
cidr: true
required: true
- variable: gateway
label: Gateway
schema:
type: ipaddr
cidr: false
required: true
- variable: serviceList
label: Add Manual Custom Services
group: Networking and Services
schema:
type: list
default: []
items:
- variable: serviceListEntry
label: Custom Service
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: Enable the service
schema:
type: boolean
default: true
hidden: true
- variable: name
label: Name
schema:
type: string
default: ""
- variable: type
label: Service Type
description: "ClusterIP's are only internally available and Loadbalancer exposes the service using the system loadbalancer"
schema:
type: string
default: LoadBalancer
enum:
- value: LoadBalancer
description: LoadBalancer (Expose Ports)
- value: ClusterIP
description: ClusterIP (Do Not Expose Ports)
- value: Simple
description: Deprecated CHANGE THIS
- variable: loadBalancerIP
label: LoadBalancer IP
description: "MetalLB Only: Selects the Loadbalancer IP to expose on. Required when using PortalButton with MetalLB"
schema:
show_if: [["type", "=", "LoadBalancer"]]
type: string
default: ""
- variable: advancedsvcset
label: Show Advanced Service Settings
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: externalIPs
label: "External IP's"
description: "External IP's"
schema:
type: list
default: []
items:
- variable: externalIP
label: External IP
schema:
type: string
- variable: ipFamilyPolicy
label: IP Family Policy
description: Specify the IP Policy
schema:
type: string
default: SingleStack
enum:
- value: SingleStack
description: SingleStack
- value: PreferDualStack
description: PreferDualStack
- value: RequireDualStack
description: RequireDualStack
- variable: ipFamilies
label: IP Families
description: (Advanced) The IP Families that should be used
schema:
type: list
default: []
items:
- variable: ipFamily
label: IP Family
schema:
type: string
- variable: portsList
label: Additional Service Ports
schema:
type: list
default: []
items:
- variable: portsListEntry
label: Custom ports
schema:
additional_attrs: true
type: dict
attrs:
- variable: enabled
label: Enable the Port
schema:
type: boolean
default: true
hidden: true
- variable: name
label: Port Name
schema:
type: string
default: ""
- variable: protocol
label: Port Type
schema:
type: string
default: TCP
enum:
- value: HTTP
description: HTTP
- value: HTTPS
description: HTTPS
- value: TCP
description: TCP
- value: UDP
description: UDP
- variable: targetPort
label: Target Port
description: This port exposes the container port on the service
schema:
type: int
required: true
- variable: port
label: Container Port
schema:
type: int
required: true
- variable: persistence
label: Integrated Persistent Storage
description: Integrated Persistent Storage
group: Storage and Persistence
schema:
additional_attrs: true
type: dict
attrs:
- variable: 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: 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
schema:
type: string
default: ""
required: true
valid_chars: '^\/([a-zA-Z0-9._-]+(\s?[a-zA-Z0-9._-]+|\/?))+$'
- 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
schema:
show_if: [["type", "=", "pvc"]]
type: string
default: 256Gi
- 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: tls
label: TLS-Settings
schema:
type: list
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: scaleCert
label: Select TrueNAS SCALE Certificate
schema:
type: int
$ref:
- "definitions/certificate"
- variable: entrypoint
label: (Advanced) Traefik Entrypoint
description: Entrypoint used by Traefik when using Traefik as Ingress Provider
schema:
type: string
default: websecure
required: true
- variable: ingressClassName
label: (Advanced/Optional) IngressClass Name
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: 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: tls
label: TLS-Settings
schema:
type: list
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: scaleCert
label: Select TrueNAS SCALE Certificate
schema:
type: int
$ref:
- "definitions/certificate"
- 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: security
label: Container Security Settings
group: Security and Permissions
schema:
type: dict
additional_attrs: true
attrs:
- variable: editsecurity
label: Change PUID / UMASK values
description: By enabling this you override default set values.
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- 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
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: "002"
- variable: advancedSecurity
label: Show Advanced Security Settings
group: Security and Permissions
schema:
type: boolean
default: false
show_subquestions_if: true
subquestions:
- variable: securityContext
label: Security Context
schema:
additional_attrs: true
type: dict
attrs:
- variable: privileged
label: "Privileged mode"
schema:
type: boolean
default: false
- variable: readOnlyRootFilesystem
label: "ReadOnly Root Filesystem"
schema:
type: boolean
default: false
- variable: allowPrivilegeEscalation
label: "Allow Privilege Escalation"
schema:
type: boolean
default: false
- variable: runAsNonRoot
label: "runAsNonRoot"
schema:
type: boolean
default: true
- variable: podSecurityContext
group: Security and Permissions
label: Pod Security Context
schema:
additional_attrs: true
type: dict
attrs:
- variable: runAsUser
label: "runAsUser"
description: "The UserID of the user running the application"
schema:
type: int
default: 1000
- variable: runAsGroup
label: "runAsGroup"
description: "The groupID this App of the user running the application"
schema:
type: int
default: 0
- variable: fsGroup
label: "fsGroup"
description: "The group that should own ALL storage."
schema:
type: int
default: 1000
- 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
- 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/docs/manual/SCALE%20Apps/indepth/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/docs/manual/SCALE%20Apps/indepth/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/docs/manual/SCALE%20Apps/indepth/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/docs/manual/SCALE%20Apps/indepth/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: hostPath
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"
# Specify GPU configuration
- variable: scaleGPU
label: GPU Configuration
group: Resources and Devices
schema:
type: dict
$ref:
- "definitions/gpuConfiguration"
attrs: []
- 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: git
label: Git Settings
schema:
additional_attrs: true
type: dict
attrs:
- variable: deployKey
description: Raw SSH Private Key
label: Deploy Key
schema:
type: string
- variable: deployKeyBase64
description: Base64-encoded SSH private key. When both variables are set, the raw SSH key takes precedence
label: Deploy Key Base64
schema:
type: string
- 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: 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: 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: nodePort
description: Leave Empty to Disable
label: nodePort DEPRECATED
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: 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: openvpn
description: OpenVPN
- value: wireguard
description: Wireguard
- value: tailscale
description: Tailscale
- variable: openvpn
label: OpenVPN Settings
schema:
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
default: ""
required: true
- variable: tailscale
label: Tailscale Settings
schema:
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: dict
show_if: [["type", "!=", "disabled"]]
attrs:
- variable: enabled
label: Enabled
schema:
type: boolean
default: true
hidden: true
- variable: type
label: Type
schema:
type: string
default: hostPath
hidden: true
- variable: hostPathType
label: hostPathType
schema:
type: string
default: File
hidden: true
- variable: noMount
label: noMount
schema:
type: boolean
default: true
hidden: true
- variable: hostPath
label: Full Path to File
description: "Path to your local VPN config file for example: /mnt/tank/vpn.conf or /mnt/tank/vpn.ovpn"
schema:
type: string
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
- variable: docs
group: Documentation
label: Please read the documentation at https://truecharts.org
description: Please read the documentation at
https://truecharts.org
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
https://truecharts.org/sponsor
schema:
additional_attrs: true
type: dict
attrs:
- variable: confirmDonate
label: I have considered donating
schema:
type: boolean
default: true
hidden: true