Skip to main content

Step-by-Step Guide to Deploying a Node.js Application on Kuberns​

1. Creating a Project​

All your services come under a project. So to deploy your first Node.js service let’s create a project to define different services that make up your application. New users are prompted with a new project screen by default but in case you missed it, you can create one by clicking on Add New button on the top right of your navbar.

  • Start by giving your project an easy-to-remember and relatable name
  • Pick the service you want to start your project with
  • Here, we’ll go with a backend Service.

For more information about Projects, follow this link

2. Creating Services​

1. Connect with GitHub

Following the selection of service, you will be redirected to the "Creating a Service" page where you can configure the version control source. If this is the first time to Kuberns, you will need to authenticate GitHub to allow access to your repositories. Once authorized, you can select an organization, repository, and branch from your GitHub account.

  • On choosing to connect to GitHub, you are redirected to authorize Kuberns to access your Repositories.

Consecutively you are redirected back to the Kuberns dashboard, which now displays a list of your GitHub repos to choose from including your choice of organization and branch thus successfully linking your GitHub account.


For more information about Services, follow this link

2. Configure Environment Variables:

  • Define your environment variables manually or upload a .env file.
  • Ensure the .env file contains key-value pairs without special characters.

3. Configuring Environment Variables​

1. Default and Custom Environment Variables:

  • Kuberns provides default environment variables necessary for your application.
  • Add or edit environment variables as required for your application.
  • Adding New Environment Variables:

2. Navigate to the "Environment" section of your service.

  • Click "Add New Environment Variable" and input the key-value pairs.
  • Alternatively, upload a .env file containing the environment variables.

For more information about Environments, follow this link

Auto Detection Configuration​

Kuberns offers an Auto Detect Configuration feature that simplifies the setup process by automatically detecting the necessary configuration for running web commands if no Procfile is declared. This feature supports popular frameworks such as Django and NodeJS, ensuring a smooth and efficient deployment process.

NodeJS Configuration​

For NodeJS projects, Kuberns requires the package.json file. The system detects the necessary commands to run your NodeJS application and dynamically assigns the required port, so you do not need to include port configurations in your commands. Kuberns automatically creates a web service with the detected command for your NodeJS application.

4. Procfile Configuration for Node.js (Optional to user)​

  1. Create a Procfile:

  • In the root directory of your project, create a file named Procfile .
  • Add the following line to specify how to run your application:
web: npm run start

5. Runtime Configuration​

  1. Default and Custom Runtime:

  • Kuberns provides a default runtime, e.g., Node.js 14.
  • To customize the runtime, create a runtime.txt file in the root directory and specify the desired Node.js version::
node-14.x where x should be a valid nodejs version value part

6. Deployment​

  1. Deploy Your Application:

  • Click on the "Deploy" button on your service page.
  • Monitor the deployment process through the logs provided.

  2. Post-Deployment Configuration:

  • After deployment, navigate to the "Activities" section to view logs and monitor the status of your application.
  • Use the "Build History" section to track the build status and view detailed logs for debugging.
  • Activities: Kuberns allows multiple team members to collaborate on a single project seamlessly. The Activities section logs a wide range of actions performed by different team members, including starting, stopping, and modifying resources. This detailed activity tracking ensures complete transparency and accountability, providing a clear timeline of changes and actions taken.​


  • Resources Management: You can keep track of the start and stop status of your resources. This feature is crucial for understanding the utilization and availability of your application components, ensuring that you can manage your resources efficiently and avoid unnecessary downtimes.​


7. Managing Environments​

1. Creating Additional Environments:

  • From your service dashboard, select "Add New Environment".
  • Follow the same steps as creating the initial environment, choosing the repository, branch, and region

2. Cloning Environment Variables:

  • Kuberns allows you to clone environment variables from one environment to another for consistency.

For more information about managing Environments, follow this link

8. Post Build Configuration​

While the pre-build and post-build files are optional, including them is a good practice as they allow for the execution of custom commands before and after the build process, respectively, enhancing control and flexibility over your application's deployment lifecycle.

For more information about Build Configs, follow this link