152 lines
3.1 KiB
Markdown
152 lines
3.1 KiB
Markdown
# QognyX Installation - Environnement de Développement
|
|
|
|
## Installation réalisée
|
|
|
|
✅ Node.js 20.20.0 installé
|
|
✅ npm 10.8.2 installé
|
|
✅ MongoDB 7.0.28 installé et démarré
|
|
✅ QognyX sources téléchargées et configurées
|
|
✅ Dépendances npm installées
|
|
|
|
## Configuration
|
|
|
|
### API Personnalisée
|
|
L'environnement est configuré pour utiliser votre API personnalisée :
|
|
- URL: https://cpu.lsbuchet.com/v1
|
|
- Format: Compatible OpenAI
|
|
|
|
### Fichiers de configuration
|
|
- `.env` : Variables d'environnement
|
|
- `librechat.yaml` : Configuration de l'endpoint personnalisé
|
|
|
|
### Base de données
|
|
MongoDB est configuré localement sur `mongodb://127.0.0.1:27017/QognyX`
|
|
|
|
## Utilisation
|
|
|
|
### Avant de démarrer
|
|
1. Éditer `/opt/front-dev/.env` et remplacer `your_api_key_here` par votre vraie clé API:
|
|
```bash
|
|
nano /opt/front-dev/.env
|
|
# Chercher CPU_API_KEY= et remplacer la valeur
|
|
```
|
|
|
|
### Démarrer l'environnement de développement
|
|
```bash
|
|
cd /opt/front-dev
|
|
./start-dev.sh
|
|
```
|
|
ou
|
|
```bash
|
|
cd /opt/front-dev
|
|
npm run dev
|
|
```
|
|
|
|
L'application sera accessible sur: http://localhost:3080
|
|
|
|
### Build pour la production
|
|
```bash
|
|
cd /opt/front-dev
|
|
./build-prod.sh
|
|
```
|
|
|
|
### Démarrer en production
|
|
```bash
|
|
cd /opt/front-dev
|
|
npm run start
|
|
```
|
|
|
|
## Commandes utiles
|
|
|
|
### Vérifier le statut de MongoDB
|
|
```bash
|
|
systemctl status mongod
|
|
```
|
|
|
|
### Arrêter MongoDB
|
|
```bash
|
|
systemctl stop mongod
|
|
```
|
|
|
|
### Démarrer MongoDB
|
|
```bash
|
|
systemctl start mongod
|
|
```
|
|
|
|
### Mettre à jour les sources
|
|
```bash
|
|
cd /opt/front-dev
|
|
curl -L https://github.com/danny-avila/QognyX/archive/refs/heads/main.tar.gz -o update.tar.gz
|
|
tar -xzf update.tar.gz --strip-components=1
|
|
rm update.tar.gz
|
|
npm ci
|
|
```
|
|
|
|
### Installer de nouvelles dépendances
|
|
```bash
|
|
cd /opt/front-dev
|
|
npm install <package-name>
|
|
```
|
|
|
|
## Développement
|
|
|
|
### Structure du projet
|
|
- `api/` : Code backend (Node.js/Express)
|
|
- `client/` : Code frontend (React)
|
|
- `packages/` : Packages partagés
|
|
- `config/` : Fichiers de configuration
|
|
|
|
### Variables d'environnement importantes
|
|
- `CPU_API_KEY` : Clé API pour cpu.lsbuchet.com
|
|
- `MONGO_URI` : URI de connexion MongoDB
|
|
- `PORT` : Port du serveur (défaut: 3080)
|
|
- `DEBUG_LOGGING` : Active les logs de debug
|
|
|
|
## Logs et Debugging
|
|
|
|
### Voir les logs MongoDB
|
|
```bash
|
|
tail -f /var/log/mongodb/mongod.log
|
|
```
|
|
|
|
### Activer le mode debug
|
|
Dans `.env`, définir:
|
|
```
|
|
DEBUG_LOGGING=true
|
|
DEBUG_CONSOLE=true
|
|
```
|
|
|
|
## Production vs Développement
|
|
|
|
### Environnement de développement
|
|
- Hot-reload activé
|
|
- Logs verbeux
|
|
- Pas de minification
|
|
|
|
### Environnement de production
|
|
- Build optimisé
|
|
- Minification
|
|
- Meilleure performance
|
|
|
|
## Servir plusieurs instances
|
|
|
|
Vous pouvez configurer différentes instances sur différents ports:
|
|
- Développement: Port 3080
|
|
- Production: Port 3081 (par exemple)
|
|
|
|
Modifier `PORT=` dans `.env` pour changer le port.
|
|
|
|
## Support
|
|
|
|
Pour plus d'informations sur QognyX:
|
|
- Documentation: https://www.librechat.ai/docs
|
|
- GitHub: https://github.com/danny-avila/QognyX
|
|
|
|
## Prochaines étapes
|
|
|
|
1. ✏️ Éditer `.env` pour ajouter votre clé API
|
|
2. 🚀 Démarrer l'environnement de dev: `./start-dev.sh`
|
|
3. 🌐 Ouvrir http://localhost:3080
|
|
4. 📝 Créer un compte utilisateur
|
|
5. 💬 Tester l'API personnalisée
|