readme-vars.yml

---

# project information
project_name: budge
project_url: "https://github.com/linuxserver/budge"
project_logo: ""
project_blurb: "[{{ project_name }}]({{ project_url }}) is an open source 'budgeting with envelopes' personal finance app."
project_lsio_github_repo_url: "https://github.com/linuxserver/docker-{{ project_name }}"
project_categories: "Finance"
# supported architectures
available_architectures:
  - {arch: "{{ arch_x86_64 }}", tag: "amd64-latest"}
  - {arch: "{{ arch_arm64 }}", tag: "arm64v8-latest"}
# container parameters
common_param_env_vars_enabled: true #PGID, PUID, etc
param_container_name: "{{ project_name }}"
param_usage_include_vols: true
param_volumes:
  - {vol_path: "/config", vol_host_path: "/path/to/{{ project_name }}/config", desc: "Persistent config files"}
param_usage_include_ports: true
param_ports:
  - {external_port: "80", internal_port: "80", port_desc: "http gui"}
  - {external_port: "443", internal_port: "443", port_desc: "https gui"}
# application setup block
app_setup_block_enabled: true
app_setup_block: |
  Access the web gui at http://SERVERIP:PORT
# init diagram
init_diagram: |
  "budge:latest": {
    docker-mods
    base {
      fix-attr +\nlegacy cont-init
    }
    docker-mods -> base
    legacy-services
    custom services
    init-services -> legacy-services
    init-services -> custom services
    custom services -> legacy-services
    legacy-services -> ci-service-check
    init-migrations -> init-adduser
    init-nginx-end -> init-budge-config
    init-nginx-end -> init-config
    init-os-end -> init-config
    init-budge-config -> init-config-end
    init-config -> init-config-end
    init-os-end -> init-crontab-config
    init-mods-end -> init-custom-files
    base -> init-envfile
    init-os-end -> init-folders
    init-php -> init-keygen
    base -> init-migrations
    base -> init-mods
    init-config-end -> init-mods
    init-version-checks -> init-mods
    init-mods -> init-mods-end
    init-mods-package-install -> init-mods-end
    init-mods -> init-mods-package-install
    init-samples -> init-nginx
    init-permissions -> init-nginx-end
    base -> init-os-end
    init-adduser -> init-os-end
    init-envfile -> init-os-end
    init-migrations -> init-os-end
    init-keygen -> init-permissions
    init-nginx -> init-php
    init-folders -> init-samples
    init-custom-files -> init-services
    init-mods-end -> init-services
    init-config-end -> init-version-checks
    init-services -> svc-budge
    svc-budge -> legacy-services
    init-services -> svc-cron
    svc-cron -> legacy-services
    init-services -> svc-nginx
    svc-nginx -> legacy-services
    init-services -> svc-php-fpm
    svc-php-fpm -> legacy-services
  }
  Base Images: {
    "baseimage-alpine-nginx:3.20" <- "baseimage-alpine:3.20"
  }
  "budge:latest" <- Base Images
# changelog
changelogs:
  - {date: "06.06.24:", desc: "Rebase to Alpine 3.20. Existing users should update their nginx confs to avoid http2 deprecation warnings."}
  - {date: "06.03.24:", desc: "Existing users should update: site-confs/default.conf - Cleanup default site conf."}
  - {date: "06.03.24:", desc: "Rebase to Alpine 3.19 with php 8.3."}
  - {date: "25.05.23:", desc: "Rebase to Alpine 3.18, deprecate armhf."}
  - {date: "13.04.23:", desc: "Move ssl.conf include to default.conf."}
  - {date: "29.11.22:", desc: "Rebase to Alpine 3.17, migrate to s6v3."}
  - {date: "04.15.22:", desc: "Added NPM command to run db migrations."}
  - {date: "02.05.22:", desc: "Initial Release."}