Skip to content
This repository was archived by the owner on Sep 25, 2025. It is now read-only.

Commit 32ceda7

Browse files
authored
standardizing header formatting
1 parent 5768a43 commit 32ceda7

File tree

1 file changed

+7
-6
lines changed

1 file changed

+7
-6
lines changed

README.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
`Approved for open-source release via C21099 / C22007 as rhelhostinfo v1.x, authored by Skip McGee`
22

3-
# Abstract:
3+
## Abstract:
44
<pre>
55
rhelhostinfo v1.X adds some functionality to the existing rhelhostinfo project by enumerating host configuration information and
66
identifying changes over time. It provides a framework that allows organizations to modify the application
@@ -11,7 +11,7 @@ conduct limited packet capture and identify relevant network information. It use
1111
to enumerate security-relevant information about the host and the surrounding network and report relevant changes.
1212
</pre>
1313

14-
# Objective
14+
## Objective
1515
<pre>
1616
rhelhostinfo primarily provides passive host inventory and change detection via the --checkconfig option
1717
and active host inventory and change detection on an IPv4 /24 network segment via the --scan option.
@@ -23,7 +23,7 @@ tailoring to needs and desires as appropriate. Finally, the data generated by th
2323
to an enterprise log server for parsing, alerting, reporting and display.
2424
</pre>
2525

26-
# Requirements
26+
## Requirements
2727
<pre>
2828
1. The syslog client (rsyslog / syslog-ng) is configured and functional on your RHEL host
2929
2. If use of the openscap functionality is desired, use the openscap guide at:
@@ -35,7 +35,7 @@ Substitute in your organization's name for the profile variables in app/openscap
3535

3636
## Useage:
3737
1. Use the latest rpm artifact to the [workflow](https://github.com/lanl/rhelhostinfo/actions/workflows/rpmbuild.yml) or fork this repo and build your own rpm!
38-
2. Install the rpm 'rpm -Uvh <path_to_rpm>'
38+
2. Install the rpm `rpm -Uvh <path_to_rpm>`
3939
3. To run via the installed rpm:
4040
`rhelhostinfo --help`
4141
<pre>
@@ -110,6 +110,7 @@ optional arguments:
110110
│   └── rhel8-no-gui-tailoring.xml
111111
└──Software_Bill_of_Materials.md
112112
</pre>
113+
113114
2. To run natively in python3:
114115
+ `yum install rh-python38`
115116
+ `python3 -m venv venv`
@@ -119,8 +120,8 @@ optional arguments:
119120
+ `python3 main.py <option>`
120121

121122
## Additional resources and references:
122-
+ openscap project: ``https://www.open-scap.org/``
123-
+ lynis: ``https://cisofy.com/lynis/``
123+
+ [openscap project](https://www.open-scap.org/)
124+
+ [lynis](https://cisofy.com/lynis/)
124125

125126
## Still to do / functionality to add:
126127
1. Consider scapy for limited packet capture / scripting options?

0 commit comments

Comments
 (0)