Skip to content

Update README.md #4

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

Update README.md #4

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
10 changes: 5 additions & 5 deletions README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -24,7 +24,7 @@ IntRec-Pack is a Bash script designed to download, install and deploy several qu
+-----------------------+-------------------------------------------+
```

Furthermore I have included functionality within the Bash script that allows the user to easily pull up two web based resources(Three as of update 1.2.1) Namely [OSINT-Framework](http://osintframework.com) and [HoneyDB](http://riskdiscovery.com/honeydb). The former serves as a curated list of open source intelligence tools, websites and related materials for use as a reference guide. While the latter is an OSINT aggregative threat intelligence pool that collects and organizes data provided by [HoneyPy](https://github.com/foospidy/HoneyPy) honeypots. My [Command Line Interface](https://github.com/NullArray/Mimir) for which is included in the selection of tools available for download with IntRec-Pack as well.
Furthermore, I have included functionality within the Bash script that allows the user to easily pull up two web based resources(Three as of update 1.2.1) Namely [OSINT-Framework](http://osintframework.com) and [HoneyDB](http://riskdiscovery.com/honeydb). The former serves as a curated list of open source intelligence tools, websites and related materials for use as a reference guide. While the latter is an OSINT aggregative threat intelligence pool that collects and organizes data provided by [HoneyPy](https://github.com/foospidy/HoneyPy) honeypots. My [Command Line Interface](https://github.com/NullArray/Mimir) for which is included in the selection of tools available for download with IntRec-Pack as well.

## Usage

Expand All @@ -35,15 +35,15 @@ git clone https://github.com/NullArray/IntRec-Pack.git
cd IntRec-Pack
chmod +x intrec.sh
```
After which it can be started from the command line with `sudo ./intrec.sh`. Upon doing so you will be presented with a menu the options for which are as follows:
After which, it can be started from the command line with `sudo ./intrec.sh`. Upon doing so you will be presented with a menu the options for which are as follows:

```
1) Help 4) Specify Install Location
2) List and Install 5) Online Resources
3) Install All 6) Quit
```

The **`help`** option displays further usage information and general details about the tool. **`List and Install`** will list all the tools available for download/installation and lets you select the ones you would like. Upon doing so the tool plus it's dependencies will be installed in the current working directory. Unless the **`Specify Install Location`** option has been used to provide a path to a custom location. **`Install All`** will download and install all the tools available with this script and **`Online Resources`** will open the web applications previously mentioned.
The **`help`** option displays further usage information and general details about the tool. **`List and Install`** will lists all the tools available for download/installation and lets you select the ones you would like. Upon doing so the tool plus it's dependencies will be installed in the current working directory. Unless the **`Specify Install Location`** option has been used to provide a path to a custom location. **`Install All`** will download and install all the tools available with this script and **`Online Resources`** will open the web applications previously mentioned.

## Update

Expand All @@ -62,13 +62,13 @@ Each installation operation now has its own function in order to make the script

Additional checks have been added to the script in order to look for the presence of utilities such as `wget`, `git` and `pip`. This is important because some distros such as Debian and Devuan do not come with some of these utilities installed by default. Should the script find any of these utilities are missing it will attempt to automatically resolve the issue. Making the script effective and compatible with most Debian based distros.

From now on IntRec-Pack will check to see if it has been started with super user privilege. Since there are a lot of `sudo` commands in the script this will prevent the user from running into trouble halfway through the execution.
From now on IntRec-Pack will check to see if it has been started with super user privilege. Since, there are a lot of `sudo` commands in the script this will prevent the user from running into trouble halfway through the execution.

Special thanks to [Chandrapal](https://github.com/Chan9390) for his contributions to the tool.

### Note

Since the **`Online Resources`** feature employs functionality derived from Python, Selenium and the Mozilla Geckodriver, I have added some logic to the script that will automatically install the proper version of each component(Selenium and Geckodriver) needed in order for the script to function as it should.
Since, the **`Online Resources`** feature employs functionality derived from Python, Selenium and the Mozilla Geckodriver, I have added some logics to the script that will automatically install the proper version of each component(Selenium and Geckodriver) needed in order for the script to function as it should.

While this functionality has been tested and the script is designed to automate as much as possible for ease of use. Should you find you have any issues or perhaps encounter a bug please feel free to [Open a Ticket](https://github.com/NullArray/IntRec-Pack/issues) or [Submit a Pull Request](https://github.com/NullArray/IntRec-Pack/pulls)

Expand Down