Add docs and project files - force for Culurien

This commit is contained in:
Fimeg
2026-03-28 20:46:24 -04:00
parent dc61797423
commit 484a7f77ce
343 changed files with 119530 additions and 0 deletions

714
docs/index.html Normal file
View File

@@ -0,0 +1,714 @@
<!DOCTYPE html>
<html lang="en">
<head>
<meta charset="UTF-8">
<meta name="viewport" content="width=device-width, initial-scale=1.0">
<title>RedFlag - Open Source Update Management</title>
<style>
* {
margin: 0;
padding: 0;
box-sizing: border-box;
}
body {
font-family: -apple-system, BlinkMacSystemFont, 'Segoe UI', Roboto, 'Helvetica Neue', Arial, sans-serif;
line-height: 1.6;
color: #333;
background: #f5f5f5;
}
/* Navigation */
nav {
background: #1a1a1a;
color: white;
padding: 1rem 0;
position: sticky;
top: 0;
z-index: 1000;
box-shadow: 0 2px 5px rgba(0,0,0,0.1);
}
nav .container {
max-width: 1200px;
margin: 0 auto;
padding: 0 2rem;
display: flex;
justify-content: space-between;
align-items: center;
}
nav .logo {
font-size: 1.5rem;
font-weight: bold;
display: flex;
align-items: center;
gap: 0.5rem;
}
nav .logo .flag {
font-size: 2rem;
}
nav ul {
list-style: none;
display: flex;
gap: 2rem;
}
nav a {
color: white;
text-decoration: none;
transition: color 0.3s;
}
nav a:hover {
color: #ff4444;
}
/* Hero Section */
.hero {
background: linear-gradient(135deg, #cc0000 0%, #8b0000 100%);
color: white;
padding: 4rem 2rem;
text-align: center;
}
.hero h1 {
font-size: 3rem;
margin-bottom: 1rem;
font-weight: 700;
}
.hero .tagline {
font-size: 1.3rem;
margin-bottom: 2rem;
opacity: 0.95;
font-style: italic;
}
.hero .description {
font-size: 1.1rem;
max-width: 800px;
margin: 0 auto 2rem;
line-height: 1.8;
}
.hero .cta-buttons {
display: flex;
gap: 1rem;
justify-content: center;
flex-wrap: wrap;
}
.btn {
display: inline-block;
padding: 0.8rem 2rem;
border-radius: 5px;
text-decoration: none;
font-weight: 600;
transition: all 0.3s;
border: 2px solid transparent;
}
.btn-primary {
background: white;
color: #cc0000;
}
.btn-primary:hover {
transform: translateY(-2px);
box-shadow: 0 5px 15px rgba(0,0,0,0.3);
}
.btn-secondary {
background: transparent;
color: white;
border-color: white;
}
.btn-secondary:hover {
background: white;
color: #cc0000;
}
/* Status Banner */
.status-banner {
background: #fff3cd;
border-left: 4px solid #ff9800;
padding: 1rem 2rem;
margin: 2rem auto;
max-width: 1200px;
}
.status-banner strong {
color: #ff9800;
}
/* Container */
.container {
max-width: 1200px;
margin: 0 auto;
padding: 0 2rem;
}
/* Section */
.section {
padding: 4rem 2rem;
background: white;
margin: 2rem 0;
}
.section h2 {
font-size: 2.5rem;
margin-bottom: 1rem;
color: #1a1a1a;
}
.section h3 {
font-size: 1.8rem;
margin: 2rem 0 1rem;
color: #333;
}
/* Features Grid */
.features {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(300px, 1fr));
gap: 2rem;
margin: 3rem 0;
}
.feature-card {
background: #f9f9f9;
padding: 2rem;
border-radius: 8px;
border-left: 4px solid #cc0000;
}
.feature-card h3 {
margin-top: 0;
color: #cc0000;
}
.feature-card .icon {
font-size: 2.5rem;
margin-bottom: 1rem;
}
/* Status Cards */
.status-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(350px, 1fr));
gap: 2rem;
margin: 2rem 0;
}
.status-card {
background: #f9f9f9;
padding: 2rem;
border-radius: 8px;
border-top: 4px solid #666;
}
.status-card.working {
border-top-color: #4caf50;
}
.status-card.planned {
border-top-color: #2196f3;
}
.status-card.future {
border-top-color: #9c27b0;
}
.status-card h3 {
margin-top: 0;
display: flex;
align-items: center;
gap: 0.5rem;
}
.status-badge {
display: inline-block;
padding: 0.25rem 0.75rem;
border-radius: 12px;
font-size: 0.85rem;
font-weight: 600;
}
.badge-working {
background: #4caf50;
color: white;
}
.badge-planned {
background: #2196f3;
color: white;
}
.badge-future {
background: #9c27b0;
color: white;
}
.status-card ul {
list-style: none;
padding-left: 0;
}
.status-card li {
padding: 0.5rem 0;
padding-left: 1.5rem;
position: relative;
}
.status-card li:before {
content: "▸";
position: absolute;
left: 0;
color: #cc0000;
}
/* Architecture */
.architecture {
background: #1a1a1a;
color: white;
padding: 2rem;
border-radius: 8px;
font-family: 'Courier New', monospace;
overflow-x: auto;
}
/* Tech Stack */
.tech-stack {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
gap: 1.5rem;
margin: 2rem 0;
}
.tech-item {
background: #f9f9f9;
padding: 1.5rem;
border-radius: 8px;
text-align: center;
}
.tech-item h4 {
color: #cc0000;
margin-bottom: 1rem;
}
/* Footer */
footer {
background: #1a1a1a;
color: white;
padding: 3rem 2rem 1rem;
margin-top: 4rem;
}
footer .container {
max-width: 1200px;
margin: 0 auto;
}
footer .footer-grid {
display: grid;
grid-template-columns: repeat(auto-fit, minmax(250px, 1fr));
gap: 2rem;
margin-bottom: 2rem;
}
footer h4 {
color: #ff4444;
margin-bottom: 1rem;
}
footer ul {
list-style: none;
}
footer li {
margin: 0.5rem 0;
}
footer a {
color: #ccc;
text-decoration: none;
}
footer a:hover {
color: #ff4444;
}
footer .footer-bottom {
border-top: 1px solid #333;
padding-top: 2rem;
text-align: center;
color: #888;
}
/* Responsive */
@media (max-width: 768px) {
nav ul {
flex-direction: column;
gap: 1rem;
}
.hero h1 {
font-size: 2rem;
}
.hero .tagline {
font-size: 1.1rem;
}
.section {
padding: 2rem 1rem;
}
}
</style>
</head>
<body>
<!-- Navigation -->
<nav>
<div class="container">
<div class="logo">
<span class="flag">🚩</span>
<span>RedFlag</span>
</div>
<ul>
<li><a href="#features">Features</a></li>
<li><a href="#status">Status</a></li>
<li><a href="#docs">Docs</a></li>
<li><a href="#community">Community</a></li>
<li><a href="https://github.com/aggregator-project" target="_blank">GitHub</a></li>
</ul>
</div>
</nav>
<!-- Hero -->
<div class="hero">
<h1>🚩 RedFlag</h1>
<p class="tagline">"From each according to their updates, to each according to their needs"</p>
<p class="description">
Self-hosted, open-source update management for your entire infrastructure.
Monitor and manage Windows, Linux, and Docker updates from a single dashboard.
Built by self-hosters, for self-hosters.
</p>
<div class="cta-buttons">
<a href="getting-started.html" class="btn btn-primary">Get Started</a>
<a href="https://github.com/aggregator-project" class="btn btn-secondary">View on GitHub</a>
<a href="#docs" class="btn btn-secondary">Documentation</a>
</div>
</div>
<!-- Status Banner -->
<div class="status-banner">
<strong>⚠️ Alpha Status:</strong> RedFlag is currently in active development. Core functionality works, but this is research-grade software. Read our <a href="https://github.com/aggregator-project/aggregator-agent/blob/main/SECURITY.md" style="color: #cc0000; font-weight: bold;">Security Guide</a> before deploying.
</div>
<!-- Features Section -->
<div class="section" id="features">
<div class="container">
<h2>Why RedFlag?</h2>
<p style="font-size: 1.1rem; margin-bottom: 2rem;">
Commercial RMM tools cost hundreds of dollars per agent. Open-source alternatives are either
detection-only or overcomplicated. RedFlag fills the gap: simple, self-hosted, and free.
</p>
<div class="features">
<div class="feature-card">
<div class="icon">🎯</div>
<h3>Single Pane of Glass</h3>
<p>View all pending updates across your entire infrastructure in one place. No more logging into 47 servers.</p>
</div>
<div class="feature-card">
<div class="icon">🏠</div>
<h3>Self-Hosted</h3>
<p>Your data, your infrastructure. No SaaS fees, no vendor lock-in, no external dependencies.</p>
</div>
<div class="feature-card">
<div class="icon">🔓</div>
<h3>Open Source</h3>
<p>AGPLv3 licensed. Audit the code, contribute features, fork it if you want. True software freedom.</p>
</div>
<div class="feature-card">
<div class="icon">🖥️</div>
<h3>Cross-Platform</h3>
<p>Linux (apt, yum, dnf), Windows (Windows Update, Winget), Docker containers, and more coming.</p>
</div>
<div class="feature-card">
<div class="icon"></div>
<h3>Lightweight Agents</h3>
<p>Single binary, minimal dependencies. Agents poll the server every 5 minutes—firewall friendly.</p>
</div>
<div class="feature-card">
<div class="icon">🤖</div>
<h3>AI-Ready Architecture</h3>
<p>Designed from the ground up for future AI integration: natural language queries, intelligent scheduling.</p>
</div>
</div>
</div>
</div>
<!-- Status Section -->
<div class="section" id="status" style="background: #fafafa;">
<div class="container">
<h2>Current Status</h2>
<div class="status-grid">
<div class="status-card working">
<h3>
<span class="status-badge badge-working">Working (Alpha)</span>
</h3>
<ul>
<li>Server API with PostgreSQL</li>
<li>Agent registration & authentication</li>
<li>Linux APT package scanner</li>
<li>Docker container detection</li>
<li>Update discovery & tracking</li>
<li>Manual approval workflow</li>
<li>REST API for all operations</li>
</ul>
</div>
<div class="status-card planned">
<h3>
<span class="status-badge badge-planned">In Progress</span>
</h3>
<ul>
<li>Web dashboard (React + TailwindCSS)</li>
<li>Docker Registry API integration</li>
<li>Update installation execution</li>
<li>Windows agent development</li>
<li>CVE data enrichment</li>
<li>Security hardening</li>
</ul>
</div>
<div class="status-card future">
<h3>
<span class="status-badge badge-future">Roadmap</span>
</h3>
<ul>
<li>AI-powered scheduling</li>
<li>Natural language queries</li>
<li>Maintenance windows</li>
<li>Rollback capabilities</li>
<li>YUM/DNF scanner</li>
<li>Snap/Flatpak support</li>
<li>Multi-tenancy for MSPs</li>
</ul>
</div>
</div>
<h3 style="margin-top: 3rem;">Known Limitations</h3>
<div class="feature-card" style="background: #fff3cd; border-left-color: #ff9800;">
<ul>
<li><strong>Docker scanner:</strong> Currently a stub—doesn't actually query registries yet</li>
<li><strong>Update installation:</strong> Discovery only; installation not implemented</li>
<li><strong>CVE data:</strong> APT scanner doesn't fetch security advisory data yet</li>
<li><strong>No web dashboard:</strong> API-only at the moment</li>
<li><strong>Security:</strong> Needs hardening before production use</li>
</ul>
</div>
</div>
</div>
<!-- Architecture Section -->
<div class="section">
<div class="container">
<h2>How It Works</h2>
<p style="margin-bottom: 2rem;">
Pull-based architecture: agents check in with the server every 5 minutes,
receive commands, execute them, and report results. Simple, secure, and firewall-friendly.
</p>
<div class="architecture">
<pre style="line-height: 1.4;">
┌─────────────────────────────────────────────────────┐
│ Your Infrastructure │
│ │
│ ┌──────────┐ ┌──────────┐ ┌──────────┐ │
│ │ Linux │ │ Linux │ │ Linux │ │
│ │ Agent │ │ Agent │ │ Agent │ │
│ │ │ │ │ │ │ │
│ │ • APT │ │ • YUM │ │ • APT │ │
│ │ • Docker│ │ • Docker│ │ • Docker│ │
│ └────┬─────┘ └────┬─────┘ └────┬─────┘ │
│ │ │ │ │
│ └─────────────┴─────────────┘ │
│ │ Poll every 5 min │
│ ▼ │
│ ┌─────────────────────────────┐ │
│ │ RedFlag Server (Go) │ │
│ │ • REST API │ │
│ │ • PostgreSQL Database │ │
│ │ • Command Queue │ │
│ └─────────────────────────────┘ │
│ ▲ │
│ │ HTTPS │
│ ┌─────────────┴───────────┐ │
│ │ Web Dashboard │ (Coming Soon) │
│ │ (React + TailwindCSS) │ │
│ └─────────────────────────┘ │
└─────────────────────────────────────────────────────┘
</pre>
</div>
</div>
</div>
<!-- Tech Stack Section -->
<div class="section" style="background: #fafafa;">
<div class="container">
<h2>Technology Stack</h2>
<div class="tech-stack">
<div class="tech-item">
<h4>Server</h4>
<p>Go 1.25 + Gin Framework<br>PostgreSQL 16<br>JWT Authentication</p>
</div>
<div class="tech-item">
<h4>Agent</h4>
<p>Go 1.25<br>Single Binary<br>Systemd Service</p>
</div>
<div class="tech-item">
<h4>Web (Planned)</h4>
<p>React 18 + TypeScript<br>TailwindCSS<br>TanStack Query</p>
</div>
<div class="tech-item">
<h4>Deployment</h4>
<p>Docker Compose<br>Kubernetes<br>Bare Metal</p>
</div>
</div>
</div>
</div>
<!-- Documentation Section -->
<div class="section" id="docs">
<div class="container">
<h2>Documentation</h2>
<div class="features">
<div class="feature-card">
<h3>🚀 Quick Start</h3>
<p>Get RedFlag running in under 10 minutes with our step-by-step guide.</p>
<a href="getting-started.html" style="color: #cc0000; font-weight: bold;">Getting Started →</a>
</div>
<div class="feature-card">
<h3>🔐 Security Guide</h3>
<p>Essential security considerations before deploying to production.</p>
<a href="https://github.com/aggregator-project/aggregator-agent/blob/main/SECURITY.md" style="color: #cc0000; font-weight: bold;">Security Docs →</a>
</div>
<div class="feature-card">
<h3>📖 API Reference</h3>
<p>Complete API documentation for integrating with RedFlag.</p>
<a href="https://github.com/aggregator-project/aggregator-agent/blob/main/README.md#api-usage" style="color: #cc0000; font-weight: bold;">API Docs →</a>
</div>
</div>
</div>
</div>
<!-- Community Section -->
<div class="section" id="community" style="background: #fafafa;">
<div class="container">
<h2>Community & Contributing</h2>
<p style="font-size: 1.1rem; margin-bottom: 2rem;">
RedFlag is a community project. No company backing, no VC funding—just volunteers
building tools we wish existed.
</p>
<h3>Ways to Contribute</h3>
<div class="features">
<div class="feature-card">
<h3>💻 Code</h3>
<p>Windows agent, web dashboard, package managers, Docker Registry API integration.</p>
</div>
<div class="feature-card">
<h3>📝 Documentation</h3>
<p>Setup guides, troubleshooting, API examples, translation.</p>
</div>
<div class="feature-card">
<h3>🧪 Testing</h3>
<p>Test on different distros, report bugs, verify security.</p>
</div>
<div class="feature-card">
<h3>⭐ Feedback</h3>
<p>Feature requests, bug reports, usability suggestions.</p>
</div>
</div>
<p style="margin-top: 2rem;">
Check out our <a href="https://github.com/aggregator-project" style="color: #cc0000; font-weight: bold;">GitHub organization</a>
to get started. No corporate CLA, no meetings—just code and pull requests.
</p>
</div>
</div>
<!-- Footer -->
<footer>
<div class="container">
<div class="footer-grid">
<div>
<h4>Project</h4>
<ul>
<li><a href="#features">Features</a></li>
<li><a href="#status">Current Status</a></li>
<li><a href="getting-started.html">Getting Started</a></li>
<li><a href="https://github.com/aggregator-project">GitHub</a></li>
</ul>
</div>
<div>
<h4>Documentation</h4>
<ul>
<li><a href="getting-started.html">Installation Guide</a></li>
<li><a href="https://github.com/aggregator-project/aggregator-agent/blob/main/README.md">API Reference</a></li>
<li><a href="https://github.com/aggregator-project/aggregator-agent/blob/main/SECURITY.md">Security Guide</a></li>
</ul>
</div>
<div>
<h4>Community</h4>
<ul>
<li><a href="https://github.com/aggregator-project/issues">Report a Bug</a></li>
<li><a href="https://github.com/aggregator-project/discussions">Discussions</a></li>
<li><a href="https://github.com/aggregator-project/contributing">Contributing Guide</a></li>
</ul>
</div>
<div>
<h4>Legal</h4>
<ul>
<li><a href="https://github.com/aggregator-project/aggregator-agent/blob/main/LICENSE">License (AGPLv3)</a></li>
<li><a href="https://github.com/aggregator-project/aggregator-agent/blob/main/SECURITY.md">Security Policy</a></li>
</ul>
</div>
</div>
<div class="footer-bottom">
<p>© 2025 RedFlag Project • AGPLv3 Licensed • Built by self-hosters, for self-hosters</p>
<p style="margin-top: 0.5rem; font-size: 0.9rem;">
No corporate backing • No VC funding • Just volunteers building tools we wish existed
</p>
</div>
</div>
</footer>
</body>
</html>