Help & Support

Everything you need to help you deploy your first project and streamline your development workflow.

Getting Started

Introduction

Find out how DeployHQ can help make your life easier when it comes to getting files from your repository onto your servers.

FAQ Deployments 101

FAQ on deployments, covering basic topics and most frequently asked questions

Core Functionality

Projects

How to configure a project in DeployHQ to connect to your repository and your servers.

Servers

Set up servers in your DeployHQ project to upload your repository files to.

Deployments

Preparing for a deployment using DeployHQ.

Users

How to manage users in your DeployHQ account, and ensure they only have access to what they need.

Configuration

Config Files

Setting up static configuration files to upload files to your server, or use in the build pipeline that aren't stored in your repository.

SSH Commands

Configure SSH commands to run processes directly on your servers before or after a deployment.

Build Pipelines

Using build commands to compile assets, run tests or fetch dependencies before you upload changes to your server. Supported tools include: PHP, Composer, Ruby, Node, Yarn, Python, Go and Java

Excluded Files

Prevent certain files or directories in your repository from being deployed to your server.

Templates

Using a template in DeployHQ to share common configuration between projects.

Network Agents

How to deploy to servers in private networks using the DeployHQ Agent.

Public Framework Templates

Get started quickly with DeployHQ's curated public framework templates for popular web development frameworks and platforms.

Agent certificate renewal

Why every DeployHQ network agent needs upgrading before 17 March 2027, how to upgrade each version of the agent, and how to check it worked.

Integrations

Set up integrations with a number of 3rd party services for deployment notifications and other useful tasks.

Notifications

Set up notifications with different services for when deployments start and finish.

Global SSH Keys

How to create and use global SSH keys in DeployHQ across projects, global servers, and project servers.

Global Servers

How to create and use global servers in DeployHQ to reuse server configurations across projects.

Troubleshooting

Build Errors

Troubleshooting build pipeline errors during a deployment.

Deployment Errors

Fixing common errors when running deployments in DeployHQ.

FAQ

Here are some of the most frequently asked questions.

Network Agent errors

Troubleshoot errors relating to the DeployHQ network agent.

Repository Errors

Resolve issues when configuring the repository in your DeployHQ project.

Server Errors

Troubleshooting common errors when configuring servers in DeployHQ.

Zero-downtime deployment issues

Troubleshoot issues relating to zero-downtime deployments.

AI Error Explanation

How to use DeployHQ's AI helper to troubleshoot deployment errors.

AI PageSpeed

Learn how AI PageSpeed analyzes your website performance and provides framework-specific optimization recommendations powered by AI.

PR Radar

PR Radar is a free, open-source browser extension by DeployHQ that shows all your pull requests, CI status, and deployment previews in one place.

Migration guides for moving to DeployHQ from script-based deploy tools, CI runners, and competitor platforms. Map your existing stages, hooks, and shared paths in a few hours, with optional concierge assistance.

Deprecated build runtimes

What the runtime deprecation, missing, and unavailable warnings in your build log mean, and how to choose a supported runtime version for your project.