Skip to Content

PMIVerse terminology and variables

Core layout

  • PMIVERSE_ROOT — Root folder of the PMIVerse environment. Default: /srv/pmiverse.
  • PMISUITE_PREFIX — Prefix for per‑version instance folders. Default: _pmisuite.
  • SUITE_DIR — A specific instance folder: ${PMIVERSE_ROOT}/${PMISUITE_PREFIX}<version> (e.g., /srv/pmiverse/_pmisuite18).

Suite subpaths

  • venv — Python virtualenv under a suite: ${SUITE_DIR}/venv (binary: ${SUITE_DIR}/venv/bin/python).
  • repos/OCB — Odoo Community (or OpenUpgrade) code tree. Entrypoint: ${SUITE_DIR}/repos/OCB/odoo-bin.
  • config/pmisuite<version>.conf — Pinned Odoo config for the suite.
  • data/ — Instance data folder:
  • data/filestore/<db_name> — Odoo filestore root for a database.
  • data/backups[/|-main]/<source_dir_name> — Backups directory containing timestamped zip files.
  • data/dumps/<target_dir_name> — Working directory used by restore scripts.

Central configuration

  • pmiverse.conf — /srv/pmiverse/_pmiregistry/config/pmiverse.conf. Centralized variables and a CSV‑like database registry used by scripts.
  • PMIVERSE_DB_REGISTRY — A heredoc value in pmiverse.conf with six columns per line:
  • name — short alias for a database (e.g., demo).
  • db_name — actual Postgres DB name (e.g., demo.example).
  • version — suite version number (14 … 18).
  • source_dir_name — leaf folder under the backups directory holding the zips.
  • target_dir_name — working folder name under data/dumps/.
  • backups_dirname — optional parent backups directory name (backups or backups-main).

Backups and restore terms

  • backups_dirname — The name of the backups parent directory under data/. Common values: backups, backups-main.
  • Canonical archive layout — Inside the zip:
  • Database dump: dump.sql or a single *.sql, or a custom pg_dump archive *.dump/*.backup.
  • Filestore directory: <db_name>/... (or filestore/<db_name>, both supported).
  • Neutralization — A post‑restore step that disables external effects (crons, outbound email), sets website.robots to noindex, nofollow, clears IAP tokens, disconnects bank sync, etc. Implemented in SQL and ORM.

Tooling

  • CLI shortcuts — User/system restore-db symlink for easier execution.
  • Bash completion — Tab‑completion for the shortcut and full script name. Installed to ~/.bash_completion.d/ or /etc/bash_completion.d/.

See also: - Restore (generic): ../scripts/restore_database.md - CLI integration: ../scripts/cli_integration.md