# # ============================================================================= # GENERAL CONFIGURATION # ============================================================================= # APP_NAME = name of application for use in scripts # COMPOSE_FILE = default for no app_name in the docker-compose file name, app if there is # BACKUP = if true, include this application in backup operations # UPDATE_TYPE = auto: new image builds are applied automatically (a recovery snapshot is taken first), manual: only when you press Update # HEALTHCHECK = if true, default docker health checks for that container will be enabled # AUTHELIA = if true, use Authelia authentication, if false turned off. # HEADSCALE = options : false, local, remote (see general config). e.g false or local,remote # MONITORING = if true, export this app's metrics to Prometheus + Grafana (needs both apps installed) # CFG_VIKUNJA_APP_NAME=vikunja # MULTI_INSTANCE = if true, this app can run as multiple isolated instances # (own data/DB/subdomain/backups) via `libreportal instance create`. Only set on # apps whose compose identity (container_name, Traefik routers, backup labels) # is instance-safe — see scripts/instance/instance_create.sh. CFG_VIKUNJA_MULTI_INSTANCE=true CFG_VIKUNJA_BACKUP=true # STORAGE = which storage location holds this app's data. Change it with # `libreportal app move vikunja ` — editing here records intent only. CFG_VIKUNJA_STORAGE=default # Storage Location - Which disk holds this app's data [default:Primary] CFG_VIKUNJA_BACKUP_STRATEGY=auto CFG_VIKUNJA_UPDATE_TYPE=auto CFG_VIKUNJA_COMPOSE_FILE=default CFG_VIKUNJA_HEALTHCHECK=true CFG_VIKUNJA_AUTHELIA=false CFG_VIKUNJA_HEADSCALE=false CFG_VIKUNJA_MONITORING=false # # ============================================================================= # METADATA # ============================================================================= # CATEGORY = application category for grouping # TITLE = display name for the application # DESCRIPTION = short description of the application # LONG_DESCRIPTION = detailed description of the application # URL = source repository or documentation URL # ACTIONS = available actions for this application # CFG_VIKUNJA_CATEGORY="productivity" CFG_VIKUNJA_TITLE="Vikunja" CFG_VIKUNJA_DESCRIPTION="Tasks & Project Management" CFG_VIKUNJA_LONG_DESCRIPTION="Organises tasks and projects as lists, kanban boards, tables or a gantt timeline" CFG_VIKUNJA_URL="https://vikunja.io" CFG_VIKUNJA_ACTIONS="configure|install|restart|shutdown|uninstall" # # ============================================================================= # NETWORK CONFIGURATION # ============================================================================= # DOMAIN = number of domain from the general config, useful when using multiple domains # WHITELIST = if true only allow whitelisted ips on traefik, if false allow all # CFG_VIKUNJA_DOMAIN=1 CFG_VIKUNJA_WHITELIST=false CFG_VIKUNJA_NETWORK=default # # ============================================================================= # PORT CONFIGURATION # ============================================================================= # PORT_ = port configuration: app|name|external:internal|access|protocol|login|traefik|webui|description # - app: application name # - name: service identifier (webui, dns, ssh, etc.) # - external:internal: port mapping (external can be 'random' for auto-allocation) # - access: 'public' (internet accessible), 'private' (local network only), 'disabled' (not running) # - protocol: 'tcp' or 'udp' # - login: if true, this port requires basic-auth via Traefik (only meaningful when traefik=true) # - traefik: if true, Traefik handles this port (reverse proxy) # - webui: if true, this port serves the main web interface # - description: human-readable description of the service # CFG_VIKUNJA_PORT_1="vikunja-service|webui|random:3456|public|tcp|false|true|true|Web Interface||tasks"