Create and Publish Installation Image
You may create a new installation image by using the image create CLI command, such as:
apex image create <ALIAS>
apex image create ecommerce
Using the above example, this will create a new directory at /images/ecommerce/, which contains the following files:
| Filename | Description |
|---|---|
| config.yml | Configuration file for the image and includes general details, packages to install, and configuration variables to set. See below for details. |
| image.php | Somewhat of a database migration that only includes an install() method, which is executed during installation. By default, only executes the SQL code within install.sql file. |
| install.sql | Contains the SQL code to execute against the database during installation. |
| Readme.md | Contents is displayed on the https://images.apexpl.io/ site to describe the installation image. |
config.yml file
The config.yml contains the configuration for the installation image, and consists of three sections, general, packages and config.
general
The general section is an associative array that consists of basic details as described in the below table.
| Key | Description |
|---|---|
| name | The name of the installation image, formatted in <USERNAME>/<ALIAS>. |
| version | The version of the installation image. |
| access | Access level, can be either "public" or "private". |
| description | Brief one line description of the installation image. |
packages
Associative array, the keys being the package name formatted in <AUTHOR>/<ALIAS>, and the value being the version to install. Supported values for the version are "latest", "dev" or a specific version number.
config
Defines configuration variables to update the values of. The keys are the name of the configuration variable formatted in <PACKAGE>.<ALIAS> and the values are what to update the value of the configuration variable to.
Publish Image
Once done, you may publish the installation image with the image publish CLI command, such as:
apex image publish <ALIAS>
apex image publish ecommerce
This will package the installation image, and upload it to the repository. Once published, you may view it within your web browser at https://images.apexpl.io/<AUTHOR>/<<ALIAS>. Any time you have modified the image, you may update it within the repository by publishing it again same as above.