The DeployHQ Chrome Extension
The DeployHQ Chrome Extension lets you trigger deployments directly from GitHub, GitLab, and Bitbucket without leaving your browser. It adds a "Deploy with DeployHQ" button to your repository pages and provides a project dashboard with real-time deployment notifications.
Installation
- Visit the Chrome Web Store listing
- Click Add to Chrome
- Confirm the installation when prompted
The extension requires the following permissions:
- Storage -- to save your login credentials locally
- Notifications -- to alert you when deployments complete or fail
- Access to deployhq.com, github.com, gitlab.com, and bitbucket.org -- to communicate with the DeployHQ API and inject deploy buttons on repository pages
Setup
After installation, click the DeployHQ extension icon in your browser toolbar to open the popup.
Logging In
Enter your DeployHQ account details:
- Account subdomain -- your DeployHQ subdomain (e.g.
mycompanyformycompany.deployhq.com) - Email address -- the email associated with your DeployHQ account
- API key -- found under Settings > Security in your DeployHQ account
Your credentials are stored locally in your browser and are never sent to any third party.
Features
Deploy from GitHub, GitLab, and Bitbucket
When you visit a repository page on GitHub, GitLab, or Bitbucket that is connected to a DeployHQ project, a Deploy with DeployHQ button appears on the page.
The button appears on:
- Repository root pages (e.g.
github.com/myorg/myrepo) - Branch pages (e.g.
github.com/myorg/myrepo/tree/feature-branch) - Pull request / merge request pages (e.g.
github.com/myorg/myrepo/pull/123)
Clicking the button opens the deployment form pre-filled with the current branch, so you can select a target server and deploy immediately.
If the repository is not yet connected to DeployHQ, a Connect to DeployHQ link appears instead, which takes you to the new project form with the repository details pre-filled.
Project Dashboard
Click the extension icon to view all your DeployHQ projects. The dashboard shows:
- A searchable list of all your projects
- The timestamp of the latest deployment for each project
- Quick access to project details
Project Details
Click on any project to see:
- Servers and server groups configured for the project
- Recent deployment history with status indicators
One-Click Deployments
From the project detail view or the deploy button on a repository page, you can trigger a deployment by selecting:
- A target server or server group
- A branch to deploy
- A revision (defaults to the latest)
Real-Time Notifications
The extension polls your DeployHQ account for deployment status changes and sends desktop notifications when:
- A deployment starts
- A deployment completes successfully
- A deployment fails
The extension icon also shows a status badge:
- Blue (
...) -- a deployment is currently running - Red (
!) -- a deployment has failed - No badge -- all deployments are healthy
Settings
You can configure the following in the extension settings:
- Polling interval -- how often the extension checks for deployment status updates (default: 60 seconds)
- Notifications -- enable or disable desktop notifications
- Git platform integration -- enable or disable the deploy buttons on GitHub, GitLab, and Bitbucket
Frequently Asked Questions
Where do I find my API key?
Your API key is available under Settings > Security in your DeployHQ account. Each team member should use their own API key.
Does it work with self-hosted GitLab or GitHub Enterprise?
The extension currently supports github.com, gitlab.com, and bitbucket.org. Self-hosted instances are not supported at this time.
Can multiple team members use the extension?
Yes. Each team member installs the extension and logs in with their own DeployHQ credentials. Permissions are based on their DeployHQ account access.
How does the extension match my repository to a DeployHQ project?
The extension compares the repository URL on the page you are viewing with the repository URLs configured in your DeployHQ projects. It handles both HTTPS and SSH URL formats automatically.
Is my API key secure?
Your API key is stored locally in your browser using Chrome's storage API. It is only sent to your DeployHQ account over HTTPS and is never shared with any third party.
Source Code
The extension is open source and available on GitHub:
https://github.com/deployhq/deployhq-chrome-extension
Contributions and bug reports are welcome via GitHub issues and pull requests.
Related Tools
- The DeployHQ CLI -- command line tool for deployments
- The DeployHQ API -- REST API for automation
- DeployHQ MCP Server -- AI assistant integration