Abstrax

Config

The config group manages Abstrax settings stored in /etc/abstrax/config.json. These settings apply server-wide and are used by other commands (for example, PHP extension packages installed when creating a PHP project).

abstrax config <action> [arguments] [flags]

Permissions

set, add, remove, and reset require root. The read-only commands show, list, and get do not require root.

Configuration file

Settings are stored as JSON:

/etc/abstrax/config.json

If the file does not exist, Abstrax uses built-in defaults. See Config file for details.

Keys

Keys use dot notation. Only known keys are accepted.

Key Type Default
php.extensions list of strings mysql, xml, curl, mbstring, zip, bcmath, gd, intl, redis, sqlite3
projects.approved_roots list of absolute paths (none)

Values for php.extensions are apt package suffixes, not full package names. When PHP 8.5 is installed for a project, Abstrax expands mysql to php8.5-mysql, and so on. The php*-cli package is always installed and includes pcntl and posix; do not add those suffixes to php.extensions.

projects.approved_roots lists directories where user isolated projects (created with --user) may be placed outside the selected user's home directory. Example: /srv/sites. Paths inside another user's home are never allowed.

config show

Show the effective configuration (defaults merged with saved settings).

abstrax config show

config list is an alias for config show.

  php.extensions:
    - mysql
    - xml
    - curl
    - mbstring
    - zip
    - bcmath
    - gd
    - intl
    - redis
    - sqlite3

pcntl and posix are available through php*-cli and are not separate apt packages.

config get

Get a single configuration value.

abstrax config get php.extensions

mysql xml curl mbstring zip bcmath gd intl redis sqlite3

config set

Replace a list configuration value.

sudo abstrax config set php.extensions mysql xml curl mbstring zip bcmath gd intl

config add

Append a value to a list configuration key.

sudo abstrax config add php.extensions readline

config remove

Remove a value from a list configuration key.

sudo abstrax config remove php.extensions gd

config reset

Reset configuration to defaults. Asks for confirmation unless --yes is given.

# Reset one key
sudo abstrax config reset php.extensions

# Reset all settings (removes the config file)
sudo abstrax config reset