The Deployment Management section in Cloudways Velocity allows you to deploy your Node.js application from its connected Git repository and manage how the application is built and started.
From this section, you can:
Enable or disable automatic deployments.
manually redeploy the latest configured branch.
Review previous deployments.
Check deployment status and build logs.
Redeploy a previous commit.
Select the application framework, branch, and Node.js version.
Configure build and startup commands.
Add environment variables used during build and runtime.
This provides a single place to manage your deployment workflow without manually running deployment commands from a terminal.
Important:
Changes to build settings, branches, commands, or environment variables can affect application availability. Review all values carefully before saving and redeploying.
Before You Begin
Make sure that:
Your Velocity application is connected to a supported Git repository.
The repository contains the files required to build and run the application.
You know which branch should be deployed.
Your application has a valid build command and startup command.
You have permission to manage the repository and application.
Consider creating an on-demand backup before changing deployment settings for a production application.
Manage Deployments for a Cloudways Velocity Application
The Deployment Management section provides the tools required to deploy and update a Cloudways Velocity application from a connected Git repository.
Use the Deployments tab to control auto-deployment, redeploy the application, and review deployment history and logs. Use the Settings tab to configure the framework, branch, Node.js version, build commands, and environment variables.
Access Deployment Management
Log in to the Cloudways Platform.
From the left navigation menu, select Velocity.
Select My Applications.
Choose the application you want to manage.
From the application management menu, select Deployment Management.
The Deployment Manager contains two tabs:
Deployments
Settings
Manage Application Deployments
Navigate to: Velocity → My Applications → Select Application → Deployment Management → Deployments
The Deployments tab shows the connected repository, automatic deployment status, and deployment history.
Understand the Connected Repository
At the top of the page, Cloudways displays the repository connected to the application.
The repository section may show:
The repository or application name.
The connected Git provider.
The repository receiving application pushes.
Whether automatic deployment is enabled.
This helps confirm that the application is connected to the correct source-code repository.
Enable or Disable Auto-Deployment
Auto-deployment automatically starts a new deployment when supported changes are pushed to the configured repository branch.
Use the Auto-deployment toggle to turn this behavior on or off.
When Auto-Deployment Is Enabled
Cloudways automatically deploys new commits pushed to the configured branch.
This is useful when you want repository changes to reach the application without manually starting every deployment.
When Auto-Deployment Is Disabled
New repository pushes do not automatically deploy the application. You must start a deployment manually.
Disabling auto-deployment may be useful when:
You want to review code before releasing it.
You need controlled deployment windows.
You are testing repository changes.
You want to avoid unintended production deployments.
Important: Confirm that the correct branch is selected before enabling auto-deployment.
Manually Redeploy the Application
Select Redeploy to deploy the application again using the current branch and build configuration.
Use Redeploy when:
You want to run the latest deployment again.
A previous deployment encountered a temporary issue.
You changed build settings or environment variables.
You need to rebuild the application without creating a new commit.
The new deployment appears in the deployment history.
Review Deployment History
The deployment table provides a record of previous application deployments.
It includes the following information.
Author
Shows the Git user associated with the commit or deployment.
Branch
Shows the repository branch used for the deployment.
A branch is a separate version of a repository, such as main, production, or a development branch.
Commit
Shows the shortened commit identifier.
A commit is a saved version of the repository files at a particular point in time.
Type
Shows how the deployment was started.
Common values include:
Auto: Started automatically after a supported repository push.
Manual: Started manually from the Cloudways Platform.
Time
Shows when the deployment was started or recorded.
Status
Shows the result of the deployment.
For example:
Success: The application completed the deployment process successfully.
A failed or incomplete status would indicate that the deployment requires review.
Use the search and filter controls to locate a particular deployment when the history contains several entries.
View Deployment Details and Build Logs
Locate the required deployment.
Open the three-dot menu.
Select View Details.
The deployment details window displays information such as:
Deployment status.
Repository.
Author.
Branch.
Commit.
Root directory.
Framework.
Node.js version.
Deployment date.
Build and output configuration.
Build Logs
Build logs show the commands, messages, warnings, and errors generated while Cloudways builds and starts the application.
Use the logs to identify:
Missing dependencies.
Invalid build commands.
Incorrect startup commands.
Framework or Node.js version issues.
Failed scripts.
Port configuration issues.
Other deployment errors.
A completed log stream and a successful status indicate that the deployment process finished successfully.
Select Download to save a copy of the build logs when you need to share them or review them separately.
Tip:
When a deployment fails, review the final error messages first. They often identify the command or file that caused the problem.
Redeploy a Previous Deployment
You can deploy the same commit and configuration used by a previous deployment.
Locate the required deployment.
Open its three-dot menu.
Select Redeploy.
Wait for the new deployment to complete.
Review its status and build logs.
This can be useful when:
A previous successful release must be rebuilt.
A deployment failed because of a temporary issue.
You want to verify an earlier commit.
Note:
Redeploying an earlier entry runs that deployment again. It does not change or delete the repository history.
Configure Deployment Settings
Navigate to: Velocity → My Applications → Select Application → Deployment Management → Settings
The Settings tab controls how Cloudways builds and starts the application.
It contains:
Build Configurations
Build and Output Settings
Environment Variables
Configure Build Settings
Framework Preset
Select the framework used by your application.
The framework preset helps Cloudways apply suitable default build and start settings.
The available options depend on the frameworks supported by Velocity.
The screenshot shows an example using TanStack SSR.
Choose the framework that matches the application. Selecting an incorrect framework may produce unsuitable default commands.
Branch
Select the Git branch that Cloudways should deploy.
For example:
mainproductiondeploy/cloudways-nitro
The selected branch is also used by auto-deployment when that feature is enabled.
Node Version
Select the Node.js version required by the application.
The selected version should be compatible with:
The application framework.
Installed dependencies.
The repository’s package configuration.
Your application code.
The screenshot shows Node.js version v24.
Root Directory
The Root Directory identifies the folder containing the application.
The value
./means that the application is located at the root of the repository.For a monorepo or application stored in a subfolder, the required root directory may be different.
Important:
An incorrect root directory may prevent Cloudways from finding the application files or package configuration.
Configure Build and Output Settings
These values may be filled automatically according to the selected framework. You can change them when the application requires different commands.
Package Manager
Select the tool used to install and manage application dependencies.
The screenshot shows:
npm
Use the package manager expected by the repository.
Build Command
The build command prepares the application for deployment.
Example:
npm run build
This command normally runs the build script defined in the application’s package configuration.
Entry File or Start Command
This value tells Cloudways how to start the application after the build finishes.
The screenshot shows:
npm run start
Despite the field label shown in the interface, use the command or value required by your framework and application configuration.
Important:
Confirm that the selected commands exist in your application configuration. An invalid build or start command will cause the deployment to fail.
Add Environment Variables
Environment variables store configuration values used by the application during build or runtime.
They may be used for:
Database connection details.
API endpoints.
Service credentials.
Application modes.
Feature settings.
Third-party integrations.
Add an Environment Variable
Open Deployment Management → Settings.
Under Environment Variables, select Add Variable.
Enter the variable Key.
Enter the variable Value.
Enable Sensitive when the value contains private information.
Select Add more to enter additional variables.
Select Save.
Key
The key is the name used by the application.
Example:
API_URL
Value
The value is the configuration assigned to the key.
Example:
https://api.example.com
Sensitive
Enable Sensitive for passwords, tokens, secrets, or other private values.
After a sensitive value is saved, it is hidden and cannot be viewed again from the Platform.
Note: Keep a secure copy of sensitive values before saving them. You may need to replace the value if it is later lost or changed.
Import Variables from a .env File
Select Import .env to import multiple variables from an existing .env file.
A .env file is a text file that contains environment variables in a format similar to:
API_URL=https://api.example.com
APP_ENV=production
Review the imported variables before saving them and mark private values as sensitive where required.
Do not upload a .env file that contains outdated, test, or incorrect production credentials.
Save Settings and Redeploy
After changing deployment settings, Cloudways provides the following actions.
Save
Saves supported changes without immediately starting a new deployment.
Save & Redeploy
Saves the changes and starts a new application deployment using the updated settings.
Use Save & Redeploy when a change must take effect immediately, such as:
Changing the branch.
Changing the Node.js version.
Updating the build command.
Updating the startup command.
Adding or changing environment variables.
The buttons remain unavailable until a supported setting is changed.
Recommended Deployment Practices
Use a dedicated production branch for live applications.
Review commits before enabling auto-deployment.
Create an on-demand backup before major production deployments.
Keep the Node.js version aligned with your application and dependencies.
Do not store credentials directly in repository files. Use sensitive environment variables instead.
Review build logs after each failed deployment.
Test the application after changing build commands, environment variables, or framework settings.
Keep a secure record of sensitive values because saved sensitive values cannot be viewed later.
Avoid repeatedly redeploying without reviewing the cause of a failed build.
Frequently Asked Questions
What is the difference between auto-deployment and manual deployment?
Auto-deployment starts when supported code changes are pushed to the configured branch. A manual deployment is started from the Cloudways Platform using Redeploy or another deployment action.
What does Redeploy do?
Redeploy starts the deployment process again using the current configured branch and build settings.
Can I redeploy an earlier commit?
Yes. Open the three-dot menu beside the required deployment and select Redeploy.
Where can I check why a deployment failed?
Open the deployment’s three-dot menu, select View Details, and review the build logs.
Can I download deployment logs?
Yes. Open the deployment details and select Download in the Build Logs section.
What is the root directory?
It is the repository folder containing the application files. ./ represents the repository root.
What happens after I change the branch?
The selected branch becomes the source for future deployments. Use Save &
Redeploy to deploy it immediately.
What is a framework preset?
It tells Cloudways how the application is structured and provides suitable default build settings for the selected framework.
Can I change the automatically selected build command?
Yes. The build and output values can be changed when your application requires custom commands.
Why should I mark an environment variable as sensitive?
Sensitive mode hides private values such as passwords and tokens after saving them.
Can I view a sensitive value after saving it?
No. The interface warns that sensitive values are hidden after they are saved.
Can I import several variables together?
Yes. Use Import .env to import variables from a .env file.
When should I use Save & Redeploy?
Use it when the updated deployment configuration must be applied to the running application immediately.
That's it! We hope this article was helpful.