Quick Installation Guide

Get rengine running in under 5 minutes using our automated installation script. This method is perfect for Ubuntu, Kali Linux, and other Debian-based systems.

Prerequisites

• Operating System: Ubuntu 20.04+ or Kali Linux
• User Privileges: sudo access required
• Network: Stable internet connection

Installation Steps

Step 1: Download and Execute

Run the automated installation script:

curl -fsSL https://raw.githubusercontent.com/yogeshojha/rengine/master/install.sh | bash

The script will automatically:

• Install Docker and Docker Compose
• Download rengine source code
• Build all Docker containers
• Initialize the database
• Create default configuration

Step 2: Wait for Completion

The installation takes 5-10 minutes depending on your internet speed. You’ll see output like:

[INFO] Installing Docker...
[INFO] Installing Docker Compose...
[INFO] Cloning rengine repository...
[INFO] Building Docker containers...
[INFO] Initializing database...
[SUCCESS] rengine installation completed!

Step 3: Access rengine

Once installation completes:

1. Open your web browser
2. Navigate to: http://localhost:8000
3. Log in with default credentials:
   • Username: admin
   • Password: rengine

Verification

Test your installation by checking service status:

cd rengine && docker-compose ps

Expected output:

Name                Command               State           Ports
----------------------------------------------------------------
rengine_web         /app/entrypoint.sh               Up      0.0.0.0:8000->8000/tcp
rengine_celery      celery -A rengine worker         Up
rengine_redis       docker-entrypoint.sh redis      Up      6379/tcp
rengine_postgres    docker-entrypoint.sh postgres   Up      5432/tcp

All services should show “Up” status.

Troubleshooting

Port 8000 Already in Use

sudo lsof -i :8000

If another service is using port 8000, either stop it or modify docker-compose.yml to use a different port.

Docker Permission Denied

sudo usermod -aG docker $USER
# Log out and back in for changes to take effect

Installation Script Fails

Check the installation log for detailed error information:

tail -f /tmp/rengine_install.log

For manual cleanup if needed:

docker system prune -a
rm -rf rengine/

Post-Installation

Change Default Password

1. Log into rengine web interface
2. Go to Settings → Account
3. Update your password
4. Enable two-factor authentication (recommended)

Configure Environment

Edit environment variables if needed:

cd rengine
cp .env.example .env
nano .env

Update rengine

Keep your installation up to date:

cd rengine
git pull origin master
docker-compose build --no-cache
docker-compose up -d

What’s Next?

Now that rengine is installed and running:

1. Configure your first scan target →
2. Set up notifications →
3. Explore advanced features →

Alternative Methods

If the quick installation doesn’t work for your environment:

• Detailed Installation → - Manual step-by-step process
• VPS Deployment → - Cloud deployment guide
• Docker Installation → - Advanced Docker setup

Need help? Check our troubleshooting guide or ask the community.