forked from Opmantek/open-audit
-
Notifications
You must be signed in to change notification settings - Fork 1
/
readme.txt
60 lines (33 loc) · 3.55 KB
/
readme.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
BACKUP YOUR DATA AND FILES before upgrading, really, please.
There are details at https://community.opmantek.com/display/OA/Home
# Open-AudIT
Open-AudIT is an application to tell you exactly what is on your network, how it is configured and when it changes. Open-AudIT will run on Windows and Linux systems. Open-AudIT is a database of information, that can be queried via a web interface and JSON API. Data about the network is inserted using audit scripts (shell, vbscript) as well as Nmap and SNMP results. The entire application is written in php, bash and vbscript. These are all 'scripting' languages - no compiling and human readable source code. Making changes and customisations is both quick and easy.
Windows PCs can be queried for hardware, software, operating system settings, security settings, IIS settings, services, users & groups and much more. Linux systems can be queried for a similar amount of information. Network devices (printers, switches, routers, etc) can have data recorded such as IP-Address, MAC Address, open ports, serial number, etc, etc.
## Getting Started
These instructions will get you a copy of the project up and running on your local machine for development and testing purposes. See deployment for notes on how to deploy the project on a live system.
### Prerequisites
Nmap is a prerequisite for Open-AudIT. We rely on Nmap for discovering devices on your network. The Linux installer will install this and the other prerequisites. The Windows installer needs the user to manually install Nmap.
The other Linux prerequisites are:
#### RedHat / Centos
mariadb-server httpd php php-cli php-mysqlnd php-ldap php-json php-mbstring php-process php-snmp php-xml nmap zip curl wget sshpass screen samba-client logrotate perl-Time-ParseDate ipmitool rrdtool libpng12
#### Debian / Ubuntu
mariadb-server apache2 apache2-utils libapache2-mod-php openssh-client php php-cli php-curl php-ldap php-mbstring php-mysql php-snmp php-xml nmap zip wget curl sshpass screen smbclient logrotate ipmitool rrdtool libpng12-0 awscli
### Installing
Installing is simply a matter of downloading the .run or .exe (Linux or Windows). The installer is self-contained and will install Linux prerequisites. Windows users will need to download and install Nmap.
To install from this source, please it in /usr/local/open-audit and copy the www folder into your web root under /open-audit. Initialise a MySQL database using the credentials found in code_igniter/application/config/database.php. The MySQL schema can be found in other/open-audit_mysql.sql.
## Built With
* [CodeIgniter](http://www.codeigniter.com/) - The web framework used
* [JsonAPI](http://jsonapi.org/) - API specification
* [jQuery](https://jquery.com/) - Javascript
* [Bootstrap](http://getbootstrap.com/) - Web Frontend
## Contributing
Please contact [Opmantek](https://opmantek.com) with any enquiries for contributing or post to the [Questions](https://community.opmantek.com/questions) site. And you can always submit a pull request on [GitHub](https://github.com/Opmantek/open-audit).
## Versioning
We use [SemVer](http://semver.org/) for versioning. For the versions available, see the [tags on this repository](https://github.com/Opmantek/open-audit/releases).
## Authors
* **Mark Unwin** - *Initial work* - [Mark Unwin](https://github.com/mark-unwin)
## License
This project is licensed under the aGPL License - see the [AGPL 3.0](agpl-3.0.txt) file for details
## Acknowledgments
* Thanks for all the forum contributions.
* Thanks in particular to JPA (forum user) for his countless contributions and testing work.