Skip to content

docs: update and polish #9

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Merged
minademian merged 1 commit into from
Nov 2, 2025
Merged

docs: update and polish #9

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 3 additions & 3 deletions diff-check/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,9 +1,9 @@
# diff-check - Git-to-deployment diff analyzer
# diff-check

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
![Version](https://img.shields.io/badge/version-1.0.0--alpha-blue)
![License](https://img.shields.io/badge/license-MIT-green)

A secure, production-ready tool for comparing deployed application files against a Git repository branch to detect differences. Generates detailed reports of added, modified, and deleted files with support for binary artifact detection, multiple output formats, and comprehensive validation.
A Git repository vs. file system diff analyzer.

## Table of Contents

Expand Down
30 changes: 3 additions & 27 deletions server-audit/README.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,16 +1,14 @@
![Flygtaxi Logo](docs/assets/images/logo.svg)

# Server Audit Tool
# `server-audit`

[![License](https://img.shields.io/badge/license-MIT-blue.svg)](LICENSE)
![Version](https://img.shields.io/badge/version-1.0.0--alpha-blue)
![Coverage](https://img.shields.io/badge/coverage-47.0%25-red)

A secure, modular server auditing tool for extensible binary checking.
Requires explicit specification of which checkers to run via the `--check` flag for precise control.
Currently supports Java, Tomcat, and Apache detection with pluggable architecture for easy extension.
Supports multiple Tomcat instances per server across standard installation paths: `/usr/local`, `/usr/share`, and `/opt`.

## Directory Structure

## Table of Contents

- [Usage](#usage)
Expand Down Expand Up @@ -210,18 +208,6 @@ server-audit/
└── run_tests.sh # Complete test suite runner
```

## Security Features

- ✅ Command injection prevention
- ✅ SSH key validation and permission checks
- ✅ Secure temporary file handling
- ✅ Strict error handling (`set -euo pipefail`)
- ✅ Input validation and sanitization
- ✅ Configurable connection limits
- ✅ Proper signal handling and cleanup

📋 **For version history and breaking changes, see [CHANGELOG.md](CHANGELOG.md)**

## Strategy Pattern Architecture

The tool uses the Strategy pattern for maximum extensibility and maintainability with dynamic checker loading:
Expand Down Expand Up @@ -338,16 +324,6 @@ Without `fswatch`, the watch mode uses a lightweight polling fallback that check
- `test_service_detection.sh` - Binary detection across different scenarios
- `test_documentation.sh` - Help and documentation accuracy

## Benefits of Modular Structure

1. **Maintainability**: Each module has a single responsibility
2. **Testability**: Individual functions can be tested in isolation with comprehensive test coverage
3. **Readability**: Main script is concise and focused
4. **Reusability**: Helper functions can be used by other scripts
5. **Debugging**: Easier to locate and fix issues in specific modules
6. **Explicit Control**: --check flag prevents accidental execution and ensures intentional checker selection
7. **Performance**: Only requested checkers are loaded and executed

## Troubleshooting

### Common Issues
Expand Down