English | [中文](README_cn.md)

IvorySQL-AutoInstall is a professional automated installation script designed to simplify the process of compiling and installing the IvorySQL database. With a simple configuration file, users can complete the entire workflow—from building from source to starting the service—with one command, without manually executing complex build commands and configuration steps.

- **Environment detection and validation**: Automatically detect the operating system type and version, and validate compatibility.

- **Intelligent dependency management**: Automatically install build-time dependencies, supporting multiple platform package managers.

- **Automated installation and configuration**: Automatically set permissions for the install directory, data directory, and log directory.

- **Service integration**: Automatically create a systemd service (or a helper when systemd is absent) and configure environment variables.

- **Comprehensive logging**: Record detailed installation steps to facilitate troubleshooting.

- **Error handling and rollback**: Robust error detection and handling mechanisms.

| Family | Distribution/ID | Version Gate in Script | Notes |

|---------------|------------------------------------------------------|---------------------------------------------------------|------------------------------|

| RHEL Family | rhel / centos / almalinux / rocky / oracle | Explicitly **blocks 7**; code paths cover 8/9/10 | Oracle Linux has specifics |

| Debian/Ubuntu | debian / ubuntu | Version validated; unsupported versions **fail fast** | Uses `apt` for dependencies |

| SUSE Family | opensuse-leap / sles | openSUSE Leap **15**; SLES **12.5 / 15** | Uses `zypper` |

| Arch | arch | Rolling release | Uses `pacman` |

| Key | Required | Default | Description |

|---------------|----------|---------|--------------------------------------------------------------|

| INSTALL_DIR | Yes | None | Install directory for IvorySQL (absolute path required) |

| DATA_DIR | Yes | None | Database data directory (absolute path required) |

| LOG_DIR | Yes | None | Log directory (absolute path required) |

| SERVICE_USER | Yes | None | Service user (must not be a reserved system account) |

| SERVICE_GROUP | Yes | None | Service group (must not be a reserved system group) |

**Notes**

- Paths must be absolute and contain no spaces.

- User/group names must not be reserved names (e.g., `root`, `bin`, `daemon`).

**Example**

INSTALL_DIR=/usr/ivorysql

DATA_DIR=/var/lib/ivorysql/data

LOG_DIR=/var/log/ivorysql

SERVICE_USER=ivorysql

SERVICE_GROUP=ivorysql

- Toolchain: GCC, Make, Flex, Bison

- Core libraries: readline, zlib, openssl

- Perl environment: perl-core, perl-devel, perl-IPC-Run

| Library | Probe Path(s) | Automatic Handling |

|----------|----------------------------------------------------------|--------------------------------------------------|

| ICU | `/usr/include/icu.h` or `/usr/include/unicode/utypes.h` | Add `--without-icu` if not detected |

| libxml2 | `/usr/include/libxml2/libxml/parser.h` | Add `--without-libxml` if not detected |

| Tcl | `/usr/include/tcl.h` | Add `--without-tcl` if not detected |

| Perl dev | headers present | Add `--without-perl` if not detected |

| OS | Commands |

|-----------------------------|--------------------------------------------------------------------------|

| CentOS/RHEL/Rocky/AlmaLinux/Oracle| `dnf group install "Development Tools"` <br> `dnf install readline-devel zlib-devel openssl-devel` |

| Debian/Ubuntu | `apt-get install build-essential libreadline-dev zlib1g-dev libssl-dev` |

| SUSE/SLES | `zypper install gcc make flex bison readline-devel zlib-devel libopenssl-devel` |

| Arch Linux | `pacman -S base-devel readline zlib openssl` |

**Toolchain verification**

for cmd in gcc make flex bison; do

command -v "$cmd" >/dev/null || echo "Warning: $cmd is not installed"

./configure --prefix="$INSTALL_DIR" --with-openssl --with-readline --without-icu \ # when ICU is not detected

--without-libxml \ # when libxml2 is not detected

--without-tcl \ # when Tcl is not detected

--without-perl # when Perl dev env is not detected

make -j"$(nproc)"

make install

- Ensure `$DATA_DIR` exists, `chmod 700`, and correct ownership.

- Optionally append `$INSTALL_DIR/bin` to the service user's PATH.

unit generated by the script

Description=IvorySQL Database Server

Documentation=https://www.ivorysql.org

Requires=network.target local-fs.target

After=network.target local-fs.target

Type=forking

User=ivorysql

Group=ivorysql

Environment=PGDATA=/var/lib/ivorysql/data

Environment=LD_LIBRARY_PATH=/usr/ivorysql/lib:/usr/ivorysql/lib/postgresql

PIDFile=/var/lib/ivorysql/data/postmaster.pid

OOMScoreAdjust=-1000

