mirror of
https://codeberg.org/PostERG/xamxam.git
synced 2026-09-25 01:53:03 +02:00
Pontoporeia
fb5e856288
- surface backup/cleanup cron logs + backup freshness status - email xamxam@erg.be when SQLite backups go stale (backup watchdog) - sync SQLite snapshots to Nextcloud WebDAV + remote-freshness watchdog - precise retention pruning, manual sync in check recipe, and Nextcloud-sync docs
79 lines
4.8 KiB
Markdown
79 lines
4.8 KiB
Markdown
# Documentation index
|
|
|
|
This directory mixes **current reference** docs, **proposals/plans**, and
|
|
**historical/archived** analysis. Use this index to find the right document.
|
|
|
|
> **Note on naming:** XAMXAM was previously *Post-ERG* (and the code was once
|
|
> organised under `posterg-website/`, `apps/`, `front-backend/`,
|
|
> `/var/www/posterg/`). References to `posterg`, `apps/public/inc/header.php`,
|
|
> `posterg.db`, `just serve`, `php-live-reload`, `tests/run-tests.php`, etc. in
|
|
> historical docs reflect 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.
|
|
|
|
## Current reference (kept up to date)
|
|
|
|
| Doc | Contents |
|
|
|-----|----------|
|
|
| [development.md](development.md) | Dev workflow, structure, builds, testing, linting |
|
|
| [deployment.md](deployment.md) | Server setup, deploy, backups, rollback |
|
|
| [database.md](database.md) | SQLite schema, migrations, tables, common ops |
|
|
| [search.md](search.md) | `/search` and `/repertoire` behaviour |
|
|
| [export.md](export.md) | CSV / DB / files export + full restore procedure |
|
|
| [nextcloud-sync.md](nextcloud-sync.md) | Off-site SQLite snapshot sync to Nextcloud WebDAV |
|
|
| [import.md](import.md) | CSV import format + behaviour |
|
|
| [security.md](security.md) | Current security posture |
|
|
| [file-uploads.md](file-uploads.md) | Upload surfaces, types, storage layout |
|
|
| [CSS.md](CSS.md) | CSS architecture + build |
|
|
| [bookmarklet.md](bookmarklet.md) | Form auto-fill test helper |
|
|
|
|
## Proposals / plans (proposed, not all implemented)
|
|
|
|
| Doc | Status |
|
|
|-----|--------|
|
|
| [LDAP_AUTH_PLAN.md](LDAP_AUTH_PLAN.md) + [LDAP_SPEC.md](LDAP_SPEC.md) | LDAP login — **not implemented** |
|
|
| [monolog-plan.md](monolog-plan.md) | Single Monolog logger replacing AppLogger/AdminLogger/ErrorHandler/Audit — **plan** |
|
|
| [de-librairisation.md](de-librairisation.md) | Replace bespoke SMTP/Markdown/HTTP/crypto with libraries (partly done) |
|
|
| [refactoring.md](refactoring.md) | Older refactoring proposal |
|
|
| [ANALYSIS_STRUCTURE_REORG.md](ANALYSIS_STRUCTURE_REORG.md) | Proposed structure reorg |
|
|
| [ANALYSIS_INLINE_JS_CSS_MINIFY.md](ANALYSIS_INLINE_JS_CSS_MINIFY.md) | Inline JS/CSS/minify analysis (largely actioned by the build system) |
|
|
| [backup-plan.md](backup-plan.md) | Backup plan — largely implemented (see deployment.md) |
|
|
| [repertoire-mobile-propositions.md](repertoire-mobile-propositions.md) | Mobile repertoire UI proposals |
|
|
| [cms-migration-plan.html](cms-migration-plan.html) | CMS migration plan |
|
|
| [spec-sheet.md](spec-sheet.md) | Original requirements fiche technique |
|
|
| `Proposition procédure licences_V2.pdf` | Licence procedure proposal (filename contains non-ASCII/combining chars) |
|
|
|
|
## Historical / archived (kept for context — may reference the old codebase)
|
|
|
|
| Doc | Contents |
|
|
|-----|----------|
|
|
| [LIVRAISONS_PAR_MOIS.md](LIVRAISONS_PAR_MOIS.md) | Monthly delivery log grouped by functional family |
|
|
| [migration-history.md](migration-history.md) | History of major structural migrations |
|
|
| [CURRENT_ISSUES.md](CURRENT_ISSUES.md) | Issue log (2026-05-10) — many since resolved |
|
|
| [IMMEDIATE_FIX.md](IMMEDIATE_FIX.md) | One-off fix note |
|
|
| [EVIDENCE_SUMMARY.md](EVIDENCE_SUMMARY.md) + [VM_Crash_*.md](VM_Crash_Analysis_FINAL.md) | VM crash investigation (concluded: not the app) |
|
|
| [css.md](css.md) | Old Bulma-removal writeup (pre-dates current build system; see CSS.md) |
|
|
| [php-vs-flask.md](php-vs-flask.md) | Language choice decision |
|
|
| [orm-assessment.md](orm-assessment.md) | ORM evaluation |
|
|
| [system-setup.md](system-setup.md) | Old setup notes |
|
|
| [SETUP.md](SETUP.md), [SPECS.md](SPECS.md), [TODO.md](TODO.md) | Earlier setup/spec/todo snapshots |
|
|
| [SMTP_550_POSTFIX_FIX.md](SMTP_550_POSTFIX_FIX.md) | SMTP troubleshooting record |
|
|
| [testing.md](testing.md) | PHP testing best-practices writeup |
|
|
| [test-plan.md](test-plan.md) | Manual test plan |
|
|
| [autosave-system.md](autosave-system.md), [filepond-crash-analysis.md](filepond-crash-analysis.md), [filepond-race-investigation.md](filepond-race-investigation.md) | Feature/issue deep-dives (status noted in each file) |
|
|
| [pi-session-2026-05-10T*.html](pi-session-2026-05-10T18-42-37-234Z_019e1332-ce31-70fa-87a1-aa3495b526a9.html) | Captured session log |
|
|
| [ANALYSIS_INLINE_JS_CSS_MINIFY.md](ANALYSIS_INLINE_JS_CSS_MINIFY.md) | *(see proposals)* |
|
|
| [bookmarklet.md](bookmarklet.md) | *(kept current — see above)* |
|
|
|
|
## Related documentation elsewhere
|
|
|
|
- `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 *current
|
|
reference* doc in the table above. Leave *historical* docs untouched (they are
|
|
read-only context). Move newly-written analysis into the appropriate section.
|