Files
Helper-Scripts-ProxmoxVE/docs/misc/install.func/INSTALL_FUNC_USAGE_EXAMPLES.md
CanbiZ 1294b89fcb
Create Changelog Pull Request / update-changelog-pull-request (push) Has been cancelled
Close Discussion on PR Merge / close-discussion (push) Has been cancelled
Frontend CI/CD / test-json-files (push) Has been cancelled
Frontend CI/CD / build (push) Has been cancelled
Frontend CI/CD / deploy (push) Has been cancelled
Sync to Gitea / sync (push) Has been cancelled
add comprehensive documentation (#9537)
2025-12-01 13:50:11 +01:00

1.3 KiB

install.func Usage Examples

Practical examples for using install.func functions in application installation scripts.

Basic Examples

Example 1: Minimal Setup

#!/usr/bin/env bash
source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"

setting_up_container
network_check
update_os

# ... application installation ...

motd_ssh
customize
cleanup_lxc

Example 2: With Error Handling

#!/usr/bin/env bash
source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"

catch_errors
setting_up_container

if ! network_check; then
  msg_error "Network failed"
  exit 1
fi

if ! update_os; then
  msg_error "OS update failed"
  exit 1
fi

# ... continue ...

Production Examples

Example 3: Full Application Installation

#!/usr/bin/env bash
source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"

catch_errors
setting_up_container
network_check
update_os

msg_info "Installing application"
# ... install steps ...
msg_ok "Application installed"

motd_ssh
customize
cleanup_lxc

Example 4: With IPv6 Support

#!/usr/bin/env bash
source /dev/stdin <<<"$FUNCTIONS_FILE_PATH"

catch_errors
setting_up_container
verb_ip6
network_check
update_os

# ... application installation ...

motd_ssh
customize
cleanup_lxc

Last Updated: December 2025 Examples: Basic and production patterns All examples production-ready