Alpine helpers

Source: lib/alpine.func.

Alpine has no apt, dpkg or systemd, so most of the regular library cannot run there. lib/alpine.func reimplements a small subset under the same names, using apk. It is not part of lib/API.txt.

When it is loadedCopy Anchor Link

This split matters:

• In an install script only the functions on this page exist. There is no setup_deb822_repo, curl_with_retry, curl_download, create_backup, setup_nodejs and so on. Install packages with apk add.
• In update_script the full library is available, and the functions that share a name with this page are the regular ones documented under forge and system. That is why ct/alpine-wakapi.sh can call create_backup and restore_backup. Helpers that need apt or systemd still do not work on Alpine; ensure_dependencies and is_package_installed do, they use apk there.

If msg_info, msg_ok, msg_warn or msg_error are not defined when the file is loaded, it defines plain echo versions of them.

A CI workflow in core (alpine-parity.yml) warns on a pull request that changes a function in the regular library which lib/alpine.func also defines, without touching lib/alpine.func.

Releases from GitHubCopy Anchor Link

fetch_and_deploy_gh_releaseCopy Anchor Link

Download a GitHub release and put it in place, then write ~/.<app>.

fetch_and_deploy_gh_release <app> <owner/repo> [mode] [version] [target] [asset_pattern]

Returns 0 on success and 1 for every failure. It installs curl, jq and tar if missing and calls ensure_usr_local_bin_persist at the end.

What differs from the regular function:

• GitHub only; there is no GitLab or Codeberg variant.
• No seventh argument (tag prefix), no pre-release support, no var_appversion.
• It always downloads and deploys. There is no "already installed" shortcut and no .pending marker.
• If the release has no matching asset it fails; older releases are not searched.
• The asset pattern is turned into a regular expression and matched against the whole download URL, and the first match wins.
• No .deb handling and no 7z archives.
• Every failure returns 1 instead of a specific code.

From install/alpine-wakapi-install.sh:

fetch_and_deploy_gh_release "wakapi" "muety/wakapi" "prebuild" "latest" "/opt/wakapi" "wakapi_linux_$(arch_resolve).zip"

fetch_and_deploy_ghCopy Anchor Link

Alias that passes all arguments to fetch_and_deploy_gh_release. No script in ProxmoxVE uses it.

check_for_gh_releaseCopy Anchor Link

Compare the release GitHub marks as latest with ~/.<app>.

check_for_gh_release <app> <owner/repo> [pinned_version]

With a pin: returns 1 when the pin equals the upstream latest or the installed version, otherwise 0 with CHECK_UPDATE_RELEASE set to the pin.

Differences from the regular function: three arguments only (no pin reason, no tag prefix), no pre-releases, a stripped instead of a raw tag in CHECK_UPDATE_RELEASE, and errors are not distinguishable from "no update".

Because update_script runs with the regular library, the Alpine ct scripts reach the regular check_for_gh_release. This version is only in effect while an install script runs; no install script in ProxmoxVE calls it.

get_latest_github_releaseCopy Anchor Link

Print the tag of the latest GitHub release.

get_latest_github_release <owner/repo> [strip_v]

strip_v defaults to true. Returns 0, 22 when the API call failed, 250 when no version could be read. Used by setup_uv.

github_api_callCopy Anchor Link

GET a GitHub API URL with up to three attempts.

github_api_call <url> [output_file]

output_file defaults to /dev/stdout; GITHUB_TOKEN is sent when set. Returns 0 on HTTP 200, otherwise 22. A 401 or 404 fails at once; a 403 and other errors are retried after 2 s and 4 s. Unlike the regular function it never asks for a token and has no fallback to github.com.

extract_version_from_jsonCopy Anchor Link

Print one field of a JSON document.

extract_version_from_json <json> [field] [strip_v]

field defaults to tag_name, strip_v to true. Returns 250 when the field is empty or jq could not be installed.

Packages and downloadsCopy Anchor Link

need_toolCopy Anchor Link

Install commands with apk when at least one of them is missing.

need_tool <name> [name ...]

