Files
kdrive-n8n/BUILD_INSTRUCTIONS.md
Rene Luria 6dccaba278 fix: add credentials export and fix logo display
- Add KDriveCredentials to n8n.credentials in package.json to make credentials discoverable
- Update build script to copy kdrive.svg to dist directory for proper logo display
- Update SVG logo with improved design
- Fix TypeScript types and error handling in GenericFunctions and KDrive node
- Add default values to node properties for better UX
2025-12-23 10:13:13 +01:00

3.5 KiB
Raw Blame History

Instructions de Build pour le Node kDrive n8n

🛠️ Configuration Corrigée

Le projet a été mis à jour pour utiliser des outils de build standards au lieu des outils internes de n8n qui ne sont pas disponibles publiquement.

📋 Étapes de Build

1 Installer les dépendances

# Installer les dépendances nécessaires
npm install

# Cela installera:
# - typescript: pour la compilation TypeScript
# - @types/node: pour les définitions de types Node.js

2 Builder le projet

# Utiliser le script npm
npm run build

# Ou utiliser TypeScript directement
npx tsc

# Les fichiers compilés seront dans le dossier `dist/`

3 Vérifier la compilation

# Vérifier que les fichiers ont été générés
ls -la dist/

# Vous devriez voir:
# - dist/index.js (fichier principal compilé)
# - dist/nodes/KDrive/ (dossier avec les fichiers compilés)

📁 Structure des Fichiers Compilés

dist/
├── index.js              # Point d'entrée principal
└── nodes/
    └── KDrive/
        ├── GenericFunctions.js  # Fonctions d'API compilées
        ├── KDriveCredentials.api.js  # Credentials compilés
        └── KDrive.node.js       # Node principal compilé

🚀 Déploiement dans n8n

Option 1: Copie manuelle

# Copier les fichiers dans votre instance n8n
# Pour une installation standard:
cp -r dist/* /chemin/vers/n8n/custom/

# Pour une installation Docker:
docker cp dist/ votre_conteneur_n8n:/home/node/.n8n/custom/

Option 2: Utilisation avec Helm

Voir le fichier HELM_INSTRUCTIONS.md pour les instructions spécifiques à Helm.

🔧 Configuration Requise

Fichiers nécessaires dans n8n:

  1. Fichiers JavaScript compilés (depuis dist/):

    • index.js
    • nodes/KDrive/KDrive.node.js
    • nodes/KDrive/GenericFunctions.js
    • nodes/KDrive/KDriveCredentials.api.js
  2. Fichier d'icon (fichier source):

    • src/nodes/KDrive/kdrive.svg

Configuration n8n:

Assurez-vous que votre configuration n8n inclut:

// Dans votre fichier de configuration n8n
module.exports = {
  // ... autres configurations ...
  customExtensions: {
    enabled: true,
    path: '/home/node/.n8n/custom'
  }
}

🐛 Dépannage

Problème: Le node n'apparaît pas dans n8n

  1. Vérifier les permissions:
ls -la /chemin/vers/n8n/custom/
chmod -R 755 /chemin/vers/n8n/custom/
  1. Vérifier les logs:
# Pour une installation standard
journalctl -u n8n -f

# Pour Docker
docker logs votre_conteneur_n8n
  1. Redémarrer n8n:
# Pour une installation standard
sudo systemctl restart n8n

# Pour Docker
docker restart votre_conteneur_n8n

Problème: Erreurs de compilation

  1. Vérifier la version de TypeScript:
npm list typescript
  1. Nettoyer et recomplier:
rm -rf dist/ node_modules/
npm install
npm run build

📝 Notes Importantes

  • Licence: Ce projet est sous licence LGPL-3.0
  • Compatibilité: Testé avec n8n v1.0+ et TypeScript v5.0+
  • Dependencies: Aucune dépendance externe requise pour l'exécution

🎯 Prochaines Étapes

  1. Builder le projet: npm run build
  2. Déployer dans n8n
  3. Configurer les credentials kDrive
  4. Commencer à utiliser le node dans vos workflows

Pour plus d'informations, consulter:

  • README.md - Guide utilisateur
  • IMPLEMENTATION_SUMMARY.md - Détails techniques
  • QUICK_START.md - Guide de démarrage rapide