Skip to main content
Get your application live on Nixopus in just a few steps.

​
Prerequisites

Before you begin, make sure you have:
  • A Nixopus account (sign up here)
  • A GitHub repository with your application code
  • A Dockerfile in your repository (or we’ll help you create one)

​
Step 1: Sign In

Log in to your Nixopus dashboard using your email. We’ll send you a one-time code to verify your identity - no passwords to remember.
1

Enter your email

Go to the login page and enter your email address
2

Check your inbox

You’ll receive a 6-digit verification code
3

Enter the code

Input the code to access your dashboard

​
Step 2: Choose Your Deployment Method

1

Click Connect Repository

From your dashboard, click the Connect Repository button
2

Authorize GitHub

You’ll be redirected to GitHub to authorize Nixopus
3

Select your repository

Choose the repository you want to deploy
4

Configure your project

Set your project name, branch, and build settings
5

Deploy

Click Create Project and watch your application go live

​
Option B: CLI / API Key

1

Generate API Key

From the onboarding screen, click Generate API Key
2

Copy and save

Copy your API key immediately - you won’t be able to see it again
3

Install the CLI

# Install Nixopus CLI
curl -fsSL https://nixopus.com/install.sh | sh
4

Deploy

# From your project directory
nixopus deploy --api-key YOUR_API_KEY

​
Step 3: Configure Your Project

When creating a project, you can configure:
SettingDescriptionDefault
Project NameA unique name for your deploymentRepository name
BranchThe Git branch to deploy frommain
EnvironmentDevelopment, Staging, or Productionproduction
PortThe port your application listens on3000
DomainCustom domain for your applicationAuto-generated

​
Environment Variables

Add environment variables your application needs: 
DATABASE_URL=your-database-connection-string
API_KEY=your-secret-api-key
NODE_ENV=production
Never commit sensitive environment variables to your repository. Always add them through the Nixopus dashboard.

​
Step 4: Monitor Your Deployment

Once deployed, you can:
  • View Logs - See real-time build and application logs (updates automatically)
  • Check Status - Monitor deployment health and uptime
  • Manage Domains - Add custom domains to your project
  • Rollback - Instantly revert to a previous deployment
Deployment status and logs update in real-time using WebSocket connections. You’ll see changes as they happen without refreshing the page.

​
What’s Next?

Add a Custom Domain

Point your own domain to your deployment

Set Up Health Checks

Monitor your application’s availability

Environment Management

Create staging and development environments

View Billing

Manage your subscription and usage

​
Troubleshooting

​
Build Failed

Check that your Dockerfile is in the repository root, or specify the path in your project configuration under Dockerfile Path.

​
Application Not Starting

Verify that:
  1. Your application listens on the port you specified
  2. All required environment variables are set
  3. Your Dockerfile’s CMD or ENTRYPOINT is correct

​
Need Help?

If you’re stuck, check the deployment logs for detailed error messages, or reach out to support.