How nirevil/vless works
Main Components
• GitHub Actions Workflows – Located under the .github/workflows directory, these workflows trigger the dynamic update process every two hours and make sure that configuration files (in directories like “edge”, “sub”, “boringtun‐…”, etc.) are regenerated.
• Dynamic Configuration Generator – At the heart of the system are back‑end scripts such as backend.py and other utilities (for instance, the “real address generator” and the boringtun CLI tool written in Rust). These components process raw data (like Cloudflare IPs, DNS configuration, etc.) and produce updated subscription files.
• DNS over HTTPS Workers – The “DNS over HTTPS” directory contains worker scripts (e.g. _worker.js) that likely handle DNS queries or may serve as lightweight edge code to channel some of the subscription functionalities.
• Supporting Assets and Frontend Scripts – The “edge” directory (with assets such as JavaScript files, CSS, and images) serves as the presentation layer (for example, generating QR codes or showing usage instructions when a user visits the GitHub Pages or Cloudflare-hosted site).
Relationships/Interactions
• The configuration generator components take in “raw data” such as static IP files (for example, Cloudflare-IPs.json) and other source files, perform processing/transformation (for example, reordering, validating, or combining data for DNS over HTTPS) and output updated configuration files.
• These updated files are then “stored” back in various directories (like “sub”, “edge”, etc.). This storage represents the updated state of configuration assets that public clients will later poll or pull.
Architectural Patterns and Technologies
• Continuous integration/delivery (CI/CD) aspect through GitHub Actions which continuously regenerates parts of the repository.
• “dynamic/static separation” pattern: the backend and CLI tools continuously generate configuration data (the “dynamic” part), which then gets served as static files that clients can use.
• Mention the mix of technology stacks used—for example, Python for backend scripting (backend.py), Rust for WireGuard-related functionality (boringtun CLI), Node.js/JavaScript (frontend or worker scripts), and YAML/JSON for configuration formats.
• That due to the automated update system some directories and files (like workflows, borin-tun and edge files) are “volatile” and should not be manually modified.