phpman.config.php.example

<?php
// phpMan configuration — copy to phpman.config.php and adjust.
// Created automatically by install.sh or `make staging` / `make release`.
//
// This file lives in ~/.phpman/ (PHPMAN_HOME), NOT in webroot.
// The webroot only needs a minimal phpman.config.php with one line:
//   define('PHPMAN_HOME', '/home/user/.phpman');
//
// === Minimal config (everything else uses defaults) ===
//   define('PHPMAN_HOME', getenv('HOME') . '/.phpman');
//   define('PHPMAN_BASE_URL', 'https://www.example.com/phpMan.php');
//
// Leave values commented to use defaults in src/config.php.

// --- PHPMAN_HOME ---
// Base directory for all phpMan local data (cache DB, logs, backups).
// PHPMAN_HOME is baked into phpMan.php at deploy time (sed-replaced like
// GIT_DESCRIBE). Uncomment below only if you need to override the baked-in
// value (rare — usually only for staging with ~/.phpman_test).
// define('PHPMAN_HOME', getenv('HOME') . '/.phpman');
// define('PHPMAN_HOME', getenv('HOME') . '/.phpman_test');
// Or override individual paths:
// define('PHPMAN_CACHE_DIR', '/path/to/custom/cache');
// define('PHPMAN_LOG_DIR', '/path/to/custom/logs');
// define('PHPMAN_BACKUP_DIR', '/path/to/custom/backups');

// --- Base URL (v4.3.3) ---
// Public web URL of this phpMan instance. Used by CLI scripts (build-index,
// build-sitemap) to generate correct links when running offline.
// Default: PHPMAN_BASE_URL env var, then 'http://localhost:8080/phpMan.php'
// define('PHPMAN_BASE_URL', 'https://www.chedong.com/phpMan.php');

// --- JSON / MCP payload size (v4.11) ---
// Section text kept when serialising a page. Very large pages (info py is
// ~19.5MB of text) would otherwise be held in memory in full just to be
// serialised, which exceeds PHP's memory_limit. Text past the budget is
// dropped, and the payload then carries content_truncated/content_bytes/
// content_lines so consumers can tell how much of each section they got.
// define('PHPMAN_JSON_MAX_CONTENT_BYTES', 1048576);  // total (1MB)
// define('PHPMAN_JSON_MAX_SECTION_BYTES', 524288);   // per section (512KB)

// --- Cache TTL (v4.11) ---
// Unified expiry for PageCache found entries and the TLDR cache, in months
// (1 month = 30 days). not_found entries always expire after 1 day; emoji-
// enhanced output never expires regardless of this setting.
// define('PHPMAN_CACHE_TTL_MONTHS', 7);  // 7 months = 210 days

// --- Render subprocess timeout (#248) ---
// Upper bound, in seconds, on every document-render subprocess: man, perldoc,
// pydoc3, ri, info, apropos (see src/exec.php). Without it a single request can
// hold a FastCGI slot for as long as the command runs — production has measured
// 36-second renders whose response body was 34 bytes, and a few of those
// concurrently saturate the mod_fcgid pool so everyone else gets 503.
//
// 15s is chosen to cut the pathological tail without touching working paths:
// `pydoc3 -k` (the pydoc search fallback) measures 9.5s by itself, and mf
// telemetry puts the p50 render at 799ms and the p99 at 4.1s.
//
// Needs timeout(1) from GNU coreutils; if it is not on the host (macOS does not
// ship it), the bound is silently skipped and commands run unbounded as before.
// 0 = no limit.
// define('PHPMAN_CMD_TIMEOUT', 15);

// --- Google Analytics (v4.4.4+) ---
// Set your GA4 measurement ID to enable pageview tracking.
// Leave empty to disable (default).
// define('PHPMAN_GA_ID', 'G-XXXXXXXXXX');

// --- Google AdSense (v4.9.26+) ---
// Set your AdSense publisher ID to load the adsbygoogle.js loader script.
// Leave empty to disable (default).
//
// NOTE: this only injects the loader — phpman ships no
// <ins class="adsbygoogle"> ad units. Ads therefore appear only if Auto Ads
// is enabled for the site in the AdSense console. Enabling this also widens
// the CSP automatically (script-src / connect-src / frame-src), so no CSP
// edit is needed. Do not set this on staging: serving ads from a test host
// counts as invalid traffic.
//
// Use the ca-pub-... form here — that is what the loader's client= param
// expects. ads.txt uses the bare pub-... form, without the ca- prefix.
// define('PHPMAN_ADSENSE_ID', 'ca-pub-XXXXXXXXXXXXXXXX');

// --- MCP Authentication (#97) ---
// Every POST /mcp request must carry this key in the X-Api-Key header.
// Fail-closed: while it is left empty (the default) the endpoint returns 401
// for every request, so set it to use MCP at all. A random 32-char hex value
// is generated by install.sh; `openssl rand -hex 16` makes one by hand.
// define('MCP_API_KEY', 'your-secret-key-here');

// --- Debug ---
// Set true for development/troubleshooting; false for production.
// define('PHPMAN_DEBUG', false);