aide: add file integrity monitoring guide - #106
Open
Vairamani-NI wants to merge 1 commit into
Open
Conversation
Vairamani-NI
force-pushed
the
add-aide-docs
branch
from
August 6, 2026 19:05
f4454dd to
8f0eac6
Compare
Collaborator
|
Please update the PR description with an Azdo link. |
There was a problem hiding this comment.
Pull request overview
Adds new NILRT documentation for using AIDE (file integrity monitoring) and links it into the main Tutorials toctree so it appears in the rendered docs.
Changes:
- Add a new user-facing tutorial page describing AIDE installation, baseline creation, scheduled checks, report interpretation, and troubleshooting.
- Wire the new AIDE page into the top-level Tutorials navigation.
Reviewed changes
Copilot reviewed 2 out of 2 changed files in this pull request and generated 2 comments.
| File | Description |
|---|---|
| docs/source/index.rst | Adds the AIDE tutorial page to the Tutorials toctree. |
| docs/source/aide/aide.rst | New AIDE guide covering installation, usage, scheduled checks, and troubleshooting. |
Suppressed comments (1)
docs/source/aide/aide.rst:135
- In a bash code block,
<package>will be treated as shell redirection if copied verbatim. Use a placeholder that can be pasted safely.
opkg install <package>
💡 Add Copilot custom instructions for smarter, more guided reviews. Learn how to get started.
There was a problem hiding this comment.
Pull request overview
Copilot reviewed 2 out of 2 changed files in this pull request and generated 1 comment.
Suppressed comments (3)
docs/source/aide/aide.rst:76
- This command does not open the timestamped report: in a shell,
<timestamp>is parsed as input redirection, socatreceives malformed arguments. Use a command that actually selects the newest report.
cat /var/log/aide/aide-check.<timestamp>.log
docs/source/aide/aide.rst:189
- “Any
opkgoperation” incorrectly includes read-only commands such asopkg listand would tell users to perform an unnecessary 1–3 minute baseline rebuild. Match the earlier scope to package installs and upgrades.
This is expected. Rebuild the baseline after any ``opkg`` operation:
docs/source/aide/aide.rst:135
- In this Bash block,
<package>is interpreted as stdin redirection from a file namedpackage, so the documented command fails if copied. Use a shell-safe placeholder.
opkg install <package>
Add a user-facing guide covering AIDE installation, checking status, reading integrity reports, re-baselining after package installs, scheduled check behaviour, and troubleshooting. Note that AIDE has been available in the NILRT package feed since the 2026 Q4 release and can be installed with opkg. Wire the page into the Tutorials toctree. Signed-off-by: vairamani muthusamy <vairamani.muthusamy@emerson.com>
Vairamani-NI
force-pushed
the
add-aide-docs
branch
from
August 7, 2026 04:40
8f0eac6 to
93c801f
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Summary
Adds a user-facing documentation page for AIDE (Advanced Intrusion Detection Environment) on NILRT, wired into the Tutorials section of the docs.
The guide covers:
opkgNotes
This PR is ready for review but should not be merged until the AIDE feature ships in a NILRT release.
Testing
Built locally with
make -C docs html— build succeeds with no warnings.Justification
AB#4005629