ExecStart=/usr/ivorysql/bin/pg_ctl start -D ${PGDATA} -s -w -t 90

ExecStop=/usr/ivorysql/bin/pg_ctl stop -D ${PGDATA} -s -m fast

ExecReload=/usr/ivorysql/bin/pg_ctl reload -D ${PGDATA}

TimeoutSec=120

Restart=on-failure

RestartSec=5s

WantedBy=multi-user.target

**Notes**

- `PIDFile` is present in the generated unit.

- `ExecStart` uses `-t 90` and `TimeoutSec` is **120** to match the script.

- `OOMScoreAdjust=-1000` and `Type=forking` are configured.

- Helper script: `"$INSTALL_DIR/ivorysql-ctl"` (created by the script)

- `start` → `pg_ctl start -D "$DATA_DIR" -s -w -t 90`

- `stop` → `pg_ctl stop -D "$DATA_DIR" -s -m fast`

- `reload`→ `pg_ctl reload -D "$DATA_DIR"`

- **Note**: The script also has an internal fallback `svc_start` path that uses `-t 60` when not leveraging the helper; the helper defaults to **90 seconds**.

- Ownership: `ivorysql:ivorysql`

- Timestamped, step-tagged installer logs

- PostgreSQL built-in runtime logging

**Runtime logging (PostgreSQL server)**:

- On systemd-based distros, PostgreSQL **defaults to journald**. View logs via:

```bash

journalctl -u ivorysql -f

```

- To write logs to files, enable in `postgresql.conf`:

```conf

```

Then review `$DATA_DIR/log/` (you may symlink this path into `LOG_DIR` if desired).

0. **Placement** (important):

- This script **must reside inside the IvorySQL source repository**, typically at:

```

```

2. Enter the directory and add execute permission:

```bash

cd IvorySQL/IvorySQL-AutoInstaller

```

Add execute permission:

```bash

chmod +x AutoInstall.sh

```

1. Edit the configuration file:

```bash

nano ivorysql.conf

```

2. Reference (absolute paths only; `LOG_DIR` is required):

```ini

INSTALL_DIR=/usr/ivorysql

DATA_DIR=/var/lib/ivorysql/data

SERVICE_USER=ivorysql

SERVICE_GROUP=ivorysql

LOG_DIR=/var/log/ivorysql

```

sudo bash AutoInstall.sh

| Action | Command | Notes |

|---|---|---|

| Start | `systemctl start ivorysql` | Start the database service |

| Stop | `systemctl stop ivorysql` | Stop the database service |

| Status| `systemctl status ivorysql`| Inspect service state |

| Logs | `journalctl -u ivorysql -f`| Follow service logs |

| Reload| `systemctl reload ivorysql`| Reload configurations |

| Connect | `sudo -u ivorysql /usr/ivorysql/bin/psql` | Connect to DB |

| Version | `/usr/ivorysql/bin/postgres --version` | Show version |

| Base Backup | `sudo -u ivorysql /usr/ivorysql/bin/pg_basebackup` | Create base backup |

| Symptom | Likely Cause | Resolution |

|---|---|---|

| Configuration missing | Wrong file path | Ensure `ivorysql.conf` exists in the project directory |

| Dependency install failed | Network or mirror issues | Check network; switch mirrors |

| Build error | Unsupported environment | Check OS/version; inspect error log |

| initdb failed | Ownership or permissions | `chown ivorysql:ivorysql /var/lib/ivorysql/data` |

| Service failed | Port conflict or configuration | `ss -tulnp | grep 5432` |

systemctl status ivorysql -l --no-pager

journalctl -u ivorysql --since "1 hour ago" --no-pager

sudo -u ivorysql /usr/ivorysql/bin/postgres -D /var/lib/ivorysql/data -c logging_collector=on

ls -l IvorySQL-AutoInstaller/ivorysql.conf

cat IvorySQL-AutoInstaller/ivorysql.conf

- Install logs: `/var/log/ivorysql/install_<timestamp>.log`

- Error logs: `/var/log/ivorysql/error_<timestamp>.log`

- initdb logs: `/var/log/ivorysql/initdb_<timestamp>.log`

- DB logs: `$DATA_DIR/log/postgresql-*.log` (if logging_collector is enabled; you may symlink this directory into `LOG_DIR`)

- Auto-enable CRB/Devel repositories for dev headers (e.g., `libxml2-devel`).

- Fallback `--allowerasing` strategy when appropriate.

- Check status:

```bash

grep "XML_SUPPORT" /var/log/ivorysql/install_*.log

```

- Auto-check `FindBin`, `IPC::Run`. Install via package manager or CPAN if missing.

dnf install -y perl-IPC-Run

PERL_MM_USE_DEFAULT=1 cpan -i IPC::Run FindBin

perl -MFindBin -e 1

perl -MIPC::Run -e 1