DocsGetting Started

Getting Started

Everything you need to set up NiveeHub and push your first commit.

Installation

NiveeHub is available as a Docker-based self-hosted deployment.

Prerequisites

  • Docker Engine 20.10+
  • Docker Compose v2+
  • A server with a public IP or domain

Clone and start

bash
# Clone the repository
git clone https://github.com/niveel/niveehub.git
cd niveehub

# Copy environment template
cp .env.example .env

# Edit configuration
nano .env

# Start all services
docker compose up -d

Create an account

Once the server is running, open your browser and navigate to your NiveeHub URL.

  1. Navigate to https://your-domain/register
  2. Enter a username (lowercase letters, digits, hyphens)
  3. Provide a valid email address
  4. Create a strong password (minimum 8 characters)
  5. Check your email and click the verification link

Create your first repository

After logging in, navigate to your dashboard and create a repository.

  1. Click New Repository in the dashboard
  2. Enter a repository name
  3. Choose visibility: Public or Private
  4. Optionally add a description
  5. Click Create repository

Clone and push code

Use standard Git commands with either HTTPS or SSH.

Clone over HTTPS

bash
git clone https://niveehub.com/username/repo-name.git
cd repo-name

Push an existing repository

bash
cd my-existing-project

# Add remote
git remote add origin https://niveehub.com/username/repo-name.git

# Push to main branch
git branch -M main
git push -u origin main

Clone over SSH (after adding SSH key)

bash
git clone git@niveehub.com:username/repo-name.git

Next steps