Getting Started

Learn how to set up Hydra Deploy and complete your first deployment.

What You Need

Before getting started with Hydra Deploy, you’ll need:

• An account on Hydra Deploy
• Access to a server where you can install the Hydra Deploy agent
• An application you want to deploy

Install the Hydra Deploy Agent

The Hydra Deploy Agent is a small application that runs on your server and executes deployment scripts.

Step 1: Download the Agent

Download the agent from our GitHub repository. Extract it to a folder on your server.

Step 2: Create an Agent in Hydra Deploy

1. Go to Settings > Agents
2. Click on Create Agent
3. Give the agent a name (e.g., “Production Server”)
4. You will receive a unique agent key

Step 3: Start the Agent

Start the agent executable with the received key:

Linux:

./agent --agent-key <your-agent-key>

Windows:

agent.exe --agent-key <your-agent-key>

Step 4: Verify the Connection

After starting, the agent’s status should appear as “online” in the Hydra Deploy interface.

First Deployment

Step 1: Create an Application

1. Go to Applications
2. Click on Create New App
3. Fill in the information:
   • Name - A unique name for the application (e.g., “User Service”)
   • Code - A unique code for identification (auto-generated based on name)
   • Description - An optional description of what the application does
4. Optionally upload an image or icon
5. Click on Create

Step 2: Define the Deployment Script

1. Go to the application page
2. Navigate to the Deploy Script tab
3. Write a script that deploys your application:
   • Linux: use Bash
   • Windows: use PowerShell

Example for a Node.js application:

#!/bin/bash
# Stop the current application
pm2 stop my-app
 
# Install dependencies
npm install
 
# Start the application
pm2 start npm --name my-app -- start

Step 3: Create a Version

1. Go to the Versions tab of your application
2. Click on Create Version
3. Enter the version number (e.g., “v1.0.0” or “1.0.0”)

Step 4: Create a Project

1. Go to Projects
2. Click on Create Project
3. Give the project a name

Step 5: Configure Environments

1. Go to Settings > Environments
2. Create environments (e.g., Development, Staging, Production)
3. Drag environments to determine the order (determines display in deploy page)

Step 6: Connect the Agent to the Project

1. Go to your project page
2. Navigate to the Agents tab
3. Select the agent and connect it to the appropriate environments
4. Save the connection

Step 7: Deploy your Application

1. Go to the Deployments overview
2. Or go to your project page
3. Click on Deploy next to the desired version and environment
4. Confirm the deployment
5. The agent will execute the deployment script

Next Steps

Now that you’ve completed your first deployment, you can explore:

• Configurations - Define configuration files for your applications
• Team Management - Invite team members and manage permissions
• Deployment History - View deployment history and logs
• Auto Deploy Rules - Automate deployments based on rules

Troubleshooting

Agent Not Coming Online

Check the following:

• Is the agent key correct?
• Does the server have internet access?
• Is the firewall blocking the connection?

Deployment Failed

Check the deployment logs in the deployment details page. Check:

• Is the deployment script correct?
• Does the agent have sufficient permissions?
• Are all required tools installed on the server?