From d1310e08449eedb4f4000fe75be44431d8f48fea Mon Sep 17 00:00:00 2001 From: Gregor Klevze Date: Thu, 12 Feb 2026 10:47:32 +0100 Subject: [PATCH] chore(docs): update docs and script comments to use UploadShield name --- .gitignore | 2 +- CONFIG_REFERENCE.md | 2 +- CONTRIBUTING.md | 6 +++--- INTEGRATION.md | 2 +- README.md | 2 +- core/Config.php | 2 +- docs/INSTALLATION.md | 6 +++--- docs/release-checklist.md | 4 ++-- scripts/ansible/provision-full.yml | 2 +- scripts/ansible/upload-logger-provision.yml | 2 +- scripts/deploy_provision.sh | 2 +- scripts/provision_dirs.sh | 2 +- scripts/systemd/upload-logger-provision.service | 2 +- upload-logger.php | 2 +- 14 files changed, 19 insertions(+), 19 deletions(-) diff --git a/.gitignore b/.gitignore index 1f848ec..c54437a 100644 --- a/.gitignore +++ b/.gitignore @@ -1,4 +1,4 @@ -# Upload Logger repository .gitignore +# UploadShield repository .gitignore (formerly "Upload Logger") # Runtime logs and quarantine/state directories (do not commit) /logs/ diff --git a/CONFIG_REFERENCE.md b/CONFIG_REFERENCE.md index b176034..9746323 100644 --- a/CONFIG_REFERENCE.md +++ b/CONFIG_REFERENCE.md @@ -1,6 +1,6 @@ # Configuration Reference -This file maps the top-level configuration keys used by `upload-logger.json` to their effect and defaults. Use absolute paths in production where possible. +This file maps the top-level configuration keys used by `upload-logger.json` (UploadShield) to their effect and defaults. Use absolute paths in production where possible. ## Top-level sections diff --git a/CONTRIBUTING.md b/CONTRIBUTING.md index 6ad0398..83e9751 100644 --- a/CONTRIBUTING.md +++ b/CONTRIBUTING.md @@ -7,8 +7,8 @@ Thanks for contributing! This document explains how to run tests, linting, and t 1. Install dependencies (developer machine): ```bash -git clone /path/to/upload-logger -cd /path/to/upload-logger +git clone /path/to/uploadshield +cd /path/to/uploadshield composer install --no-interaction --prefer-dist ``` @@ -72,4 +72,4 @@ php -S 127.0.0.1:8000 -t tests/smoke/public -d auto_prepend_file=$(pwd)/upload-l - Open an issue or a PR on GitHub; maintainers will review and respond. -Thank you for helping improve Upload Logger. +Thank you for helping improve UploadShield. diff --git a/INTEGRATION.md b/INTEGRATION.md index 1830cbc..db40681 100644 --- a/INTEGRATION.md +++ b/INTEGRATION.md @@ -2,7 +2,7 @@ This document complements the installation steps in [docs/INSTALLATION.md](docs/INSTALLATION.md) by focusing on detector tuning, allowlists, and advanced integrations (log forwarding, Fail2Ban, etc.). -Example `upload-logger.json` (simplified): +Example `upload-logger.json` (simplified) for UploadShield: ```json { diff --git a/README.md b/README.md index bbcf1dd..29d9035 100644 --- a/README.md +++ b/README.md @@ -70,7 +70,7 @@ Support & changes - For changes, edit configuration variables at the top of `upload-logger.php` or adapt detection helpers as needed. --- -Generated for upload-logger.php (v3). +Generated for upload-logger.php (UploadShield v3). ## Additional documentation diff --git a/core/Config.php b/core/Config.php index 41b75c8..d50eb2a 100644 --- a/core/Config.php +++ b/core/Config.php @@ -5,7 +5,7 @@ declare(strict_types=1); namespace UploadLogger\Core; /** - * Simple immutable configuration holder for the upload logger. + * Simple immutable configuration holder for UploadShield (upload-logger.json). */ final class Config { diff --git a/docs/INSTALLATION.md b/docs/INSTALLATION.md index 12a5df7..0455a8a 100644 --- a/docs/INSTALLATION.md +++ b/docs/INSTALLATION.md @@ -1,6 +1,6 @@ # Installation & Production Deployment Guide -This guide shows a minimal, secure installation and rollout path for `upload-logger.php`. +This guide shows a minimal, secure installation and rollout path for UploadShield's primary script (`upload-logger.php`). Follow these steps in a staging environment first; do not enable blocking until detectors are tuned. **Prerequisites** @@ -19,8 +19,8 @@ Follow these steps in a staging environment first; do not enable blocking until - Clone the repository and install dev deps (for tests/static analysis): ```bash -git clone /srv/upload-logger -cd /srv/upload-logger +git clone /srv/uploadshield +cd /srv/uploadshield composer install --no-interaction --prefer-dist ``` diff --git a/docs/release-checklist.md b/docs/release-checklist.md index 95f7bfb..1016741 100644 --- a/docs/release-checklist.md +++ b/docs/release-checklist.md @@ -1,6 +1,6 @@ # Release & Deploy Checklist -This checklist helps you deploy `upload-logger.php` to production safely. +This checklist helps you deploy UploadShield's primary script (`upload-logger.php`) to production safely. ## Pre-release @@ -37,7 +37,7 @@ This checklist helps you deploy `upload-logger.php` to production safely. ## Deployment -- [ ] Ensure `php_admin_value[auto_prepend_file]` is configured in the site pool for PHP-FPM to include `upload-logger.php`. +- [ ] Ensure `php_admin_value[auto_prepend_file]` is configured in the site pool for PHP-FPM to include `upload-logger.php` (UploadShield). - [ ] Reload or restart PHP-FPM gracefully after changing pool settings. - [ ] Verify the web server denies direct access to `logs/` and `quarantine/`. diff --git a/scripts/ansible/provision-full.yml b/scripts/ansible/provision-full.yml index 2913d6d..01a3b2f 100644 --- a/scripts/ansible/provision-full.yml +++ b/scripts/ansible/provision-full.yml @@ -1,5 +1,5 @@ --- -# Full Ansible playbook to provision upload-logger directories, permissions, tmpfiles and logrotate. +# Full Ansible playbook to provision UploadShield directories, permissions, tmpfiles and logrotate. # Usage: ansible-playbook -i inventory scripts/ansible/provision-full.yml - hosts: web diff --git a/scripts/ansible/upload-logger-provision.yml b/scripts/ansible/upload-logger-provision.yml index 527426a..d04df3b 100644 --- a/scripts/ansible/upload-logger-provision.yml +++ b/scripts/ansible/upload-logger-provision.yml @@ -1,5 +1,5 @@ --- -# Ansible playbook snippet to provision upload-logger directories and permissions. +# Ansible playbook snippet to provision UploadShield directories and permissions. # Usage: ansible-playbook -i inventory scripts/ansible/upload-logger-provision.yml - hosts: web diff --git a/scripts/deploy_provision.sh b/scripts/deploy_provision.sh index 6fc8ca7..e593599 100644 --- a/scripts/deploy_provision.sh +++ b/scripts/deploy_provision.sh @@ -1,5 +1,5 @@ #!/usr/bin/env bash -# Wrapper to provision upload-logger directories using Ansible if available, +# Wrapper to provision UploadShield directories using Ansible if available, # otherwise falling back to the included provision_dirs.sh script. set -euo pipefail ROOT_DIR="$(cd "$(dirname "$0")/.." && pwd)" diff --git a/scripts/provision_dirs.sh b/scripts/provision_dirs.sh index 5bd7352..35e4004 100644 --- a/scripts/provision_dirs.sh +++ b/scripts/provision_dirs.sh @@ -1,6 +1,6 @@ #!/usr/bin/env bash set -euo pipefail -# Provision quarantine and state directories for upload-logger +# Provision quarantine and state directories for UploadShield (upload-logger.php) # Usage: sudo ./provision_dirs.sh [--config path/to/upload-logger.json] ROOT_DIR="$(cd "$(dirname "$0")/.." && pwd)" diff --git a/scripts/systemd/upload-logger-provision.service b/scripts/systemd/upload-logger-provision.service index e943374..7d5d455 100644 --- a/scripts/systemd/upload-logger-provision.service +++ b/scripts/systemd/upload-logger-provision.service @@ -1,5 +1,5 @@ [Unit] -Description=Upload Logger provisioning (one-shot) +Description=UploadShield provisioning (one-shot) After=network.target [Service] diff --git a/upload-logger.php b/upload-logger.php index 69f396d..8c4f3a7 100644 --- a/upload-logger.php +++ b/upload-logger.php @@ -1,6 +1,6 @@