Header

Deploying to Krystal

Deploying to your site hosted with Krystal is very simple with DeployHQ.

Firstly, you'll need to set up your DeployHQ project, then connect to your Krystal server.

Setting up your project

Head to the Projects screen in DeployHQ, then click the New Project button to get started.

You'll be prompted to enter a name for your project, then select where your repository is hosted.

New Project

Next, click Create project and you'll be taken to a screen where you can log in with your repository hosting account to authorise access and then choose your repository.

Setting up Krystal

In order to connect to your Krystal server, you'll need to retrieve your SFTP details. You can do this by following Krystal's guide.

Once you've done so, head to Servers & Groups, and click the New Server button at the top of the screen. If you've just added your repository, you will have been taken to this page automatically.

Start by entering a name, and choosing SSH/SFTP as the protocol:

Krystal - SSH server

Next, enter the home server name of your Krystal server, followed by port 722, then the username and password that you use to login into cPanel.

Krystal - SSH details

Next, enter a deployment path - the directory where files will be uploaded to on your server. This will normally start with public_html when deploying to Krystal, and you can then specify additional subdirectories if you're deploying to a folder within public_html.

Then, within Deployment options, you can choose to automatically deploy your server and, if you're only deploying files from a certain directory in your repository, enter a Deployment subdirectory.

Krystal - deployment options

You might, for example, be deploying a Wordpress site, but only want to upload your theme folder.

When you're finished, just click Create Server and you can proceed to run your first deployment.

Run your first deployment

By default, DeployHQ will upload the whole repository to your server on the first deployment, because there is no previously deployed commit to compare to.

If your files are already on Krystal and up to date with the latest commit, you can follow this guide to skip that first deployment:

Otherwise, just follow this guide to start your first deployment, then after the first deployment, only files that have changed will be uploaded in future.

That's it! You've now set up and run your first deployment to your Krystal server and your future changes will be uploaded for you automatically, or at the simple click of a button.

Further reading

DeployHQ has a number of very useful features to help with your deployments in general that you might wish to find out more about:

  • Compiling assets and javascript with the Build pipeline
  • Running commands on your server with SSH commands
  • Stop certain files from being uploaded in deployments using Excluded files
  • Keep important files safely away from your repository using Config files
  • Keep your team in the loop and run other useful tasks during a deployment with our Integrations