# Include{groups} portals: web_portal: protocols: - "$kubernetes-resource_configmap_portal_protocol" host: - "$kubernetes-resource_configmap_portal_host" ports: - "$kubernetes-resource_configmap_portal_port" questions: - variable: portal group: "Container Image" label: "Configure Portal Button" schema: type: dict hidden: true attrs: - variable: enabled label: "Enable" description: "enable the portal button" schema: hidden: true editable: false type: boolean default: true - variable: controller group: "Controller" label: "" schema: type: dict attrs: - variable: type description: "Please specify type of workload to deploy" label: "(Advanced) Controller Type" schema: type: string default: "deployment" required: true enum: - value: "deployment" description: "Deployment" - value: "statefulset" description: "Statefulset" - value: "daemonset" description: "Daemonset" - variable: replicas description: "Number of desired pod replicas" label: "Desired Replicas" schema: type: int default: 1 required: true - variable: strategy description: "Please specify type of workload to deploy" label: "(Advanced) Update Strategy" schema: type: string default: "Recreate" required: true enum: - value: "Recreate" description: "Recreate: Kill existing pods before creating new ones" - value: "RollingUpdate" description: "RollingUpdate: Create new pods and then kill old ones" - value: "OnDelete" description: "(Legacy) OnDelete: ignore .spec.template changes" # Include{controllerExpert} - variable: env group: "Container Configuration" label: "Image Environment" schema: type: dict attrs: - variable: TZ label: "Timezone" schema: type: string default: "Etc/UTC" $ref: - "definitions/timezone" - variable: UMASK label: "UMASK" description: "Sets the UMASK env var for LinuxServer.io (compatible) containers" schema: type: string default: "002" # Include{containerConfig} - variable: vaultwarden label: "" group: "App Configuration" schema: type: dict attrs: - variable: yubico label: "Yubico OTP authentication" schema: type: dict attrs: - variable: enabled label: "Enable Yubico OTP authentication" description: "Please refer to the manual at: https://github.com/dani-garcia/vaultwarden/wiki/Enabling-Yubikey-OTP-authentication" schema: type: boolean default: false show_subquestions_if: true subquestions: - variable: server label: "Yubico server" description: "Defaults to YubiCloud" schema: type: string default: "" - variable: clientId label: "Yubico ID" schema: type: string default: "" - variable: secretKey label: "Yubico Secret Key" schema: type: string default: "" - variable: admin label: "Admin Portal" schema: type: dict attrs: - variable: enabled label: "Enable Admin Portal" schema: type: boolean default: false show_subquestions_if: true subquestions: - variable: disableAdminToken label: "Make Accessible Without Password/Token" schema: type: boolean default: false - variable: token label: "Admin Portal Password/Token" description: "Will be automatically generated if not defined" schema: type: string default: "" - variable: icons label: "Icon Download Settings" schema: type: dict attrs: - variable: disableDownload label: "Disable Icon Download" description: "Disables download of external icons. Setting to true will still serve icons from cache (/data/icon_cache)" schema: type: boolean default: false - variable: cache label: "Cache time-to-live" description: "Cache time-to-live for icons fetched. 0 means no purging" schema: type: int default: 2592000 - variable: token label: "Failed Downloads Cache time-to-live" description: "Cache time-to-live for icons that were not available. 0 means no purging." schema: type: int default: 2592000 - variable: log label: "Logging" schema: type: dict attrs: - variable: level label: "Log level" schema: type: string default: "info" required: true enum: - value: "trace" description: "trace" - value: "debug" description: "debug" - value: "info" description: "info" - value: "warn" description: "warn" - value: "error" description: "error" - value: "off" description: "off" - variable: file label: "Log-File Location" schema: type: string default: "" - variable: smtp label: "SMTP Settings (Email)" schema: type: dict attrs: - variable: enabled label: "Enable SMTP Support" schema: type: boolean default: false show_subquestions_if: true subquestions: - variable: host label: "SMTP hostname" schema: type: string required: true default: "" - variable: from label: "SMTP sender e-mail address" schema: type: string required: true default: "" - variable: fromName label: "SMTP sender name" schema: type: string required: true default: "" - variable: user label: "SMTP username" schema: type: string required: true default: "" - variable: password label: "SMTP password" description: "Required is user is specified, ignored if no user provided" schema: type: string default: "" - variable: ssl label: "Enable SSL connection" schema: type: boolean default: true - variable: port label: "SMTP port" description: "Usually: 25 without SSL, 587 with SSL" schema: type: int default: 587 - variable: authMechanism label: "SMTP Authentication Mechanisms" description: "Comma-separated options: Plain, Login and Xoauth2" schema: type: string default: "Plain" - variable: heloName label: "SMTP HELO - Hostname" description: "Hostname to be sent for SMTP HELO. Defaults to pod name" schema: type: string default: "" - variable: port label: "SMTP timeout" schema: type: int default: 15 - variable: invalidHostname label: "Accept Invalid Hostname" description: "Accept SSL session if certificate is valid but hostname doesn't match. DANGEROUS, vulnerable to men-in-the-middle attacks!" schema: type: boolean default: false - variable: invalidCertificate label: "Accept Invalid Certificate" description: "Accept invalid certificates. DANGEROUS, vulnerable to men-in-the-middle attacks!" schema: type: boolean default: false - variable: allowSignups label: "Allow Signup" description: "Allow any user to sign-up: https://github.com/dani-garcia/vaultwarden/wiki/Disable-registration-of-new-users" schema: type: boolean default: true - variable: allowInvitation label: "Always allow Invitation" description: "Allow invited users to sign-up even feature is disabled: https://github.com/dani-garcia/vaultwarden/wiki/Disable-invitations" schema: type: boolean default: true - variable: defaultInviteName label: "Default Invite Organisation Name" description: "Default organization name in invitation e-mails that are not coming from a specific organization." schema: type: string default: "" - variable: showPasswordHint label: "Show password hints" description: "https://github.com/dani-garcia/vaultwarden/wiki/Password-hint-display" schema: type: boolean default: true - variable: signupwhitelistenable label: "Enable Signup Whitelist" description: "allowSignups is ignored if set" schema: type: boolean default: false show_subquestions_if: true subquestions: - variable: signupDomains label: "Signup Whitelist Domains" schema: type: list default: [] items: - variable: domain label: "Domain" schema: type: string default: "" - variable: verifySignup label: "Verifiy Signup" description: "Verify e-mail before login is enabled. SMTP must be enabled" schema: type: boolean default: false - variable: requireEmail label: "Block Login if email fails" description: "When a user logs in an email is required to be sent. If sending the email fails the login attempt will fail. SMTP must be enabled" schema: type: boolean default: false - variable: emailAttempts label: "Email token reset attempts" description: "Maximum attempts before an email token is reset and a new email will need to be sent" schema: type: int default: 3 - variable: emailTokenExpiration label: "Email token validity in seconds" schema: type: int default: 600 - variable: enableWebsockets label: "Enable Websocket Connections" description: "Enable Websockets for notification. https://github.com/dani-garcia/vaultwarden/wiki/Enabling-WebSocket-notifications" schema: type: boolean default: true hidden: true - variable: enableWebVault label: "Enable Webvault" description: "Enable Web Vault (static content). https://github.com/dani-garcia/vaultwarden/wiki/Disabling-or-overriding-the-Vault-interface-hosting" schema: type: boolean default: true - variable: orgCreationUsers label: "Limit Organisation Creation to (users)" description: "Restrict creation of orgs. Options are: 'all', 'none' or a comma-separated list of users." schema: type: string default: "all" - variable: attachmentLimitOrg label: "Limit Attachment Disk Usage per Organisation" schema: type: string default: "" - variable: attachmentLimitUser label: "Limit Attachment Disk Usage per User" schema: type: string default: "" - variable: hibpApiKey label: "HaveIBeenPwned API Key" description: "Can be purchased at https://haveibeenpwned.com/API/Key" schema: type: string default: "" - variable: service group: "Networking and Services" label: "Configure Service(s)" schema: type: dict attrs: - variable: main label: "Main Service" description: "The Primary service on which the healthcheck runs, often the webUI" schema: 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, nodePorts expose the container to the host node System, Loadbalancer exposes the service using the system loadbalancer" schema: type: string default: "NodePort" enum: - value: "NodePort" description: "NodePort" - value: "ClusterIP" description: "ClusterIP" - value: "LoadBalancer" description: "LoadBalancer" - variable: loadBalancerIP label: "LoadBalancer IP" description: "LoadBalancerIP" schema: show_if: [["type", "=", "LoadBalancer"]] type: string default: "" - variable: externalIPs label: "External IP's" description: "External IP's" schema: show_if: [["type", "=", "LoadBalancer"]] type: list default: [] items: - variable: externalIP label: "External IP" schema: type: string - variable: ports label: "Service's Port(s) Configuration" schema: type: dict attrs: - variable: main label: "Main Service Port Configuration" schema: type: dict attrs: - variable: enabled label: "Enable the port" schema: type: boolean default: true hidden: true - variable: protocol label: "Port Type" schema: type: string default: "HTTP" 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 default: 8080 editable: false hidden: true - variable: port label: "Container Port" schema: type: int default: 8080 editable: true required: true - variable: nodePort label: "Node Port (Optional)" description: "This port gets exposed to the node. Only considered when service type is NodePort" schema: type: int min: 9000 max: 65535 default: 36000 - variable: ws label: "WebSocket Service" description: "WebSocket Service" schema: 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, nodePorts expose the container to the host node System, Loadbalancer exposes the service using the system loadbalancer" schema: type: string default: "ClusterIP" enum: - value: "NodePort" description: "NodePort" - value: "ClusterIP" description: "ClusterIP" - value: "LoadBalancer" description: "LoadBalancer" - variable: loadBalancerIP label: "LoadBalancer IP" description: "LoadBalancerIP" schema: show_if: [["type", "=", "LoadBalancer"]] type: string default: "" - variable: externalIPs label: "External IP's" description: "External IP's" schema: show_if: [["type", "=", "LoadBalancer"]] type: list default: [] items: - variable: externalIP label: "External IP" schema: type: string - variable: ports label: "Service's Port(s) Configuration" schema: type: dict attrs: - variable: ws label: "WebSocket Service Port Configuration" schema: type: dict attrs: - variable: enabled label: "Enable the port" schema: type: boolean default: true hidden: true - variable: protocol label: "Port Type" schema: type: string default: "HTTP" 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 default: 3012 editable: false hidden: true - variable: port label: "Container Port" schema: type: int default: 3012 editable: true required: true - variable: nodePort label: "Node Port (Optional)" description: "This port gets exposed to the node. Only considered when service type is NodePort" schema: type: int min: 9000 max: 65535 default: 36001 - 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: dnsPolicy group: "Networking and Services" label: "dnsPolicy" schema: type: string default: "" enum: - value: "" description: "Default" - value: "ClusterFirst" description: "ClusterFirst" - value: "ClusterFirstWithHostNet" description: "ClusterFirstWithHostNet" - value: "None" description: "None" - variable: dnsConfig label: "DNS Configuration" group: "Networking and Services" description: "Specify custom DNS configuration which will be applied to the pod" schema: type: dict attrs: - variable: nameservers label: "Nameservers" schema: default: [] type: list items: - variable: nameserver label: "Nameserver" schema: type: string - variable: options label: "options" schema: default: [] type: list items: - variable: option label: "Option Entry" schema: type: string - variable: searches label: "Searches" schema: default: [] type: list items: - variable: search label: "Search Entry" schema: type: string # Include{serviceList} - variable: persistence label: "Integrated Persistent Storage" description: "Integrated Persistent Storage" group: "Storage and Persistence" schema: type: dict attrs: - variable: data label: "App Config Storage" description: "Stores the Application Configuration." schema: 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: "pvc" enum: - value: "pvc" description: "pvc" - value: "emptyDir" description: "emptyDir" - value: "hostPath" description: "hostPath" - variable: storageClass label: "(Advanced) storageClass" description: " Warning: Anything other than SCALE-ZFS will break rollback!" schema: show_if: [["type", "=", "pvc"]] type: string default: "SCALE-ZFS" - variable: setPermissions label: "Automatic Permissions" description: "Automatically set permissions on install" schema: show_if: [["type", "=", "hostPath"]] type: boolean default: true - variable: readOnly label: "readOnly" schema: type: boolean default: false - variable: hostPath label: "hostPath" description: "Path inside the container the storage is mounted" schema: show_if: [["type", "=", "hostPath"]] type: hostpath - variable: hostPathType label: "hostPath Type" schema: show_if: [["type", "=", "hostPath"]] type: string default: "" enum: - value: "" description: "Default" - value: "DirectoryOrCreate" description: "DirectoryOrCreate" - value: "Directory" description: "Directory" - value: "FileOrCreate" description: "FileOrCreate" - value: "File" description: "File" - value: "Socket" description: "Socket" - value: "CharDevice" description: "CharDevice" - value: "BlockDevice" description: "BlockDevice" - variable: mountPath label: "mountPath" description: "Path inside the container the storage is mounted" schema: type: string default: "/data" hidden: true - variable: medium label: "EmptyDir Medium" schema: show_if: [["type", "=", "emptyDir"]] type: string default: "" enum: - value: "" description: "Default" - value: "Memory" description: "Memory" - variable: accessMode label: "Access Mode (Advanced)" description: "Allow or disallow multiple PVC's writhing to the same PV" schema: show_if: [["type", "=", "pvc"]] type: string default: "ReadWriteOnce" enum: - value: "ReadWriteOnce" description: "ReadWriteOnce" - value: "ReadOnlyMany" description: "ReadOnlyMany" - value: "ReadWriteMany" description: "ReadWriteMany" - variable: size label: "Size quotum of storage" schema: show_if: [["type", "=", "pvc"]] type: string default: "100Gi" # Include{persistenceList} - variable: ingress label: "" group: "Ingress" schema: type: dict attrs: - variable: main label: "Main Ingress" schema: 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: 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: type: dict attrs: - variable: path label: "path" schema: type: string required: true default: "/" - variable: pathType label: "pathType" schema: type: string required: true default: "Prefix" - variable: tls label: "TLS-Settings" schema: type: list default: [] items: - variable: tlsEntry label: "Host" schema: 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: 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: expert label: "Show Expert Configuration Options" schema: type: boolean default: false show_subquestions_if: true subquestions: - variable: ingressClassName label: "IngressClass Name" schema: type: string default: "" - variable: labelsList label: "Labels" schema: type: list default: [] items: - variable: labelItem label: "Label" schema: type: dict attrs: - variable: name label: "Name" schema: type: string - variable: value label: "Value" schema: type: string - variable: annotationsList label: "Annotations" schema: type: list default: [] items: - variable: annotationItem label: "Label" schema: type: dict attrs: - variable: name label: "Name" schema: type: string - variable: value label: "Value" schema: type: string # Include{ingressList} - variable: securityContext group: "Security and Permissions" label: "Security Context" schema: 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: true - variable: runAsNonRoot label: "runAsNonRoot" schema: type: boolean default: true - variable: podSecurityContext group: "Security and Permissions" label: "Pod Security Context" schema: type: dict attrs: - 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 this App of the user running the application" schema: type: int default: 568 - variable: fsGroup label: "fsGroup" description: "The group that should own ALL storage." schema: type: int default: 568 - variable: supplementalGroups label: "supplemental Groups" schema: type: list default: [] items: - variable: supplementalGroupsEntry label: "supplemental Group" schema: type: int - variable: fsGroupChangePolicy label: "When should we take ownership?" schema: type: string default: "OnRootMismatch" enum: - value: "OnRootMismatch" description: "OnRootMismatch" - value: "Always" description: "Always" - variable: resources group: "Resources and Devices" label: "" schema: type: dict attrs: - variable: limits label: "Advanced Limit Resource Consumption" schema: type: dict attrs: - variable: cpu label: "CPU" schema: type: string default: "2000m" valid_chars: '^([0-9]+)(\.[0-9]?|m?)$' - variable: memory label: "Memory RAM" schema: type: string default: "2Gi" valid_chars: '^([0-9.]+)([EPTGMK]i?|[EPTGMK]?|e[0-9]+)$' - variable: requests label: "Advanced Request minimum resources required" schema: type: dict attrs: - variable: cpu label: "CPU" schema: type: string default: "10m" valid_chars: '^([0-9]+)(\.[0-9]?|m?)$' - variable: memory label: "Memory RAM" schema: type: string default: "50Mi" valid_chars: '^([0-9.]+)([EPTGMK]i?|[EPTGMK]?|e[0-9]+)$' - variable: autoscaling group: "Resources and Devices" label: "(Advanced) Horizontal Pod Autoscaler" schema: type: dict attrs: - 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 # Include{addons}