📚 Update README for public release + installation docs

2026-02-06 07:49:34 -03:00
parent a94809c812
commit fc4f98c359
3 changed files with 789 additions and 37 deletions
--- a/README.md
+++ b/README.md
@@ -1,43 +1,122 @@
 # 🐍 OPHION

-**Open Source Observability Platform**
+**Open Source Observability Platform — AI-Powered Monitoring**

-*Metrics, Logs, Traces & Alerts - Made in Brazil*
-
-## Features
-
- 📊 **Infrastructure Monitoring** - CPU, RAM, Disk, Network
- 📝 **Log Management** - Centralized logs with search
- 🔍 **Distributed Tracing** - Track requests across services
- 📈 **Custom Dashboards** - Drag-and-drop widgets
- 🚨 **Smart Alerts** - Telegram, Slack, Email, Webhooks
- 🔐 **Enterprise Security** - SSO, RBAC, Audit logs
-
-## Stack
-
- **Backend:** Go (Fiber)
- **Frontend:** Next.js 14 + TypeScript
- **Database:** ClickHouse + PostgreSQL + Redis
- **Protocol:** OpenTelemetry
-
-## Quick Start
-
-```bash
-# Docker (recommended)
-curl -fsSL https://get.ophion.io | bash
-
-# Or manually
-docker compose up -d
-```
-
-## Documentation
-
-See [docs/](./docs/) for full documentation.
-
-## License
-
-AGPL-3.0 (Community) / Commercial (Enterprise)
+[![License: AGPL-3.0](https://img.shields.io/badge/License-AGPL%203.0-blue.svg)](LICENSE)
+[![Website](https://img.shields.io/badge/Website-ophion.com.br-purple)](https://ophion.com.br)

 ---

-Made with 🖤 in Brazil
+## O que é o OPHION?
+
+OPHION é uma plataforma de observabilidade que combina **métricas, logs e traces** com **inteligência artificial** para monitoramento proativo de infraestrutura.
+
+### ✨ Diferenciais
+
+| Feature | OPHION | Datadog | Grafana |
+|---------|--------|---------|---------|
+| Métricas, Logs, Traces | ✅ | ✅ | ✅ |
+| **Copilot com IA** | ✅ | ❌ | ❌ |
+| **Auto-Healing** | ✅ | ❌ | ❌ |
+| **Correlação de Alertas com IA** | ✅ | 💰 | ❌ |
+| **Previsões de Capacidade** | ✅ | 💰 | ❌ |
+| Open Source | ✅ | ❌ | ✅ |
+
+---
+
+## 🚀 Instalação Rápida
+
+```bash
+curl -fsSL https://get.ophion.io | bash
+```
+
+O instalador interativo irá:
+- ✅ Verificar requisitos (Docker, Docker Compose)
+- ✅ Coletar informações da sua empresa
+- ✅ Gerar credenciais seguras
+- ✅ Iniciar a plataforma
+
+**Pronto em menos de 5 minutos!**
+
+---
+
+## 📋 Requisitos
+
+| Recurso | Mínimo | Recomendado |
+|---------|--------|-------------|
+| CPU | 2 cores | 4+ cores |
+| RAM | 4 GB | 8+ GB |
+| Disco | 20 GB SSD | 100+ GB SSD |
+| OS | Ubuntu 20.04+ | Ubuntu 22.04 LTS |
+
+---
+
+## 🔧 Instalação Manual
+
+```bash
+# Clonar
+git clone https://git.ophion.com.br/bigtux/ophion.git
+cd ophion
+
+# Configurar
+cp .env.example .env
+nano .env
+
+# Iniciar
+docker compose -f deploy/docker/docker-compose.yml up -d
+```
+
+---
+
+## 📦 Estrutura
+
+```
+ophion/
+├── install.sh              # Instalador interativo
+├── .env.example            # Exemplo de configuração
+├── cmd/
+│   ├── server/             # API Server (Go)
+│   └── agent/              # Agent de coleta
+├── dashboard/              # Frontend (Next.js)
+├── deploy/docker/          # Docker configs
+├── internal/               # Código interno
+└── docs/                   # Documentação
+```
+
+---
+
+## 🔐 Segurança
+
+- **JWT + API Keys** (SHA256)
+- **Bcrypt** para senhas
+- **Rate Limiting** 
+- **RBAC** por roles
+
+📖 [Guia de Segurança](docs/SECURITY.md)
+
+---
+
+## 📖 Documentação
+
+- [Instalação](docs/INSTALL.md)
+- [Segurança](docs/SECURITY.md)
+- [Manual PDF](docs/OPHION_Manual_Instalacao.pdf)
+
+---
+
+## 🆘 Suporte
+
+- **Website:** [ophion.com.br](https://ophion.com.br)
+- **Email:** suporte@ophion.com.br
+
+---
+
+## 📄 Licença
+
+AGPL-3.0 (Community Edition)
+
+---
+
+<p align="center">
+  <b>Made with 🖤 in Brazil</b>
+</p>