Adaugă INDEX.md - overview complet al documentației și scripturilor
This commit is contained in:
mihaiitdata
parent
40c16e28da
commit
e06b27f138
|
|
@ -0,0 +1,435 @@
|
|||
# 📚 Index Fișiere - Instalare Automată Nefarious IRCd
|
||||
|
||||
> **Data**: 13 februarie 2026 | **Limbă**: Română 🇷🇴 | **Versiune**: 1.0
|
||||
|
||||
---
|
||||
|
||||
## 🚀 START RAPID (Citește Asta Primul!)
|
||||
|
||||
### ⚡ 3 Comenzi = Server Pornit
|
||||
|
||||
```bash
|
||||
git clone https://gitlab.back.ro/itdata/underchat-ircd.git
|
||||
cd underchat-ircd
|
||||
./install.sh
|
||||
```
|
||||
|
||||
**Gata!** Serverul rulează pe `localhost:6667`
|
||||
|
||||
---
|
||||
|
||||
## 📖 Ghiduri Documentare
|
||||
|
||||
### 1. **QUICKSTART.md** ⭐ START AICI
|
||||
- **Pentru**: Primii 5-10 minute
|
||||
- **Conținut**:
|
||||
- Instalare în 3 comenzi
|
||||
- Ce face script-ul automat
|
||||
- Opțiuni instalare rapide
|
||||
- Conectare și testare
|
||||
- Troubleshooting rapid
|
||||
- **Timp citire**: 5 min
|
||||
- **Ideal pentru**: Utilizatori noi
|
||||
|
||||
### 2. **INSTALL_AUTO.md** 📖 REFERINȚĂ COMPLETĂ
|
||||
- **Pentru**: Documentație detaliată
|
||||
- **Conținut**:
|
||||
- Cerințe pe fiecare platformă
|
||||
- Instalare customizată
|
||||
- Structura directoarelor
|
||||
- Oprire/pornire server
|
||||
- Administrare zilnică
|
||||
- Networking (linking servere)
|
||||
- Securitate avansată
|
||||
- **Timp citire**: 20-30 min
|
||||
- **Ideal pentru**: Setup complet & troubleshooting
|
||||
|
||||
### 3. **README_SCRIPTS.md** 🔧 REZUMAT SCRIPTURI
|
||||
- **Pentru**: Descrierea fiecărui script
|
||||
- **Conținut**:
|
||||
- Ce fac scripturile?
|
||||
- Cum se folosesc?
|
||||
- Opțiuni disponibile
|
||||
- Exemplu flux tipic
|
||||
- Checklist instalare
|
||||
- **Timp citire**: 10-15 min
|
||||
- **Ideal pentru**: Înțelegere flux complet
|
||||
|
||||
### 4. **CLAUDE.md** 💻 DETALII TEHNICES
|
||||
- **Pentru**: Dezvoltatori
|
||||
- **Conținut**:
|
||||
- Arhitectura proiectului
|
||||
- Sisteme de event
|
||||
- Command handlers
|
||||
- Configurare Docker
|
||||
- **Timp citire**: 30+ min
|
||||
- **Ideal pentru**: Development & understanding
|
||||
|
||||
---
|
||||
|
||||
## 🛠️ Scripturi Executabile
|
||||
|
||||
### **install.sh** - INSTALARE AUTOMATĂ PRINCIPAL
|
||||
```bash
|
||||
./install.sh # Standard
|
||||
./install.sh --prefix /opt/ircd # Custom location
|
||||
./install.sh --maxcon 8192 # Max connections
|
||||
./install.sh --debug # With debugging
|
||||
./install.sh --no-ssl # Without SSL
|
||||
```
|
||||
|
||||
**Flow:**
|
||||
```
|
||||
Verifică dependențe → Configure → Compile → Install → Generează config
|
||||
```
|
||||
|
||||
**Timp execuție**: 5-15 minute (depinde de sistem)
|
||||
|
||||
---
|
||||
|
||||
### **configure-interactive.sh** - CONFIGURARE AVANSATĂ
|
||||
```bash
|
||||
./configure-interactive.sh
|
||||
```
|
||||
|
||||
**Etape:**
|
||||
1. Setări generale (nume, descriere, numeric)
|
||||
2. Informații administrator
|
||||
3. Configurare porturi
|
||||
4. Clase de conexiuni
|
||||
5. Operatori (nick, host, password)
|
||||
6. Caracteristici avansate (AUTH, SWHOIS, etc.)
|
||||
|
||||
**Timp execuție**: 10-15 minute
|
||||
|
||||
---
|
||||
|
||||
### **admin.sh** - MENIU INTERACTIV
|
||||
```bash
|
||||
./admin.sh
|
||||
```
|
||||
|
||||
**Opțiuni:**
|
||||
```
|
||||
1. Pornire server
|
||||
2. Oprire server
|
||||
3. Restart server
|
||||
4. Verifica status (PID, CPU, RAM, porturi)
|
||||
5. Editare configurare (cu backup automat)
|
||||
6. Vizionare log-uri (tail, live, grep)
|
||||
7. Generare parola operator
|
||||
8. Test sintaxă configurare
|
||||
9. Iesire
|
||||
```
|
||||
|
||||
**Ideal pentru**: Administrare zilnică
|
||||
|
||||
---
|
||||
|
||||
## 📁 Structură Directoare Post-Instalare
|
||||
|
||||
```
|
||||
~/ircd/
|
||||
├── bin/
|
||||
│ ├── ircd ← Server principal (RUN THIS)
|
||||
│ ├── umkpasswd ← Password generator
|
||||
│ └── ...
|
||||
├── etc/
|
||||
│ ├── ircd.conf ← CONFIG FILE (EDIT THIS)
|
||||
│ ├── ircd.motd
|
||||
│ └── ircd.opermotd
|
||||
├── log/
|
||||
│ └── ircd.log ← LOGS (MONITOR THIS)
|
||||
└── var/
|
||||
└── ...
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 Caz de Utilizare: Instalare Completă
|
||||
|
||||
### Scenariu: Setup Nou de la Zero
|
||||
|
||||
```bash
|
||||
# 1. Clone & enter
|
||||
git clone https://gitlab.back.ro/itdata/underchat-ircd.git
|
||||
cd underchat-ircd
|
||||
|
||||
# 2. Instalare (5-10 min)
|
||||
./install.sh
|
||||
# → Răspunde: nume server, admin email, etc.
|
||||
|
||||
# 3. (Optional) Configurare Avansată (10-15 min)
|
||||
./configure-interactive.sh
|
||||
|
||||
# 4. Meniu administrare
|
||||
./admin.sh
|
||||
|
||||
# Opțiuni din meniu:
|
||||
# → 7) Generare parola operator
|
||||
# → 1) Pornire server
|
||||
# → 4) Verifica status
|
||||
# → 6) Vizionare log-uri
|
||||
|
||||
# 5. Conectare cu IRC client
|
||||
# Server: localhost:6667
|
||||
```
|
||||
|
||||
**Total timp: 30-45 minute** pentru setup complet
|
||||
|
||||
---
|
||||
|
||||
## 🔍 Flux Zilnic de Administrare
|
||||
|
||||
```bash
|
||||
# Morning: Check status
|
||||
./admin.sh
|
||||
# → 4) Verifica status
|
||||
|
||||
# Configure if needed
|
||||
./admin.sh
|
||||
# → 5) Editare configurare
|
||||
# → 3) Restart server
|
||||
|
||||
# Monitor logs
|
||||
./admin.sh
|
||||
# → 6) Vizionare log-uri
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🆘 Troubleshooting Rapid
|
||||
|
||||
### Problemă: Server nu pornește
|
||||
```bash
|
||||
./admin.sh
|
||||
→ 8) Test sintaxă configurare
|
||||
→ 6) Vizionare log-uri
|
||||
# Citește ultimele linii din log
|
||||
```
|
||||
|
||||
### Problemă: Port conflict
|
||||
```bash
|
||||
./admin.sh
|
||||
→ 5) Editare configurare
|
||||
# Schimbă Port { port = 6668; }
|
||||
→ 3) Restart server
|
||||
```
|
||||
|
||||
### Problemă: Permisiuni denied
|
||||
```bash
|
||||
chmod +x install.sh configure-interactive.sh admin.sh
|
||||
./install.sh
|
||||
```
|
||||
|
||||
### Problemă: Compilare eșuată
|
||||
```bash
|
||||
./install.sh --enable-debug
|
||||
# Check documentation în INSTALL_AUTO.md
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 📊 Tabel Referință Rapid
|
||||
|
||||
| Task | Scriptul | Opțiune |
|
||||
|------|----------|---------|
|
||||
| **Instalare** | `./install.sh` | - |
|
||||
| **Configurare avansată** | `./configure-interactive.sh` | - |
|
||||
| **Pornire server** | `./admin.sh` | 1 |
|
||||
| **Oprire server** | `./admin.sh` | 2 |
|
||||
| **Restart** | `./admin.sh` | 3 |
|
||||
| **Status server** | `./admin.sh` | 4 |
|
||||
| **Editare config** | `./admin.sh` | 5 |
|
||||
| **Log-uri** | `./admin.sh` | 6 |
|
||||
| **Parola operator** | `./admin.sh` | 7 |
|
||||
| **Test config** | `./admin.sh` | 8 |
|
||||
|
||||
---
|
||||
|
||||
## 📝 Fișiere Configurare Generate
|
||||
|
||||
Scripturile generează automat:
|
||||
|
||||
```
|
||||
ircd.conf ← Configurare server principal
|
||||
ircd.motd ← Message of the Day
|
||||
ircd.opermotd ← Operator Message of the Day
|
||||
ircd.log ← Log file (creat la pornire)
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🔐 Pași Securitate Post-Instalare
|
||||
|
||||
```
|
||||
☐ 1. Schimbă parola operator
|
||||
./admin.sh → 7) Generare parola operator
|
||||
|
||||
☐ 2. Securizează config
|
||||
chmod 600 ~/ircd/etc/ircd.conf
|
||||
|
||||
☐ 3. Backup config
|
||||
cp ~/ircd/etc/ircd.conf ~/ircd/etc/ircd.conf.backup
|
||||
|
||||
☐ 4. Firewall rules
|
||||
sudo ufw allow 6667/tcp
|
||||
sudo ufw allow 6697/tcp
|
||||
|
||||
☐ 5. Monitor logs
|
||||
tail -f ~/ircd/log/ircd.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🌍 Suport Platforme
|
||||
|
||||
| OS | Status | Setup |
|
||||
|----|--------|-------|
|
||||
| **Ubuntu/Debian** | ✅ Full | `apt-get install build-essential...` |
|
||||
| **RHEL/CentOS** | ✅ Full | `yum install gcc make...` |
|
||||
| **macOS** | ✅ Full | `xcode-select --install` |
|
||||
| **FreeBSD** | ✅ Full | Ports sau manual |
|
||||
| **Solaris** | ⚠️ Legacy | Citește INSTALL |
|
||||
| **Windows** | ❌ Native | Use WSL2/Cygwin |
|
||||
|
||||
---
|
||||
|
||||
## 📚 Documentație Completă
|
||||
|
||||
### După Instalare, Citește:
|
||||
1. **QUICKSTART.md** - Primii pași
|
||||
2. **admin.sh** - Pentru administrare zilnică
|
||||
3. **INSTALL_AUTO.md** - Referință detaliată
|
||||
4. **doc/example.conf** - Explicații config
|
||||
|
||||
### Pentru Développateurs:
|
||||
- **CLAUDE.md** - Arhitectură & design
|
||||
- **doc/p10.txt** - Protocol documentation
|
||||
- **ircd/** - Source code comentat
|
||||
|
||||
---
|
||||
|
||||
## 🎓 Exemple Comenzi Tipice
|
||||
|
||||
### Instalare Standard
|
||||
```bash
|
||||
./install.sh
|
||||
```
|
||||
|
||||
### Instalare cu Path Custom
|
||||
```bash
|
||||
./install.sh --prefix /var/lib/ircd --maxcon 16384
|
||||
```
|
||||
|
||||
### Administrare
|
||||
```bash
|
||||
./admin.sh # Meniu interactiv pentru totul
|
||||
```
|
||||
|
||||
### Manual Start (după instalare)
|
||||
```bash
|
||||
~/ircd/bin/ircd -f ~/ircd/etc/ircd.conf
|
||||
```
|
||||
|
||||
### Check Status
|
||||
```bash
|
||||
ps aux | grep ircd
|
||||
tail -f ~/ircd/log/ircd.log
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## ✨ Caracteristici Automatizate
|
||||
|
||||
✅ Verificare dependențe (gcc, make, SSL)
|
||||
✅ Autodetect platformă (Linux, BSD, macOS)
|
||||
✅ Configurare automată cu parametri optime
|
||||
✅ Compilare full C codebase (~150MB)
|
||||
✅ Instalare binare
|
||||
✅ Generare configurare interactivă
|
||||
✅ Backup automat la editare
|
||||
✅ Meniu administrare complet
|
||||
✅ Comentarii în limba română
|
||||
✅ Validare intrări (email, hostname, numeric)
|
||||
✅ Color output pentru ușor de citit
|
||||
✅ Error handling complet
|
||||
|
||||
---
|
||||
|
||||
## 🚀 Urmatorul Pas?
|
||||
|
||||
### Nou?
|
||||
👉 Citește **QUICKSTART.md** (5 min)
|
||||
|
||||
### Gata să instalezi?
|
||||
👉 Rulează `./install.sh` (10 min)
|
||||
|
||||
### Instalat deja?
|
||||
👉 Rulează `./admin.sh` (daily management)
|
||||
|
||||
### Probleme?
|
||||
👉 Citește **INSTALL_AUTO.md** secțiunea Troubleshooting
|
||||
|
||||
### Development?
|
||||
👉 Citește **CLAUDE.md** pentru arhitectură
|
||||
|
||||
---
|
||||
|
||||
## 📞 Suport
|
||||
|
||||
**Question: "Cum funcționează X?"**
|
||||
- Citește QUICKSTART.md sau INSTALL_AUTO.md
|
||||
|
||||
**Question: "E o eroare la compilare"**
|
||||
- Citește INSTALL_AUTO.md → Rezolvare Probleme
|
||||
|
||||
**Question: "Cum configurez networking?"**
|
||||
- Citește INSTALL_AUTO.md → Networking
|
||||
|
||||
**Question: "Cum fac X cu operatorul?"**
|
||||
- Citește INSTALL_AUTO.md → Comenzi Administrator
|
||||
|
||||
---
|
||||
|
||||
## 📦 Ce ai Primit
|
||||
|
||||
```
|
||||
✅ 3 scripturi shell bash complete (install.sh, configure-interactive.sh, admin.sh)
|
||||
✅ 4 ghiduri documentare complet (QUICKSTART, INSTALL_AUTO, README_SCRIPTS, INDEX)
|
||||
✅ Comentarii în limba română 🇷🇴
|
||||
✅ Suport multiplatforma (Linux, BSD, macOS)
|
||||
✅ Fully automated flow (minimal user input)
|
||||
✅ Interactive menus cu color output
|
||||
✅ Backup & validation automat
|
||||
✅ Logging complet
|
||||
✅ Error handling robust
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
## 🎯 TL;DR
|
||||
|
||||
```bash
|
||||
# 1. Clone
|
||||
git clone https://gitlab.back.ro/itdata/underchat-ircd.git
|
||||
|
||||
# 2. Install (automated, just answer questions)
|
||||
cd underchat-ircd
|
||||
./install.sh
|
||||
|
||||
# 3. Manage
|
||||
./admin.sh
|
||||
|
||||
# Done! IRC server ready on localhost:6667
|
||||
```
|
||||
|
||||
---
|
||||
|
||||
**Data creării**: 13 februarie 2026
|
||||
**Versiune**: 1.0
|
||||
**Limbă**: Română 🇷🇴
|
||||
**Status**: ✅ Complet și testat
|
||||
|
||||
**Succes!** 🚀
|
||||
|
||||
Loading…
Reference in New Issue