Pagely offers an easy-to-use Docker container for deploying from your preferred CI/CD tool. This article serves as a reference for reviewing the available variables.
Note: If you're looking for a tutorial on how to set up automatic deployments, please see our documentation on automatically deploying WordPress sites from version control.
Repositories
If you want to take a look at the source files, they can be found here:
Variable Quick Reference
PAGELY_DEPLOY_DEST: "/httpdocs"
PAGELY_INTEGRATION_SECRET: $PAGELY_INTEGRATION_SECRET
PAGELY_INTEGRATION_ID: "HhYn9Per7Ni3Jhz3McVpR"
PAGELY_APP_ID: "12345"
PAGELY_WORKING_DIR: "/dist"
Docker Image Variables
PAGELY_DEPLOY_DEST (Required)
This variable contains the destination path that will be deployed to.
Examples
-
Deploying to the app's root directory:
PAGELY_DEPLOY_DEST: "/httpdocs"
-
Deploying a WordPress theme:
PAGELY_DEPLOY_DEST: "/httpdocs/wp-content/themes/pagely-example-theme"
PAGELY_INTEGRATION_SECRET (Required)
This variable contains the integration secret. For security purposes, this should always use a protected variable whenever possible.
Examples
-
As a protected variable:
PAGELY_INTEGRATION_SECRET: $PAGELY_INTEGRATION_SECRET
-
As plain-text:
PAGELY_INTEGRATION_SECRET: "mysecretfromatomic
PAGELY_INTEGRATION_ID (Required)
This variable contains your integration ID.
Examples
-
PAGELY_INTEGRATION_ID: "HhYn9PesgNiLJhz3McVnR"
PAGELY_APP_ID (Required)
This variable contains the ID of the app that you will be deploying to.
Examples
-
PAGELY_APP_ID: "12345"
PAGELY_WORKING_DIR (Optional)
This variable contains the working directory to be deployed. If left empty, it will use your CI/CD tool's default directory.
It is useful for deploying from a different directory inside your build environment, such as when repository needs to be built before deploying.
Examples
-
Using Bitbucket's default clone directory variable:
PAGELY_WORKING_DIR: $BITBUCKET_CLONE_DIR
-
Using a manually-defined build path:
PAGELY_WORKING_DIR: "/dist"