Your project sidebar
Every DeployHQ project page has a sidebar on the left grouped into four sections: Deploy, Configure, Repository, and Project. Each item shows an icon, the section name, and -- where relevant -- a count badge of how many records exist on your project.
This article describes what each section contains and where to find common settings.
Deploy
The Deploy section contains everything related to running and tracking deployments.
- Deployments -- the full history of deployments for this project. The count badge shows the total number of deployments. From here you can start a new deployment, retry a failed one, or roll back to a previous build.
- Servers & Groups -- the destinations a deployment can target. The count badge shows the number of configured servers plus server groups. Each server has its own protocol (SSH, SFTP, FTP, FTPS, ElasticBeanstalk, Heroku, Managed VPS) and connection details.
Configure
The Configure section contains the build and post-build steps that run during a deployment.
- Build Pipeline -- the build commands that run on DeployHQ's build servers before files are transferred. The count badge shows the number of build commands configured. This is where you select language versions and watch files, and where the runtime mismatch banner appears.
- Config Files -- per-environment configuration files that DeployHQ generates and uploads at deploy time, with variable interpolation for environment-specific values. The count badge shows the number of config files defined.
- Environment Variables -- key-value pairs available to your build commands, SSH commands, config files, and notifications. The count badge shows the number of variables defined.
- Excluded Files -- patterns for files in your repository that should not be transferred to your servers (for example,
*.md,tests/,.env.example). The count badge shows the number of patterns defined. - SSH Commands -- commands to run on your target server before and after each deployment. The count badge shows the total number of pre- and post-deployment commands configured.
Repository
The Repository section is dedicated to your code source.
- Repository -- details of the connected repository, including its hosting platform, URL, branch, and the public deploy key DeployHQ uses to pull changes.
- Automatic Deployments -- the webhook URLs that trigger a deployment when a branch updates, plus the configuration that maps incoming pushes to target servers.
Project
The Project section contains everything that affects the project as a whole.
- Integrations -- third-party services notified when a deployment finishes, including Slack, Discord, Microsoft Teams, Google Chat, Telegram, Linear, Sentry, Honeybadger, Mixpanel, and others. The count badge shows the number of active integrations.
- Settings -- project name, permalink, deployment options, notification preferences, and the project's public key.
- Insights -- aggregated statistics about your project's deployment activity, success rate, and most-active contributors.
Count badges
A count badge is the small number next to an item in the sidebar. It reflects the current total for that section -- for example, a deployments badge of 247 means the project has 247 recorded deployments to date. Badges update whenever you add or remove records.
Items with no records do not show a badge. For example, a brand-new project will not show a badge on Deployments until the first deployment runs.
Keyboard navigation
The sidebar is keyboard-accessible: use Tab to move between items and Enter to open the selected section. Active items are highlighted with the section's accent color.
Further information
- Create a new project -- the starting point if you haven't yet added a project to DeployHQ
- Build Pipelines -- in-depth coverage of the build pipeline configure step
- Environment variables -- detailed guide to defining and using variables
- Excluded Files -- patterns and syntax for the excluded files list