runv-server

server tooling for runv.club
Log | Files | Refs | README

15-glossary-and-reference.md (1792B)

      1 # Glossário e referência rápida
      2 
      3 [← Índice](README.md)
      4 
      5 ## Glossário
      6 
      7 | Termo | Significado |
      8 |-------|-------------|
      9 | **entre** | Utilizador SSH especial para pedidos de entrada; não cria membros. |
     10 | **Fila** | Directório `/var/lib/runv/entre-queue/` com JSON por pedido. |
     11 | **members.json** | Dataset **público** para a constelação na landing. |
     12 | **users.json** | Metadados **internos** dos membros no servidor. |
     13 | **DocumentRoot** | Raiz Apache onde `genlanding.py` copia `site/public/`. |
     14 | **REPO** | Caminho do clone (ex. `/opt/runv/src`). |
     15 
     16 ## Índice de scripts (principal)
     17 
     18 | Caminho | Descrição curta |
     19 |---------|-----------------|
     20 | `scripts/admin/starthere.py` | Bootstrap APT, Apache, UFW, quotas ext4 |
     21 | `scripts/admin/create_runv_user.py` | Provisionamento canónico de membro |
     22 | `scripts/admin/update_user.py` | Actualizar membro / metadados |
     23 | `scripts/admin/del-user.py` | Remover membro |
     24 | `tools/tools.py` | APT, MOTD, skel, binários locais |
     25 | `site/genlanding.py` | Apache + cópia landing + refresh members; `--sync-public-only` só cópia `public/` + members (sem Apache) |
     26 | `site/build_directory.py` | users.json → members.json público |
     27 | `email/configure_mailgun.py` | Config email Mailgun / legado |
     28 | `terminal/setup_entre.py` | Instalar fluxo `entre` |
     29 | `terminal/entre_app.py` | App ForceCommand |
     30 | `terminal/entre_core.py` | Núcleo validação/fila |
     31 
     32 ## Módulos (pastas)
     33 
     34 - `scripts/admin/` — administração
     35 - `site/` — web estático + geradores
     36 - `tools/` — experiência global Debian
     37 - `email/` — envio
     38 - `terminal/` — SSH entre
     39 - `patches/` — patches auxiliares (ex. IRC)
     40 
     41 ## Mapa de documentação
     42 
     43 - **Canónico:** esta pasta `docs/`.
     44 - **Changelog da reconstrução:** `DOCS_REBUILD_CHANGELOG.md` na raiz.