Quick Install reNgine on Ubuntu¶

Clone reNgine
```
git clone https://github.com/yogeshojha/rengine && cd rengine
```
Attention

please make sure to change the password for postgresql POSTGRES_PASSWORD !
Edit the dotenv file using nano .env or vi .env or vim .env.

Sample .env file
```
#
# General
#
COMPOSE_PROJECT_NAME=rengine

#
# SSL specific configuration
#
AUTHORITY_NAME=reNgine
AUTHORITY_PASSWORD=nSrmNkwT
COMPANY=reNgine
DOMAIN_NAME=recon.example.com
COUNTRY_CODE=US
STATE=Georgia
CITY=Atlanta

#
# Database configurations
#
POSTGRES_DB=rengine
POSTGRES_USER=rengine
POSTGRES_PASSWORD=hE2a5@K&9nEY1fzgA6X
POSTGRES_PORT=5432
POSTGRES_HOST=db

#
# Celery CONCURRENCY Autoscaling
# The number of CONCURRENCY defines how many scans will run in parallel
# Please always keep minimum of 5
#
MIN_CONCURRENCY=5
MAX_CONCURRENCY=30
```
.env Explained¶
- COMPOSE_PROJECT_NAME: This will help reNgine name docker containers as rengine_web_1, rengine_celery_1 etc. (Making changes is Optional)
- AUTHORITY_NAME: SSL Authority Name
- AUTHORITY_PASSWORD: SSL Authority Password
- COMPANY: Company Name to generate SSL to
- DOMAIN_NAME: Domain where reNgine is going to be installed
- COUNTRY_CODE, STATE, CITY: SSL Speciffc
- POSTGRES_DB: DB name for Postgres (Making changes is Optional)
- POSTGRES_USER: Postgres Username for DB auth purpose (Making changes is Optional)
- POSTGRES_PASSWORD: Postgres Password for DB auth purpose (Please change the default Postgres Password)
- POSTGRES_PORT: Postgres Port (Making changes is Optional)
- POSTGRES_HOST: Postgres HOST (Making changes is Optional)
- MIN_CONCURRENCY: Minimum number of Concurrency for Celery.
- MAX_CONCURRENCY: Maximum number of Concurrency for Celery. This determines how many maximum number of scans to run in parallel.
Determining CONCURRENCY Values¶

Here is the ideal value for MIN_CONCURRENCY and MAX_CONCURRENCY depending on the number of RAM your machine has:
- 4GB: MAX_CONCURRENCY=10
- 8GB: MAX_CONCURRENCY=30
- 16GB: MAX_CONCURRENCY=50
This is just an ideal value which developers have tested and tried out and works! But feel free to play around with the values.

Maximum number of scans is determined by various factors, your network bandwith, RAM, number of CPUs available. etc
Run the installation script, Please keep an eye for any prompt, you will also be asked for username and password for reNgine UI.
```
sudo ./install.sh
```
if ./install.sh does not have install permission, please add executable permission, chmod +x install.sh
You will be asked to create account for reNgine, please choose a strong password.

reNgine can now be accessed from https://127.0.0.1 or if you're on the VPS https://your_vps_ip_address

Quick Install reNgine on Ubuntu¶

.env Explained¶

Determining CONCURRENCY Values¶