Each name is checked as a command. If any is missing, all names are passed to apk add --no-cache, so a name has to be both the command and the package name. Returns 0 on success, 1 when apk add failed.

ensure_dependenciesCopy Anchor Link

Same as need_tool; it exists so code written for the regular library works.

ensure_dependencies <name> [name ...]

download_fileCopy Anchor Link

Download a URL to a file with retries.

download_file <url> <output> [max_retries] [show_progress]

max_retries defaults to 3 (2 s apart), show_progress to false. Returns 0 on success, 250 after the last failed attempt, as in the regular library.

download_with_progressCopy Anchor Link

Download a URL to a file, with a pv progress bar when the size is known.

download_with_progress <url> <output>

Installs curl and pv if needed. Returns 0 on success, 1 on failure (the regular function returns 7).

net_resolvesCopy Anchor Link

Test whether a host name is reachable or resolvable, using ping and nslookup.

net_resolves <host>

Returns 0 when either succeeds.

has, lowerCopy Anchor Link

Two small utilities used throughout the file.

has <command>     # returns 0 when the command exists
lower <string>    # prints the string in lower case

System informationCopy Anchor Link

get_os_info, get_os_version_major, is_alpineCopy Anchor Link

Read /etc/os-release.

get_os_info [id|codename|version|version_id|version_full|all]
get_os_version_major
is_alpine

get_os_info prints the same fields as the regular function, all by default. get_os_version_major prints the version up to the first dot. is_alpine returns 0 when the id is alpine.

get_system_archCopy Anchor Link

Print amd64 or arm64 from uname -m (other values are printed unchanged).

get_system_arch [mode]

The argument is accepted for compatibility and ignored: Alpine has no dpkg.

version_gtCopy Anchor Link

Test whether the first version is greater than the second.

version_gt <a> <b>

Compares dot-separated parts numerically with awk. Returns 0 when a is greater, 1 when equal or smaller.

cache_installed_version, get_cached_versionCopy Anchor Link

Store and read a version in /var/cache/app-versions/<name>_version.txt.

cache_installed_version <name> <version>
get_cached_version <name>

get_cached_version prints the value and returns 0, or returns 1 when nothing is stored.

create_temp_dirCopy Anchor Link

Create a temporary directory, print its path and register it for removal on exit.

create_temp_dir

The first call sets an EXIT trap in the shell that runs the function. Captured with $(create_temp_dir) that shell is the command substitution, as described for the regular function.

ensure_usr_local_bin_persistCopy Anchor Link

Make sure /usr/local/bin is in PATH for later logins.

ensure_usr_local_bin_persist

Writes /etc/profile.d/10-localbin.sh and appends an export line to /root/.profile and /root/.bashrc when those files exist and lack one.

RuntimesCopy Anchor Link

These share their names with helpers in runtimes but are separate, smaller implementations. All return 0 on success and 1 on failure. No install script in ProxmoxVE calls them at the moment.

setup_yqCopy Anchor Link

Install or update yq.

setup_yq

If the yq package is already installed through apk (and FORCE_GH is not 1) it is upgraded with apk. Otherwise the latest mikefarah/yq binary for amd64 or arm64 is installed as /usr/local/bin/yq.

setup_adminerCopy Anchor Link

Download the latest adminer.php to /var/www/localhost/htdocs/adminer/index.php.

setup_adminer

No web server is installed or configured.

setup_uvCopy Anchor Link

Install or update uv (musl build) as /usr/local/bin/uv.

setup_uv

Does nothing when the requested version is already installed.

setup_javaCopy Anchor Link

Install OpenJDK from the Alpine repositories.

setup_java

Writes /etc/profile.d/20-java.sh, which sets JAVA_HOME and adds it to PATH.

setup_goCopy Anchor Link

Install Go.

setup_go

With a tarball install, go and gofmt are linked into /usr/local/bin.

setup_composerCopy Anchor Link

Install or update Composer as /usr/local/bin/composer.

setup_composer

If no php command exists it installs php83-cli, php83-openssl, php83-phar and php83-iconv, falling back to the unversioned php-* packages.

Internal functionsCopy Anchor Link