PHP: Configure SSH keys

This documentation is part of the Deploy with GitHub Actions guide. View the full guide here: How to deploy your PHP code using GitHub Actions.

👋 Welcome to the Stackhero documentation!

Stackhero offers a ready-to-use PHP cloud solution that provides a host of benefits, including:

• Deploy your application in seconds with a simple git push.
• Use your own domain name and benefit from the automatic configuration of HTTPS certificates for enhanced security.
• Enjoy peace of mind with automatic backups, one-click updates, and straightforward, transparent, and predictable pricing.
• Get optimal performance and robust security thanks to a private and dedicated VM.

Save time and simplify your life: it only takes 5 minutes to try Stackhero's PHP cloud hosting solution!

SSH keys are the recommended method for allowing GitHub Actions to securely connect to your PHP service during deployment. In this guide, you will create a unique SSH key pair just for this purpose.

Generate SSH keys

To generate new SSH keys, you can run this command on your computer:

ssh-keygen -C "" -f /tmp/ssh_key -N ""

Set the public key

Next, retrieve the public key by running:

cat /tmp/ssh_key.pub

Head over to your Stackhero dashboard and select your "Production" PHP service. Click on "Configure" and follow these steps:

1. Under SSH public keys, click on "Add a public key".
2. Set the Description to "GitHub Action".
3. Paste the public key you just retrieved into the Key field.

Get service settings

Set the private key

Now, add the private key to your GitHub project so it can be used during deployment:

• Go to Settings, then select Environments and click on New environment.

  Configuring GitHub environments

• In the Name field, enter "production" and confirm.

  Setting the environment

• Click on the No restriction button and select Selected branches and tags.

  Setting environment restrictions

• Click on Add deployment branch or tag rule, enter "production" in the Name pattern field, and click on Add rule.

  Setting environment branch Setting environment branch

• Under Environment secrets, click on Add secret.

  Add secret

Retrieve the private key you generated earlier by running:

cat /tmp/ssh_key

In the GitHub environment settings:

• For Name, enter STACKHERO_SSH_PRIVATE_KEY and paste your private key into the Value field.

  Setting the SSH private key secret

• In the Environment variables section, click on Add variable.

  Setting variables

• For Name, enter STACKHERO_ENDPOINT and paste your PHP service endpoint into the Value field. You can find this endpoint in your Stackhero dashboard.

  Setting the endpoint variable

If you have customised your service's domain name, use the customised version instead of <XXXXXX>.stackhero-network.com.

Delete the generated keys

For security reasons, it is a good idea to remove the generated SSH keys from your computer after setup:

rm /tmp/ssh_key /tmp/ssh_key.pub