Configuring a Netlify Server
Deploying to Netlify
This guide outlines the steps to configure DeployHQ for deployments to Netlify, enabling seamless deployment of static sites and single-page applications.
Prerequisites:
- Beta Features Enabled: Ensure that "Beta features" are enabled in your DeployHQ account settings. This is a prerequisite for utilizing the Netlify integration.
- Existing Netlify Site: You must have an existing site in your Netlify account. The site ID is required for configuration.
Step-by-Step Configuration:
Select Protocol: Begin by navigating to your server settings within DeployHQ and select Netlify as your server's protocol.
Personal Access Token: You will need to enter your Netlify personal access token. To create one:
- Go to your Netlify User Settings
- Generate a new personal access token
- Copy the token for use in DeployHQ
Site ID: Enter your Netlify site ID, which can be found in:
- Netlify dashboard → Site settings → General → Site details
- The site ID is a UUID format (e.g.,
12345678-1234-5678-9012-123456789abc
)
Configuration: Once you've entered your access token and site ID, DeployHQ will verify the connection to ensure your credentials are correct and you have permission to deploy to the specified site.
Supported Features:
- Automatic Build Detection: DeployHQ automatically detects common static site generators including React, Vue.js, Angular, Gatsby, Hugo, and Jekyll
- Build Output Detection: Automatically identifies common build output directories (
dist
,build
,_site
,public
) - Netlify Configuration Support: Supports
netlify.toml
,_redirects
, and_headers
files - File Exclusions: Automatically excludes unnecessary files like
node_modules
,.env
, and.git
directories - Deployment Monitoring: Real-time monitoring of deployment progress with detailed logging
Build Requirements:
Before deploying to Netlify through DeployHQ, ensure your project has been built:
- React/Vue/Angular: Run
npm run build
or equivalent build command - Gatsby: Run
gatsby build
- Hugo: Run
hugo
- Jekyll: Run
jekyll build
DeployHQ will validate that build outputs exist and provide warnings if expected build directories are missing.
Once these steps are completed, your server will be configured and ready for deployments to your Netlify site. The deployed site will be available at your Netlify domain (e.g., https://your-site-id.netlify.app
).