chore(docs): update docs and script comments to use UploadShield name
This commit is contained in:
2
.gitignore
vendored
2
.gitignore
vendored
@@ -1,4 +1,4 @@
|
||||
# Upload Logger repository .gitignore
|
||||
# UploadShield repository .gitignore (formerly "Upload Logger")
|
||||
|
||||
# Runtime logs and quarantine/state directories (do not commit)
|
||||
/logs/
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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 <repo-url> /path/to/upload-logger
|
||||
cd /path/to/upload-logger
|
||||
git clone <repo-url> /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.
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -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
|
||||
|
||||
|
||||
@@ -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
|
||||
{
|
||||
|
||||
@@ -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 <repo-url> /srv/upload-logger
|
||||
cd /srv/upload-logger
|
||||
git clone <repo-url> /srv/uploadshield
|
||||
cd /srv/uploadshield
|
||||
composer install --no-interaction --prefer-dist
|
||||
```
|
||||
|
||||
|
||||
@@ -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/`.
|
||||
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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
|
||||
|
||||
@@ -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)"
|
||||
|
||||
@@ -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)"
|
||||
|
||||
@@ -1,5 +1,5 @@
|
||||
[Unit]
|
||||
Description=Upload Logger provisioning (one-shot)
|
||||
Description=UploadShield provisioning (one-shot)
|
||||
After=network.target
|
||||
|
||||
[Service]
|
||||
|
||||
@@ -1,6 +1,6 @@
|
||||
<?php
|
||||
/**
|
||||
* Global Upload Logger (Hardened v3)
|
||||
* Global Upload Logger (Hardened v3) — part of UploadShield
|
||||
* Project: TheWallpapers
|
||||
*
|
||||
* Purpose:
|
||||
|
||||
Reference in New Issue
Block a user