Files
xamxam/docs
Pontoporeia 0e009c49d4 docs: align deployment/setup docs with current code
- nginx/docs/PRODUCTION_DEPLOYMENT.md: drop stale htpasswd/Basic-auth model,
  manual server-side deploy step, /var/www/posterg paths and hardcoded IP; describe
  the PHP-layer AdminAuth, automated 📋 Deploying nginx configuration…
xamxam.conf

sent 145 bytes  received 125 bytes  540.00 bytes/sec
total size is 10,012  speedup is 37.08
deploy-server.sh

sent 143 bytes  received 113 bytes  512.00 bytes/sec
total size is 8,519  speedup is 33.28, and what deploy-server.sh
  actually does.
- nginx/docs/QUICK_REFERENCE.md: replace htpasswd user management with AdminAuth
  guidance; fix php8.2->php8.4, log paths, admin rate limit (300r/m), socket path.
- nginx/README.md, nginx/SETUP.md: note 📋 Deploying nginx configuration…
xamxam.conf

sent 145 bytes  received 125 bytes  540.00 bytes/sec
total size is 10,012  speedup is 37.08
deploy-server.sh

sent 143 bytes  received 113 bytes  170.67 bytes/sec
total size is 8,519  speedup is 33.28 automates
  deploy-server.sh (no manual ssh/sudo step).
- docs/deployment.md: correct deploy-code scope (code-only, no --chown), fix the
  /var/log/xamxam provisioning step (deploy-server.sh via deploy-nginx, not
  deploy-code), document the setup-server.sh prerequisite and fresh-box caveat.
- README.md: replace the incomplete manual first-time setup snippet with the
  real setup-server.sh + provision-server flow and a fresh-box caveat.
2026-09-18 16:26:49 +02:00
..

Documentation index

docs/ holds current reference documentation describing how the system actually works today. Everything else — proposals, plans, incident reports, analyses, original requirements, one-off helpers — is in archive/.

Note on naming: XAMXAM was previously Post-ERG (code once organised under posterg-website/, apps/, front-backend/, /var/www/posterg/). Historical docs may reference the old layout; the live paths are now app/, app/public/, app/storage/xamxam.db, just dev, PHPUnit, and /var/www/xamxam/ on the server.

Reference docs

Doc Contents
development.md Dev workflow, structure, builds, testing, linting
environment.md Runtime stack, PHP/nginx/DB/Node requirements, server specs
deployment.md Server setup, deploy, backups, rollback
database.md SQLite schema, migrations, tables, common ops
search.md /search and /repertoire behaviour
export.md CSV / DB / files export + full restore procedure
nextcloud-sync.md Off-site SQLite snapshot sync to Nextcloud WebDAV
import.md CSV import format + behaviour
security.md Current security posture
file-uploads.md Upload surfaces, types, storage layout
CSS.md CSS architecture + build

Archive

Non-documentation material (proposals, plans, incident reports, analyses, requirements, one-off helpers) is preserved read-only in archive/ for context. It is not maintained.

  • nginx/docs/ — nginx config, security headers, deployment, HTACCESS→nginx
  • app/storage/README.md — DB quick-reference (schema link)
  • app/public/admin/README.md — admin panel structure

Maintenance guidance: when updating code, update the matching reference doc above. Do not move analysis/proposals into docs/ — put them in archive/.