Deploy / Install Project

Deploying a project is as simple as adding an extra flag or two when initially running the apex CLI command during installation. First, ensure yor server meets all requirements for Apex which you may view full details of on the Installation section of the documentation.

To start, simply create a new Apex project via Composer with the command:

composer create-project apex/apex

Install Public Project

Once inside the Apex installation directory, simply run the apex CLI command as normal to enter the instalation wizard, but add the --project flag, such as:

./apex --project <AUTHOR>/<PROJECT>

./apex --project jsmith/test-proj

This will complete the base installation of Apex, then proceed to download the entire project from the repository and install it. The entirety of the current Apex installation directory will be replaced with the contents of the repository, plus the SQL database will be deleted and re-installed with all packages included within the project.

Install Private Project

Installing a project with access level of "private" is slightly different as you first need to import your account into Apex. First, ensure the the SSH key, the username.pem file that was created during account registration is uploaded into the Apex installation directory of the remote server.

Then same as above, run the apex CLI command with the --project flag, but this time also add the --import flag, such as:

./apex --project <AUTHOR/<PRJECT> --import

./apex --project jsmith/test-proj --import

After the base Apex installation, you will be prompted for your Apex username and password, and then the location of your SSH key. Simply enter "username.pem" for the location of the SSH key, or whatever the name of the .pem file you saved is.

Once your account has been successfully imported, it will be able to connect to the repository over SSH, download the entire project from its repository, and install it on the local machine.