Skip to content

Commit

Permalink
Update README
Browse files Browse the repository at this point in the history
  • Loading branch information
Tes3awy committed Feb 14, 2024
1 parent a08baf1 commit 9d36e35
Show file tree
Hide file tree
Showing 3 changed files with 7 additions and 30 deletions.
37 changes: 7 additions & 30 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,41 +12,12 @@ This script gives an overview of the hardening techniques that can be used to se

## Installation

### Install from PyPi
> Install from PyPi
```bash
$ pip install ciscoconfaudit
```

Clone repo, create a virtual environment, and install requirements.

### macOS or Linux

```bash
$ git clone https://github.com/Tes3awy/cisco-config-auditor.git
$ cd auditor
$ python3 -m venv .venv --upgrade-deps
$ source .venv/bin/activate .
(.venv) $ python3 -m pip install -r requirements.txt
```

### Windows

> Note On Microsoft Windows, it may be required to enable the `Activate.ps1` script by setting the execution policy for the user.
> You can do this by issuing the following PowerShell command:
> `PS C:> Set-ExecutionPolicy -ExecutionPolicy RemoteSigned -Scope CurrentUser`
> See [About Execution Policies](https://go.microsoft.com/fwlink/?LinkID=135170) for more information.
> In PowerShell
```pwsh
> git clone https://github.com/Tes3awy/cisco-config-auditor.git
> cd auditor
> python -m venv .venv --upgrade-deps
> .venv\Scripts\Activate.ps1 # Check
(.venv) > pip install -r requirements.txt
```

## Usage

You can try out two examples in the repo.
Expand All @@ -56,6 +27,12 @@ You can try out two examples in the repo.
(.venv) $ python3 offline.py # parses config from text file
```

### Example Output

| Global Config Audit (Sample) | Interface-Level Audit |
| -------------------------------------------------------- | ------------------------------------------------------------ |
| ![Global Config Audit](./assets/global-config-audit.jpg) | ![Interface Level Audit](./assets/interface-level-audit.jpg) |

## Credits

This package was inspired by [jonarm](https://github.com/jonarm) from [cisco-ios-audit](https://github.com/jonarm/cisco-ios-audit).
Expand Down
Binary file added assets/global-config-audit.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file added assets/interface-level-audit.jpg
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 9d36e35

Please sign in to comment.