Bench Setup and Upgrade

Bench is installed and upgraded with a bootstrap file, which downloads the archive Bench.zip with the Bench system files, extracts its content in the Bench root directory, and starts the Bench CLI with the initialization mode and the setup mode. The custom configuration is left untouched if it already exists; otherwise it can be initialized from a template or from a Git repository.

The setup of a Bench installation is performed in the following steps:

• Creating a directory as Bench root
• Downloading the (latest) bootstrap file in the Bench root
• Running the bootstrap file …
  • Downloading the (latest) Bench archive (Bench.zip)
  • Deleting the following folders in the Bench root: actions, auto, res, tmp, cache\_applibs, lib\_applibs, and the folders of the required apps in lib
  • Extracting the Bench archive
• Running the Bench CLI in initialization mode …
  • Initializing the site configuration
  • Downloading missing app libraries
  • Downloading missing app resources for required apps
  • Installing the required apps
  • Initializing the custom configuration from template or existing Git repository
  • Downloading missing app libraries
• Running the Bench CLI in setup mode …
  • Downloading missing app resources for activated apps
  • Installing activated apps
  • Writing the Bench environment file
  • Creating Launcher shortcuts

Running the Bench CLI in upgrade mode performs all steps listed above, except creating the Bench root directory.