Dependencies

1. System Requirements

CelerBuild is designed for Linux and macOS environments. While Windows is not directly supported, you can use a virtual machine running Linux.

Hardware Requirements

  • CPU:
    • Minimum: 1 core
    • Recommended: 2+ cores (Required for parallel deployments)
  • RAM:
    • Minimum: 1GB
    • Recommended: 2GB+
  • Storage:
    • Minimum: 10GB available space (Actual requirements depend on deployment package sizes, logs, and local database if used)

Virtual Machine Setup for Windows Users

If you're using Windows, you can run CelerBuild by:

  1. Installing a virtual machine software (like VirtualBox or VMware)
  2. Setting up a Linux distribution (Ubuntu 20.04+, CentOS 7+, or Debian 10+)
  3. Allocating at least 2 CPU cores and 2GB RAM to the virtual machine

2. Required for CelerBuild

Install MariaDB

CelerBuild requires MariaDB. If you don't have MariaDB installed, follow these steps:

brew update
brew install mariadb
brew services start mariadb

3. Required for Deployment

Install Git

Required for version control and deployment operations.

Minimum Git version required: 2.25.0 or higher. We recommend using the latest stable version for better performance and security.

# macOS (using Homebrew)
brew install git
 
# CentOS/RHEL
sudo yum install git
 
# Ubuntu/Debian
sudo apt-get install git
 
# Verify installation
git --version

Note:

  • For macOS:
  • If you haven't installed Homebrew, visit brew.sh (opens in a new tab) for installation instructions
  • To upgrade Git: brew upgrade git

Git Upgrade Guide:

For Ubuntu/Debian:

# Add the Git PPA repository
sudo add-apt-repository ppa:git-core/ppa
sudo apt update
sudo apt install git

For CentOS/RHEL:

# Add the WANDisco repository
sudo yum install -y http://opensource.wandisco.com/centos/7/git/x86_64/wandisco-git-release-7-2.noarch.rpm
# Update Git
sudo yum update git

After upgrading, verify your Git version:

git --version

Deploy Public Key

To enable secure, password-less SSH access between CelerBuild and your deployment servers:

  1. Generate an SSH key pair (if you haven't already):
# Ed25519 (Recommended) - Modern, secure, and fast
ssh-keygen -t ed25519
 
# RSA (4096 bit) - Widely compatible
ssh-keygen -t rsa -b 4096
 
# ECDSA - Alternative option
ssh-keygen -t ecdsa -b 521
  1. Copy the public key to your clipboard:
# On macOS:
pbcopy < ~/.ssh/id_ed25519.pub  # If using Ed25519
# or
pbcopy < ~/.ssh/id_rsa.pub      # If using RSA
 
# On Linux:
cat ~/.ssh/id_ed25519.pub | xclip -selection clipboard  # For Ed25519
# or
cat ~/.ssh/id_rsa.pub | xclip -selection clipboard     # For RSA
# Or simply display it:
cat ~/.ssh/id_ed25519.pub  # or id_rsa.pub
  1. Add the public key to remote servers:

Option 1: Using ssh-copy-id (Recommended)

ssh-copy-id -i ~/.ssh/id_ed25519.pub user@remote_server  # For Ed25519
# or
ssh-copy-id -i ~/.ssh/id_rsa.pub user@remote_server      # For RSA

Option 2: Manual setup

# If you have a .pem file, SSH into your remote server using:
ssh -i /path/to/your/key.pem user@remote_server
# Or if you already have SSH access:
ssh user@remote_server
 
# Create .ssh directory and set permissions
mkdir -p ~/.ssh
chmod 700 ~/.ssh
 
# Add your public key to authorized_keys
echo 'your-public-key' >> ~/.ssh/authorized_keys
chmod 600 ~/.ssh/authorized_keys
  1. Test the connection:
ssh user@remote_server

If configured correctly, you should be able to connect without password prompt.

Next Steps

After setting up the dependencies:

  1. Download CelerBuild

  2. Configure Database

PrerequisitesDownload