Maybe Finance¶
| Description / name | Input element |
|---|---|
| Your domain name |
Overview¶
Maybe Finance is a personal finance app that functions as an operating system for managing finances, with interactive tools and calculators. The open-source version is available under AGPLv3 license but is no longer actively maintained.
Deployment¶
sb install sandbox-maybe-finance
Usage¶
Visit https://maybe-finance.iYOUR_DOMAIN_NAMEi.
Role Defaults¶
Use the Inventory to customize variables. (1)
-
Example override
maybe_finance_name: "custom_value"Avoid overriding variables ending in
_defaultWhen overriding variables that end in
_default(likemaybe_finance_docker_envs_default), you replace the entire default configuration. Future updates that add new default values will not be applied to your setup, potentially breaking functionality.Instead, use the corresponding
_customvariable (likemaybe_finance_docker_envs_custom) to add your changes. Custom values are merged with defaults, ensuring you receive updates.
maybe_finance_name
# Type: string
maybe_finance_name: maybe-finance
maybe_finance_role_postgres_deploy
# Type: bool (true/false)
maybe_finance_role_postgres_deploy: true
maybe_finance_role_postgres_name
# Type: string
maybe_finance_role_postgres_name: "{{ maybe_finance_name }}-postgres"
maybe_finance_role_postgres_user
# Type: string
maybe_finance_role_postgres_user: "{{ postgres_role_docker_env_user }}"
maybe_finance_role_postgres_password
# Type: string
maybe_finance_role_postgres_password: "{{ postgres_role_docker_env_password }}"
maybe_finance_role_postgres_docker_env_db
# Type: string
maybe_finance_role_postgres_docker_env_db: "{{ maybe_finance_name }}"
maybe_finance_role_postgres_docker_image_tag
# Type: string
maybe_finance_role_postgres_docker_image_tag: "16"
maybe_finance_role_postgres_docker_image_repo
# Type: string
maybe_finance_role_postgres_docker_image_repo: "postgres"
maybe_finance_role_postgres_docker_healthcheck
# Type: dict
maybe_finance_role_postgres_docker_healthcheck:
test: ["CMD-SHELL", "pg_isready -d {{ lookup('role_var', '_postgres_docker_env_db', role='maybe_finance') }} -U {{ postgres_role_docker_env_user }}"]
start_period: 20s
interval: 30s
retries: 5
timeout: 5s
maybe_finance_role_postgres_paths_folder
# Type: string
maybe_finance_role_postgres_paths_folder: "{{ maybe_finance_name }}"
maybe_finance_role_postgres_paths_location
# Type: string
maybe_finance_role_postgres_paths_location: "{{ server_appdata_path }}/{{ maybe_finance_role_postgres_paths_folder }}/postgres"
maybe_finance_role_web_subdomain
# Type: string
maybe_finance_role_web_subdomain: "{{ maybe_finance_name }}"
maybe_finance_role_web_domain
# Type: string
maybe_finance_role_web_domain: "{{ user.domain }}"
maybe_finance_role_web_port
# Type: string
maybe_finance_role_web_port: "3000"
maybe_finance_role_web_url
# Type: string
maybe_finance_role_web_url: "{{ 'https://' + (lookup('role_var', '_web_subdomain', role='maybe_finance') + '.' + lookup('role_var', '_web_domain', role='maybe_finance')
if (lookup('role_var', '_web_subdomain', role='maybe_finance') | length > 0)
else lookup('role_var', '_web_domain', role='maybe_finance')) }}"
maybe_finance_role_dns_record
# Type: string
maybe_finance_role_dns_record: "{{ lookup('role_var', '_web_subdomain', role='maybe_finance') }}"
maybe_finance_role_dns_zone
# Type: string
maybe_finance_role_dns_zone: "{{ lookup('role_var', '_web_domain', role='maybe_finance') }}"
maybe_finance_role_dns_proxy
# Type: bool (true/false)
maybe_finance_role_dns_proxy: "{{ dns_proxied }}"
maybe_finance_role_traefik_sso_middleware
# Type: string
maybe_finance_role_traefik_sso_middleware: "{{ traefik_default_sso_middleware }}"
maybe_finance_role_traefik_middleware_default
# Type: string
maybe_finance_role_traefik_middleware_default: "{{ traefik_default_middleware }}"
maybe_finance_role_traefik_middleware_custom
# Type: string
maybe_finance_role_traefik_middleware_custom: ""
maybe_finance_role_traefik_certresolver
# Type: string
maybe_finance_role_traefik_certresolver: "{{ traefik_default_certresolver }}"
maybe_finance_role_traefik_enabled
# Type: bool (true/false)
maybe_finance_role_traefik_enabled: true
maybe_finance_role_traefik_api_enabled
# Type: bool (true/false)
maybe_finance_role_traefik_api_enabled: false
maybe_finance_role_traefik_api_endpoint
# Type: string
maybe_finance_role_traefik_api_endpoint: ""
Container
maybe_finance_role_docker_container
# Type: string
maybe_finance_role_docker_container: "{{ maybe_finance_name }}"
Image
maybe_finance_role_docker_image_pull
# Type: bool (true/false)
maybe_finance_role_docker_image_pull: true
maybe_finance_role_docker_image_tag
# Type: string
maybe_finance_role_docker_image_tag: "latest"
maybe_finance_role_docker_image_repo
# Type: string
maybe_finance_role_docker_image_repo: "ghcr.io/maybe-finance/maybe"
maybe_finance_role_docker_image
# Type: string
maybe_finance_role_docker_image: "{{ lookup('role_var', '_docker_image_repo', role='maybe_finance') }}:{{ lookup('role_var', '_docker_image_tag', role='maybe_finance') }}"
Envs
maybe_finance_role_docker_envs_default
# Type: dict
maybe_finance_role_docker_envs_default:
TZ: "{{ tz }}"
PUID: "{{ uid }}"
PGID: "{{ gid }}"
SELF_HOSTED: "true"
RAILS_FORCE_SSL: "false"
RAILS_ASSUME_SSL: "false"
GOOD_JOB_EXECUTION_MODE: "async"
SECRET_KEY_BASE: "{{ maybe_finance_saltbox_facts.facts.secret_key_base }}"
DB_USERNAME: "{{ lookup('role_var', '_postgres_user', role='maybe_finance') }}"
DB_PASSWORD: "{{ lookup('role_var', '_postgres_password', role='maybe_finance') }}"
DB_HOST: "{{ lookup('role_var', '_postgres_name', role='maybe_finance') }}"
DB_PORT: "5432"
REDIS_URL: "redis://{{ maybe_finance_name }}-redis:6379/1"
POSTGRES_USER: "{{ lookup('role_var', '_postgres_user', role='maybe_finance') }}"
POSTGRES_PASSWORD: "{{ lookup('role_var', '_postgres_password', role='maybe_finance') }}"
maybe_finance_role_docker_envs_custom
# Type: dict
maybe_finance_role_docker_envs_custom: {}
Volumes
maybe_finance_role_docker_volumes_default
# Type: list
maybe_finance_role_docker_volumes_default:
- "{{ lookup('role_var', '_paths_location', role='maybe_finance') }}:/rails/storage"
maybe_finance_role_docker_volumes_custom
# Type: list
maybe_finance_role_docker_volumes_custom: []
Hostname
maybe_finance_role_docker_hostname
# Type: string
maybe_finance_role_docker_hostname: "{{ maybe_finance_name }}"
Networks
maybe_finance_role_docker_networks_alias
# Type: string
maybe_finance_role_docker_networks_alias: "{{ maybe_finance_name }}"
maybe_finance_role_docker_networks_default
# Type: list
maybe_finance_role_docker_networks_default: []
maybe_finance_role_docker_networks_custom
# Type: list
maybe_finance_role_docker_networks_custom: []
Restart Policy
maybe_finance_role_docker_restart_policy
# Type: string
maybe_finance_role_docker_restart_policy: unless-stopped
State
maybe_finance_role_docker_state
# Type: string
maybe_finance_role_docker_state: started
Dependencies
maybe_finance_role_depends_on
# Type: string
maybe_finance_role_depends_on: "{{ lookup('role_var', '_postgres_name', role='maybe_finance') }}"
maybe_finance_role_depends_on_delay
# Type: string (quoted number)
maybe_finance_role_depends_on_delay: "5"
maybe_finance_role_depends_on_healthchecks
# Type: string ("true"/"false")
maybe_finance_role_depends_on_healthchecks: "true"
The following advanced options are available via create_docker_container but are not defined in the role. See: docker_container module
Resource Limits
maybe_finance_role_docker_blkio_weight
# Type: int
maybe_finance_role_docker_blkio_weight:
maybe_finance_role_docker_cpu_period
# Type: int
maybe_finance_role_docker_cpu_period:
maybe_finance_role_docker_cpu_quota
# Type: int
maybe_finance_role_docker_cpu_quota:
maybe_finance_role_docker_cpu_shares
# Type: int
maybe_finance_role_docker_cpu_shares:
maybe_finance_role_docker_cpus
# Type: string
maybe_finance_role_docker_cpus:
maybe_finance_role_docker_cpuset_cpus
# Type: string
maybe_finance_role_docker_cpuset_cpus:
maybe_finance_role_docker_cpuset_mems
# Type: string
maybe_finance_role_docker_cpuset_mems:
maybe_finance_role_docker_kernel_memory
# Type: string
maybe_finance_role_docker_kernel_memory:
maybe_finance_role_docker_memory
# Type: string
maybe_finance_role_docker_memory:
maybe_finance_role_docker_memory_reservation
# Type: string
maybe_finance_role_docker_memory_reservation:
maybe_finance_role_docker_memory_swap
# Type: string
maybe_finance_role_docker_memory_swap:
maybe_finance_role_docker_memory_swappiness
# Type: int
maybe_finance_role_docker_memory_swappiness:
maybe_finance_role_docker_shm_size
# Type: string
maybe_finance_role_docker_shm_size:
Security & Devices
maybe_finance_role_docker_cap_drop
# Type: list
maybe_finance_role_docker_cap_drop:
maybe_finance_role_docker_cgroupns_mode
# Type: string
maybe_finance_role_docker_cgroupns_mode:
maybe_finance_role_docker_device_cgroup_rules
# Type: list
maybe_finance_role_docker_device_cgroup_rules:
maybe_finance_role_docker_device_read_bps
# Type: list
maybe_finance_role_docker_device_read_bps:
maybe_finance_role_docker_device_read_iops
# Type: list
maybe_finance_role_docker_device_read_iops:
maybe_finance_role_docker_device_requests
# Type: list
maybe_finance_role_docker_device_requests:
maybe_finance_role_docker_device_write_bps
# Type: list
maybe_finance_role_docker_device_write_bps:
maybe_finance_role_docker_device_write_iops
# Type: list
maybe_finance_role_docker_device_write_iops:
maybe_finance_role_docker_devices
# Type: list
maybe_finance_role_docker_devices:
maybe_finance_role_docker_devices_default
# Type: string
maybe_finance_role_docker_devices_default:
maybe_finance_role_docker_groups
# Type: list
maybe_finance_role_docker_groups:
maybe_finance_role_docker_privileged
# Type: bool (true/false)
maybe_finance_role_docker_privileged:
maybe_finance_role_docker_security_opts
# Type: list
maybe_finance_role_docker_security_opts:
maybe_finance_role_docker_user
# Type: string
maybe_finance_role_docker_user:
maybe_finance_role_docker_userns_mode
# Type: string
maybe_finance_role_docker_userns_mode:
Networking
maybe_finance_role_docker_dns_opts
# Type: list
maybe_finance_role_docker_dns_opts:
maybe_finance_role_docker_dns_search_domains
# Type: list
maybe_finance_role_docker_dns_search_domains:
maybe_finance_role_docker_dns_servers
# Type: list
maybe_finance_role_docker_dns_servers:
maybe_finance_role_docker_domainname
# Type: string
maybe_finance_role_docker_domainname:
maybe_finance_role_docker_exposed_ports
# Type: list
maybe_finance_role_docker_exposed_ports:
maybe_finance_role_docker_hosts
# Type: dict
maybe_finance_role_docker_hosts:
maybe_finance_role_docker_hosts_use_common
# Type: bool (true/false)
maybe_finance_role_docker_hosts_use_common:
maybe_finance_role_docker_ipc_mode
# Type: string
maybe_finance_role_docker_ipc_mode:
maybe_finance_role_docker_links
# Type: list
maybe_finance_role_docker_links:
maybe_finance_role_docker_network_mode
# Type: string
maybe_finance_role_docker_network_mode:
maybe_finance_role_docker_pid_mode
# Type: string
maybe_finance_role_docker_pid_mode:
maybe_finance_role_docker_ports
# Type: list
maybe_finance_role_docker_ports:
maybe_finance_role_docker_uts
# Type: string
maybe_finance_role_docker_uts:
Storage
maybe_finance_role_docker_keep_volumes
# Type: bool (true/false)
maybe_finance_role_docker_keep_volumes:
maybe_finance_role_docker_mounts
# Type: list
maybe_finance_role_docker_mounts:
maybe_finance_role_docker_storage_opts
# Type: dict
maybe_finance_role_docker_storage_opts:
maybe_finance_role_docker_tmpfs
# Type: list
maybe_finance_role_docker_tmpfs:
maybe_finance_role_docker_volume_driver
# Type: string
maybe_finance_role_docker_volume_driver:
maybe_finance_role_docker_volumes_from
# Type: list
maybe_finance_role_docker_volumes_from:
maybe_finance_role_docker_volumes_global
# Type: bool (true/false)
maybe_finance_role_docker_volumes_global:
maybe_finance_role_docker_working_dir
# Type: string
maybe_finance_role_docker_working_dir:
Monitoring & Lifecycle
maybe_finance_role_docker_auto_remove
# Type: bool (true/false)
maybe_finance_role_docker_auto_remove:
maybe_finance_role_docker_cleanup
# Type: bool (true/false)
maybe_finance_role_docker_cleanup:
maybe_finance_role_docker_force_kill
# Type: string
maybe_finance_role_docker_force_kill:
maybe_finance_role_docker_healthcheck
# Type: dict
maybe_finance_role_docker_healthcheck:
maybe_finance_role_docker_healthy_wait_timeout
# Type: int
maybe_finance_role_docker_healthy_wait_timeout:
maybe_finance_role_docker_init
# Type: bool (true/false)
maybe_finance_role_docker_init:
maybe_finance_role_docker_kill_signal
# Type: string
maybe_finance_role_docker_kill_signal:
maybe_finance_role_docker_log_driver
# Type: string
maybe_finance_role_docker_log_driver:
maybe_finance_role_docker_log_options
# Type: dict
maybe_finance_role_docker_log_options:
maybe_finance_role_docker_oom_killer
# Type: bool (true/false)
maybe_finance_role_docker_oom_killer:
maybe_finance_role_docker_oom_score_adj
# Type: int
maybe_finance_role_docker_oom_score_adj:
maybe_finance_role_docker_output_logs
# Type: bool (true/false)
maybe_finance_role_docker_output_logs:
maybe_finance_role_docker_paused
# Type: bool (true/false)
maybe_finance_role_docker_paused:
maybe_finance_role_docker_recreate
# Type: bool (true/false)
maybe_finance_role_docker_recreate:
maybe_finance_role_docker_restart_retries
# Type: int
maybe_finance_role_docker_restart_retries:
maybe_finance_role_docker_stop_timeout
# Type: int
maybe_finance_role_docker_stop_timeout:
Other Options
maybe_finance_role_docker_capabilities
# Type: list
maybe_finance_role_docker_capabilities:
maybe_finance_role_docker_cgroup_parent
# Type: string
maybe_finance_role_docker_cgroup_parent:
maybe_finance_role_docker_commands
# Type: list
maybe_finance_role_docker_commands:
maybe_finance_role_docker_create_timeout
# Type: int
maybe_finance_role_docker_create_timeout:
maybe_finance_role_docker_entrypoint
# Type: string
maybe_finance_role_docker_entrypoint:
maybe_finance_role_docker_env_file
# Type: string
maybe_finance_role_docker_env_file:
maybe_finance_role_docker_labels
# Type: dict
maybe_finance_role_docker_labels:
maybe_finance_role_docker_labels_use_common
# Type: bool (true/false)
maybe_finance_role_docker_labels_use_common:
maybe_finance_role_docker_read_only
# Type: bool (true/false)
maybe_finance_role_docker_read_only:
maybe_finance_role_docker_runtime
# Type: string
maybe_finance_role_docker_runtime:
maybe_finance_role_docker_sysctls
# Type: list
maybe_finance_role_docker_sysctls:
maybe_finance_role_docker_ulimits
# Type: list
maybe_finance_role_docker_ulimits:
maybe_finance_role_autoheal_enabled
# Enable or disable Autoheal monitoring for the container created when deploying
# Type: bool (true/false)
maybe_finance_role_autoheal_enabled: true
maybe_finance_role_depends_on
# List of container dependencies that must be running before the container start
# Type: string
maybe_finance_role_depends_on: ""
maybe_finance_role_depends_on_delay
# Delay in seconds before starting the container after dependencies are ready
# Type: string (quoted number)
maybe_finance_role_depends_on_delay: "0"
maybe_finance_role_depends_on_healthchecks
# Enable healthcheck waiting for container dependencies
# Type: string ("true"/"false")
maybe_finance_role_depends_on_healthchecks:
maybe_finance_role_diun_enabled
# Enable or disable Diun update notifications for the container created when deploying
# Type: bool (true/false)
maybe_finance_role_diun_enabled: true
maybe_finance_role_dns_enabled
# Enable or disable automatic DNS record creation for the container
# Type: bool (true/false)
maybe_finance_role_dns_enabled: true
maybe_finance_role_docker_controller
# Enable or disable Saltbox Docker Controller management for the container
# Type: bool (true/false)
maybe_finance_role_docker_controller: true
maybe_finance_role_docker_image_repo
# Type: string
maybe_finance_role_docker_image_repo:
maybe_finance_role_docker_image_tag
# Type: string
maybe_finance_role_docker_image_tag:
maybe_finance_role_docker_volumes_download
# Type: bool (true/false)
maybe_finance_role_docker_volumes_download:
maybe_finance_role_paths_location
# Type: string
maybe_finance_role_paths_location:
maybe_finance_role_postgres_docker_env_db
# Type: string
maybe_finance_role_postgres_docker_env_db:
maybe_finance_role_postgres_name
# Type: string
maybe_finance_role_postgres_name:
maybe_finance_role_postgres_password
# Type: string
maybe_finance_role_postgres_password:
maybe_finance_role_postgres_user
# Type: string
maybe_finance_role_postgres_user:
maybe_finance_role_themepark_addons
# Type: string
maybe_finance_role_themepark_addons:
maybe_finance_role_themepark_app
# Type: string
maybe_finance_role_themepark_app:
maybe_finance_role_themepark_theme
# Type: string
maybe_finance_role_themepark_theme:
maybe_finance_role_traefik_api_endpoint
# Type: dict/omit
maybe_finance_role_traefik_api_endpoint:
maybe_finance_role_traefik_api_middleware
# Type: string
maybe_finance_role_traefik_api_middleware:
maybe_finance_role_traefik_api_middleware_http
# Type: string
maybe_finance_role_traefik_api_middleware_http:
maybe_finance_role_traefik_autodetect_enabled
# Enable Traefik autodetect middleware for the container
# Type: bool (true/false)
maybe_finance_role_traefik_autodetect_enabled: false
maybe_finance_role_traefik_certresolver
# Type: string
maybe_finance_role_traefik_certresolver:
maybe_finance_role_traefik_crowdsec_enabled
# Enable CrowdSec middleware for the container
# Type: bool (true/false)
maybe_finance_role_traefik_crowdsec_enabled: false
maybe_finance_role_traefik_error_pages_enabled
# Enable custom error pages middleware for the container
# Type: bool (true/false)
maybe_finance_role_traefik_error_pages_enabled: false
maybe_finance_role_traefik_gzip_enabled
# Enable gzip compression middleware for the container
# Type: bool (true/false)
maybe_finance_role_traefik_gzip_enabled: false
maybe_finance_role_traefik_middleware_http
# Type: string
maybe_finance_role_traefik_middleware_http:
maybe_finance_role_traefik_middleware_http_api_insecure
# Type: bool (true/false)
maybe_finance_role_traefik_middleware_http_api_insecure:
maybe_finance_role_traefik_middleware_http_insecure
# Type: bool (true/false)
maybe_finance_role_traefik_middleware_http_insecure:
maybe_finance_role_traefik_priority
# Type: string
maybe_finance_role_traefik_priority:
maybe_finance_role_traefik_robot_enabled
# Enable robots.txt middleware for the container
# Type: bool (true/false)
maybe_finance_role_traefik_robot_enabled: true
maybe_finance_role_traefik_tailscale_enabled
# Enable Tailscale-specific Traefik configuration for the container
# Type: bool (true/false)
maybe_finance_role_traefik_tailscale_enabled: false
maybe_finance_role_traefik_wildcard_enabled
# Enable wildcard certificate for the container
# Type: bool (true/false)
maybe_finance_role_traefik_wildcard_enabled: true
maybe_finance_role_web_domain
# Type: string
maybe_finance_role_web_domain:
maybe_finance_role_web_fqdn_override
# Override the Traefik fully qualified domain name (FQDN) for the container
# Type: list
maybe_finance_role_web_fqdn_override:
Example Override
maybe_finance_role_web_fqdn_override:
- "{{ traefik_host }}"
- "maybe_finance2.{{ user.domain }}"
- "maybe_finance.otherdomain.tld"
Note: Include {{ traefik_host }} to preserve the default FQDN alongside your custom entries
maybe_finance_role_web_host_override
# Override the Traefik web host configuration for the container
# Type: string
maybe_finance_role_web_host_override:
Example Override
maybe_finance_role_web_host_override: "Host(`{{ traefik_host }}`) || Host(`{{ 'maybe_finance2.' + user.domain }}`)"
Note: Use {{ traefik_host }} to include the default host configuration in your custom rule
maybe_finance_role_web_http_port
# Type: string (quoted number)
maybe_finance_role_web_http_port:
maybe_finance_role_web_http_scheme
# Type: string ("http"/"https")
maybe_finance_role_web_http_scheme:
maybe_finance_role_web_http_serverstransport
# Type: dict/omit
maybe_finance_role_web_http_serverstransport:
maybe_finance_role_web_scheme
# URL scheme to use for web access to the container
# Type: string ("http"/"https")
maybe_finance_role_web_scheme:
maybe_finance_role_web_serverstransport
# Type: dict/omit
maybe_finance_role_web_serverstransport:
maybe_finance_role_web_subdomain
# Type: string
maybe_finance_role_web_subdomain: