How globaleaks/globaleaks-whistleblowing-software works
Project type and purpose
• GlobaLeaks is a full-stack, open-source whistleblowing platform.
• It consists of a Python/Twisted-based backend providing REST and web-socket endpoints, an Angular-based Single Page Application (SPA) frontend (“client”), a relational database with migration support, plus external integrations (mail, Let’s Encrypt, Tor).
File structure
• Top-level “backend” directory: Python code, REST handlers, jobs, database migrations, configuration, ORM, services, utilities, tests, CLI scripts.
• Top-level “client” directory: Angular application with assets, components, pages per user‐role (admin, analyst, custodian, recipient, whistleblower), shared modules, services, styles, E2E tests (Cypress).
• Infrastructure files: docker/, debian/, scripts/, CI workflows (.github/workflows), readthedocs docs/, packaging (pyproject.toml), license, governance.
README for additional insights
• Clarifies tech stack: Python/Twisted, Angular, REST, secure communications, database migrations, continuous integration, documentation portal.
Elements
• Clear labels: name each component (e.g., “Angular SPA,” “Twisted Web Server,” “PostgreSQL DB,” “SMTP Service,” “Let’s Encrypt ACME”)
• From client to API, API to DB, jobs to external services
• Asynchronous flows for background jobs
• Frontend in blue rectangles
• Backend in green rectangles
• External services in gray clouds or parallelograms
Detailed capture of essential architectural elements
• HTTP server & REST decorators → Handler modules → Service layer → ORM → DB
• Reactor scheduler → Job modules
• Utility modules (crypto, PGP, TLS, file system)
• App shell → Router → Feature modules per user role → Shared components & services
• Packaging / deployment:
• Docker image build → Debian packages → Cloud or on-premise host
• Monitoring / logging flows if needed