install detailed

Installing reNgine-ng on Windows/MacOS

This document aims to provide detailed instructions on setting up and running the reNgine-ng on Windows/MacOS.

Tip

If you wish to run reNgine-ng on any Debian Linux (like Ubuntu), there is an installation script that will ease your Docker installation and performs the required setup for you. Consider using it, see Quick Installation. You can skip prerequisites if you are running Ubuntu.

Make sure that all prerequisites are satisfied.

Installation

You can follow the Quick Install reNgine-ng guide

Caution

Please note, while running any make command, you must be inside the rengine/ directory.

Build reNgine-ng

By default rengine-ng images are pre-built, but you can choose to build reNgine-ng, from the install.sh script or by using the following command

sudo make build

The build process is a lengthy process and expected to take some time.

Tip

Thanks to Baptiste MOINE for sending the PR that made build process so much simpler.

Run reNgine-ng

Once the install script is finished with no errors, we're good to run reNgine-ng. At the end of the installation process, reNgine is up

reNgine-ng can now be accessed from https://127.0.0.1, https://your_local_address or if you're on the VPS https://your_vps_ip_address It should be displayed at the end of the install process.

Registering an account

You will need to create a username and password in order to login to the reNgine-ng. To register reNgine-ng, please run the following command

sudo make superuser_create

You will now be prompted with some personal details(optional), username and password. We highly recommend that you set a strong password for reNgine-ng.

You may now login to the reNgine-ng web portal using the username and password that you just provided.

Checking logs

If you need to observe the logs, it can be done so by running the command

sudo make logs

Note

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 advised that you to look for any open issues on Github as well.

Stopping reNgine-ng

If you wish to stop the reNgine-ng, it can be done so by using the command

sudo make stop

Restarting reNgine-ng

If you want to stop and restart reNgine-ng use the command:

• To only stop and restart

  sudo make restart

• To destroy containers and restart (no data will be lost but destroy and recreate a container could help fix bugs or configuration problems (like environment vars update ...)

  sudo make restart COLD=1

Removing all reNgine-ng Data

If you wish to delete all your recon data, it can be done using

Caution

This is a irreversible process and once pruned, you may never get back your recon data. Use with caution.

sudo make prune