Postgres (Storage/Database)

or

Purpose & Current State

Purpose: This document provides context and technical details for the postgres component (part of _storage) within the LibScript ecosystem. LibScript is a modular, zero-dependency shell-script framework designed for cross-platform software provisioning across Linux, macOS, DOS, and Windows.

Current State: LibScript functions as a comprehensive global and per-component package manager, featuring a robust core CLI (libscript.sh, libscript.cmd, libscript.bat). It includes multi-platform toolchain support (Rust, Python, Node, Go, Java, C/C++), servers (Postgres 18, Nginx, Valkey), and advanced environment querying (env subcommand). It natively supports generating deployment configurations (package_as docker, package_as docker_compose, package_as msi, package_as innosetup, package_as nsis, package_as TUI) with deep installer customization, automated parallel dependency downloading and resolution via libscript.json, and robust uninstall lifecycle hooks (uninstall.sh/uninstall.cmd) for cleanly removing binaries, configs, and services. It natively handles deep semantic versioning, global --secrets extraction, caching, OpenBao/Vault generation, local caching via SQLite (db-search, update-db), explicit error handling for unsupported actions, and background process serving. Recent advancements have stabilized major Windows installer generation (MSI, InnoSetup, NSIS) and expanded macOS native service provisioning.

Overview

This directory contains the installation and configuration scripts for postgres. It is designed to be executed via the global libscript.sh router or directly via cli.sh.

Installation

Unix (Linux/macOS):

./cli.sh <COMMAND> <PACKAGE_NAME> [VERSION] [OPTIONS]

Windows:

cli.cmd <COMMAND> <PACKAGE_NAME> [VERSION] [OPTIONS]

Configuration Options

The following environment variables can be passed to the CLI (--KEY=VALUE) or exported before running the setup script.

Architecture

• setup.sh: The main entrypoint that resolves the OS and invokes the correct script.
• setup_generic.sh: Fallback installation logic using the package manager mapper.
• test.sh / test.cmd: Verification scripts to ensure the component is installed and functioning correctly.
• vars.schema.json: The schema definition for the CLI arguments.

Local and image-creation usage

$ # Replace `$(pwd)` if not in the 'libscript' directory or a generated one.
$ export LIBSCRIPT_ROOT_DIR="$(pwd)"
$ # `export` any variables now (see below for variable docs). Then:
$ # Set script location:
$ export SCRIPT_NAME="${LIBSCRIPT_ROOT_DIR}"'/_lib/_storage/postgres/setup.sh'
$ . "${SCRIPT_NAME}"

> :: Replace `%cd%` if not in the 'libscript' directory or a generated one.
> SET "LIBSCRIPT_ROOT_DIR=%cd%"
> :: `SET` any variables now (see below for variable docs). Then:
> :: Set script location:
> SET SCRIPT_NAME="%LIBSCRIPT_ROOT_DIR%\_lib\_storage\postgres\setup.cmd"
> CALL "%SCRIPT_NAME%"

Objects

or

• postgres server vars (root object)

## postgres server vars

postgres vars that can be set

postgres server vars Properties

Additional properties are allowed.

postgres server vars.POSTGRESQL_VERSION

Version of PostgreSQL demanded

• Type: string
• Required: No

postgres server vars.POSTGRES_USER

Username to create inside postgres

• Type: string
• Required: No

postgres server vars.POSTGRES_PASSWORD

Password for created user inside postgres

• Type: string
• Required: No

postgres server vars.POSTGRES_PASSWORD_FILE

Password file, its contents used as password for created user inside postgres

• Type: string
• Required: No

postgres server vars.POSTGRES_SERVICE_USER

Username for superuser & system role

• Type: string
• Required: No

postgres server vars.POSTGRES_SERVICE_PASSWORD

Password for postgres user; fallsback to POSTGRES_PASSWORD

• Type: string
• Required: No

postgres server vars.POSTGRES_HOST

Hostname to serve postgres from

• Type: string
• Required: No

postgres server vars.POSTGRES_DB

Database to create within postgres

• Type: string
• Required: No

postgres server vars.LIBSCRIPT_GLOBAL_INSTALL_METHOD

Global override for how software should be installed across all systems (e.g. system package manager vs downloaded binaries/from-source).

• Type: string
• Required: No, default: "system"
• Allowed values:
  • "system"
  • "source"

postgres server vars.LIBSCRIPT_WINDOWS_PKG_MGR

Global package manager override for Windows targets (e.g. winget, choco).

• Type: string
• Required: No, default: "winget"
• Allowed values:
  • "winget"
  • "choco"

postgres server vars.LIBSCRIPT_LISTEN_PORT

Global port to listen on

• Type: ["string", "integer"]
• Required: No

postgres server vars.LIBSCRIPT_LISTEN_ADDRESS

Global address to listen on

• Type: string
• Required: No

postgres server vars.LIBSCRIPT_LISTEN_SOCKET

Global unix socket to listen on

• Type: string
• Required: No

postgres server vars.POSTGRES_LISTEN_PORT

Port for POSTGRES to listen on

• Type: ["string", "integer"]
• Required: No

postgres server vars.POSTGRES_LISTEN_ADDRESS

Address for POSTGRES to listen on

• Type: string
• Required: No

postgres server vars.POSTGRES_LISTEN_SOCKET

Unix socket for POSTGRES to listen on

• Type: string
• Required: No

postgres server vars.POSTGRES_DATA_DIR

Directory for PostgreSQL data cluster

• Type: string
• Required: No

postgres server vars.POSTGRES_LOCALE

Locale for PostgreSQL initdb (e.g. English, United States)

• Type: string
• Required: No

postgres server vars.POSTGRES_SERVICE_RUN_AS_USER

Windows local user account to run the service (leave empty for Network Service)

• Type: string
• Required: No

postgres server vars.POSTGRES_SERVICE_RUN_AS_PASSWORD

Password for the local user account (if applicable)

• Type: string
• Required: No

postgres server vars.POSTGRES_SERVICE_NAME

Custom name for the Windows Service (allows side-by-side installations)

• Type: string
• Required: No, default: "libscript_postgres"