Repository files navigation

This action is a part ofGitHub Actions Library created byrtCamp.

AGitHub Action to deploy WordPress on a server usingPHP's Deployer.org project.

Please note that, this action expects git repo structure in a certain way. Your webroot should include content insidewp-content exceptuploads. You may use ourWordPress Skeleton as a base, or restructre existing project to fit in.

During deployment, by default this action will downloadWordPress, put the content of the repo inwp-content directory and then deploy the entire WordPress setup on the deploy path specified inhosts.yml.

hosts.yml isDeployer's inventory file.

1. Create a.github/workflows/deploy.yml file in your GitHub repo, if one doesn't exist already.
2. Add the following code to thedeploy.yml file.

on:pushname:Deploying WordPress Sitejobs:deploy:name:Deployruns-on:ubuntu-lateststeps:    -uses:actions/checkout@v2    -name:Deployuses:rtCamp/action-deploy-wordpress@v2env:SSH_PRIVATE_KEY:${{ secrets.SSH_PRIVATE_KEY }}

3. CreateSSH_PRIVATE_KEY secret usingGitHub Action's Secret and store the private key that you use use to ssh to server(s) defined inhosts.yml.
4. Create.github/hosts.yml inventory file, based onDeployer inventory file format. Make sure you explictly define GitHub branch mapping. Only the GitHub branches mapped inhosts.yml will be deployed, rest will be filtered out. Here is a samplehosts.yml.

This GitHub action's behavior can be customized using following environment variables:

The Deployer.org expects server setup in a particular way.

1. Pass flag--public-dir=current during site creation.
2. Delete thecurrent folder usingrm -r /opt/easyengine/sites/example.com/app/htdocs/current.

Thecurrent folder will be automatically created by Deployer during execution.

1. Open file/opt/easyengine/sites/example.com/config/nginx/conf.d/main.conf.
2. Replace/var/www/htdocs with/var/www/htdocs/current.
3. Runee site reload example.com.
4. Movewp-config.php tohtdocs. You can use following command:

mv /opt/easyengine/sites/example.com/app/wp-config.php /opt/easyengine/sites/example.com/app/htdocs/wp-config.php

1. Make sure your web server points tocurrent subdirectory inside original webroot. Make surecurrent subdirectory do NOT exist actually.
2. You may need to reload your webserver.
3. You may need to change location ofwp-config.php as we need in above section.

This GitHub action supportsHashicorp Vault. This comes in handy if you manage multiple servers and providingSSH_PRIVATE_KEY as GitHub secret per project becomes cumbersome.

To enable Hashicorp Vault support, please define following GitHub secrets:

You will need to changesecrets line indeploy.yml file to look like below.

on:pushname:Deploying WordPress Site using vaultjobs:deploy:name:Deployruns-on:ubuntu-lateststeps:    -uses:actions/checkout@v2    -name:Deployuses:rtCamp/action-deploy-wordpress@v2env:VAULT_ADDR:${{ secrets.VAULT_ADDR }}VAULT_TOKEN:${{ secrets.VAULT_TOKEN }}

GitHub action usesVAULT_TOKEN to connect toVAULT_ADDR to retrieveSigned SSH Certificates and uses it for deployment.

Please remember that you must configure each of your target deployment server to accept ssh connection via signed certificate using Vault beforehand. Ususally, you need to run following commands once per server:

export VAULT_ADDR='https://example.com:8200'export VAULT_TOKEN='s.gIX5MKov9TUp7iiIqhrP1HgN'# Add the public key to all target host's SSH configuration.curl -o /etc/ssh/trusted-user-ca-keys.pem"$VAULT_ADDR/v1/ssh-client-signer/public_key"# Add the path where the public key contents are stored to the SSH configuration file as the TrustedUserCAKeys option.echo"TrustedUserCAKeys /etc/ssh/trusted-user-ca-keys.pem">> /etc/ssh/sshd_config# Restart ssh service. This may differ according to the OS.systemctl restart ssh

Create a file at location.github/deploy/deploy.php in your git repo to provide your ownDeployer.org script.

Please note that it will completely override this action'soriginal deploy.php. So if you need some portion oforiginal deploy.php, you need to copy that to your own.github/deploy/deploy.php.

MIT © 2021 rtCamp