mirror of https://github.com/CISOfy/lynis.git
Updated documentation
This commit is contained in:
mboelen
parent
13c8de88a6
commit
1775590ba7
12
CONTRIBUTORS
12
CONTRIBUTORS
|
|
@ -1,16 +1,22 @@
|
|||
|
||||
================================================================================
|
||||
|
||||
Lynis - CONTRIBUTIONS
|
||||
Lynis - CONTRIBUTORS
|
||||
|
||||
================================================================================
|
||||
|
||||
The Lynis project is very thankful for the following individuals who
|
||||
contributed to the project. They invested time and effort to report issues
|
||||
and send in related patches to improve the software and other components.
|
||||
contributed to the project.
|
||||
|
||||
================================================================================
|
||||
|
||||
Want to contribute as well? Here are some suggestions:
|
||||
|
||||
- New tests for your favorite daemons
|
||||
- Report (unexpected) screen errors
|
||||
- Missing results
|
||||
- Check for grammar issues
|
||||
|
||||
|
||||
[+] Patches, bug fixes and suggestions
|
||||
------------------------------------------
|
||||
|
|
|
|||
25
FAQ
25
FAQ
|
|
@ -7,9 +7,11 @@
|
|||
|
||||
Author: Michael Boelen (michael.boelen@cisofy.com)
|
||||
Description: Security and system auditing tool
|
||||
Website: https://cisofy.com/lynis/
|
||||
Web site: https://cisofy.com/lynis/
|
||||
GitHub: https://github.com/CISOfy/lynis
|
||||
Support address: lynis-dev@cisofy.com
|
||||
Development: May 2007 - Now
|
||||
Suppor: See README file and https://cisofy.com/support/
|
||||
Support: See README file and https://cisofy.com/support/
|
||||
Documentation: See web site, README, FAQ and CHANGELOG file
|
||||
|
||||
================================================================================
|
||||
|
|
@ -18,9 +20,9 @@
|
|||
-------------------------------
|
||||
|
||||
Q: I don't understand the program (output), what to do?
|
||||
A: Keep reading this FAQ, then continue with reading the README file, followed
|
||||
by the log file (default: /var/log/lynis.log). After those sources, check
|
||||
the documentation on the website.
|
||||
A: Keep reading this FAQ. Also useful are the README file and the log file
|
||||
(default: /var/log/lynis.log). Or check out the documentation on the
|
||||
website: https://cisofy.com/support/
|
||||
|
||||
Q: I can't find any configuration file for Lynis, where is it?
|
||||
A: There isn't one (currently), since all options are available as command
|
||||
|
|
@ -30,11 +32,10 @@
|
|||
|
||||
Q: Why is there no port/package for my operating system?
|
||||
A: Because there is no maintainer for it yet. If you have the time to keep
|
||||
the port/package current for your preferred operating system, fill in the
|
||||
contact form to notify me and confirm no one else is working on it.
|
||||
the port/package current for your preferred operating system, let us know.
|
||||
|
||||
Q: What to do with the report files?
|
||||
A: The output could be used for monitoring (baseline checks). For user of the
|
||||
A: The output could be used for monitoring (baseline checks). For users of the
|
||||
Lynis Enterprise Suite, they will be used to upload data.
|
||||
|
||||
|
||||
|
|
@ -42,7 +43,7 @@
|
|||
[+] Bugs or issues
|
||||
-------------------------------
|
||||
Q: Where can I report an issue or bug?
|
||||
A: Use the developer e-mail address lynis-dev@cisofy.com
|
||||
A: GitHub, or use the developer e-mail address lynis-dev@cisofy.com
|
||||
|
||||
|
||||
|
||||
|
|
@ -72,12 +73,12 @@
|
|||
invoke Lynis (example: bash lynis -c).
|
||||
|
||||
Q: One or more tests are giving incorrect output. How to solve that?
|
||||
A: Check the log file. If that also has incorrect data, fill in the contact
|
||||
form and describe the issue.
|
||||
A: Check the log file. If that also has incorrect data, let us know via GitHub
|
||||
or the developer e-mail address.
|
||||
|
||||
Q: The program takes long to complete and also uses too much resources. Can it
|
||||
be tuned?
|
||||
A: The time it takes to complete is depends on the amount of tests to run.
|
||||
A: The time it takes to complete depends on the amount of tests to run.
|
||||
However the resources it take can be slighty lowered by increasing the
|
||||
pause_between_tests profile option. Keep in mind this increases the total
|
||||
length of the scan to complete.
|
||||
|
|
|
|||
11
README
11
README
|
|
@ -15,11 +15,14 @@
|
|||
================================================================================
|
||||
|
||||
|
||||
== The website contains up-to-date documentation ==
|
||||
*** NOTE ***
|
||||
|
||||
The website contains the latest documentation
|
||||
|
||||
See https://cisofy.com/documentation/lynis/
|
||||
|
||||
|
||||
|
||||
[+] Introduction
|
||||
-------------------------------
|
||||
|
||||
|
|
@ -46,7 +49,7 @@
|
|||
- License: GPL v3
|
||||
- Language: Shell script
|
||||
- Author: Michael Boelen, CISOfy
|
||||
- Website: https://cisofy.com
|
||||
- Web site: https://cisofy.com
|
||||
- Required permissions: root preferred, not needed
|
||||
- Other requirements: write access to /tmp
|
||||
|
||||
|
|
@ -91,8 +94,8 @@
|
|||
-------------------------------
|
||||
|
||||
If you have input to improve Lynis, let us know via:
|
||||
- GitHub - https://github.com/CISOfy/lynis
|
||||
- E-mail - lynis-dev@cisofy.com
|
||||
* GitHub - https://github.com/CISOfy/lynis
|
||||
* E-mail - lynis-dev@cisofy.com
|
||||
|
||||
Contributions are appreciated and can be done via GitHub. See CONTRIBUTIONS.md
|
||||
for more information about how to submit them.
|
||||
|
|
|
|||
Loading…
Reference in New Issue