Detailed Installation Instructions
If you have met all the Prerequisites, you can begin installing reNgine.
- Let's begin by cloning the reNgine.
git clone https://github.com/yogeshojha/rengine
Before we begin installing reNgine, it is necessary to make changes to the dotenv file. You can edit the file using your favourite editor
COMPOSE_PROJECT_NAME=rengine AUTHORITY_NAME=reNgine AUTHORITY_PASSWORD=nSrmNkwT COMPANY=reNgine DOMAIN_NAME=recon.example.com COUNTRY_CODE=US STATE=Georgia CITY=Atlanta POSTGRES_DB=rengine POSTGRES_USER=postgres POSTGRES_PASSWORD=set_db_pass POSTGRES_PORT=5432 POSTGRES_HOST=db
Generating SSL Certificates
reNgine runs on https unless otherwise used for development purpose. Using https is recommended. To generate the certificates you can use
sudo make certs
Please note, while running any
make command, you must be inside the rengine/ directory.
To build the reNgine, use the following command
sudo make build
The build process is a lengthy process and expected to take some time.
Thanks to Baptiste MOINE for sending the PR that made build process so much simpler.
Once the build process is successful, we're good to run reNgine. This can be done using below command
sudo make up
reNgine can now be accessed from https://127.0.0.1 or if you're on the VPS https://your_vps_ip_address
Registering an account
You will need to create a username and password in order to login to the reNgine. To register reNgine, please run the following command
sudo make username
You will now be prompted with some personal details(optional), username and password. We highly recommend that you set a strong password for reNgine.
You may now login to the reNgine web portal using the username and password that you just provided.
If you need to observe the logs, it can be done so by running the commmand
sudo make logs
If you encounter any issues while setup or scan, we advice you to raise an issue in Github and attach the log. While raising any new issues on Github, it is also adviced that you to look for any open issues on Github as well.
Stopping the reNgine
If you wish to stop the reNgine, it can be done so by using the command
sudo make stop
Restarting the reNgine
reNgine can be restarted using the command
sudo make restart
Removing all the reNgine Data
If you wish to delete all your recon data, it can be done using
This is a irreversible process and once pruned, you may never get back your recon data. Use with caution.
sudo make prune