Skip to content

Commit a8631e3

Browse files
authored
Update README.md
1 parent 895e8cf commit a8631e3

File tree

1 file changed

+28
-16
lines changed

1 file changed

+28
-16
lines changed

README.md

Lines changed: 28 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -117,7 +117,26 @@ optional arguments:
117117
-oA OUT_FILE Writes output to YAML and JSON file (extensions are added automatically)
118118
```
119119

120-
## Installing dependencies
120+
## Installation
121+
There are multiple ways to install the tool. Either the tool comes as a package with your Linux distribution or you need to do a manual install.
122+
123+
### Automatic Installation
124+
I'm aware of the following Linux distributions which package the tool:
125+
126+
#### Archstrike
127+
128+
```console
129+
$ pacman -S enum4linux-ng
130+
```
131+
132+
#### NixOS
133+
(tested on NixOS 20.9)
134+
135+
```console
136+
$ nix-env -iA nixos.enum4linux-ng
137+
```
138+
### Manual Installation
139+
#### Dependencies
121140
The tool uses the samba clients tools, namely:
122141
- nmblookup
123142
- net
@@ -136,36 +155,29 @@ For a faster processing of YAML (optional!) also install (should come as a depen
136155

137156
Some examples for specific Linux distributions installations are listed below. Alternatively, distribution-agnostic ways (python pip, python virtual env and Docker) are possible.
138157

139-
### Linux distribution specific
158+
#### Linux distribution specific
140159
For all distribution examples below, LibYAML is already a dependency of the corresponding PyYaml package and will be therefore installed automatically.
141-
#### ArchLinux
160+
##### ArchLinux
142161

143162
```console
144163
# pacman -S smbclient python-ldap3 python-yaml impacket
145164
```
146-
#### Fedora/CentOS/RHEL
165+
##### Fedora/CentOS/RHEL
147166
(tested on Fedora Workstation 31)
148167

149168
```console
150169
# dnf install samba-common-tools samba-client python3-ldap3 python3-pyyaml python3-impacket
151170
```
152171

153-
#### Kali Linux/Debian/Ubuntu
172+
##### Kali Linux/Debian/Ubuntu
154173
(tested on Kali Linux 2020.1, recent Debian (e.g. Buster) or Ubuntu versions should work, for Ubuntu 18.04 or below use the Docker or Python virtual environment variant)
155174

156175
```console
157176
# apt install smbclient python3-ldap3 python3-yaml python3-impacket
158177
```
159178

160-
#### NixOS
161-
(tested on NixOS 20.9)
162-
163-
```console
164-
$ nix-env -iA nixos.enum4linux-ng
165-
```
166-
167-
### Linux distribution-agnostic
168-
#### Python pip
179+
#### Linux distribution-agnostic
180+
##### Python pip
169181
Depending on the Linux distribution either `pip3` or `pip` is needed:
170182

171183
```console
@@ -180,7 +192,7 @@ $ pip install -r requirements.txt
180192

181193
Remember you need to still install the samba tools as mentioned above.
182194

183-
#### Python virtual environment
195+
##### Python virtual environment
184196
```console
185197
$ git clone https://github.com/cddmp/enum4linux-ng
186198
$ cd enum4linux-ng
@@ -195,7 +207,7 @@ Then run via:
195207

196208
Remember you need to still install the samba tools as mentioned above. In addition, make sure you run ```source venv/bin/activate``` everytime you spawn a new shell. Otherwise the wrong Python interpreter with the wrong libraries will be used (your system one rather than the virtual environment one).
197209

198-
#### Docker
210+
##### Docker
199211
```console
200212
$ git clone https://github.com/cddmp/enum4linux-ng
201213
$ docker build enum4linux-ng --tag enum4linux-ng

0 commit comments

Comments
 (0)