Comment utiliser une application Node.js sur un hébergement cPanel

Procédure

Qu'est-ce que NodeJS ?

Node.js est un environnement d'exécution open-source et multiplateforme vous permettant de créer un site web ou une application et de l'héberger sur un serveur, avec le langage JavaScript. Sur nos formules cPanel et CloudCP, nous vous mettons à disposition le gestionnaire d'application NodeJS vous permettant de mettre en place une application NodeJS sur votre formule d'hébergement web cPanel. Vous avez à disposition de la version 6.x jusqu'à la version 20.x inclus de NodeJS.

Qu'est-ce que Phusion Passenger ?

Pour mettre à disposition à nos clients un environnement stable et robuste pour NodeJS, nous intégrons vos applications NodeJS avec le service web Apache grâce à l'outil Phusion Passenger.

Nous ne mettons pas en place un reverse proxy, et les applications NodeJS ne peuvent pas s'exécuter en standalone avec son propre serveur web. Si vous avez l'habitude d'exécuter votre serveur NodeJS avec une commande tel que npm run start ou pm2 start myapp, vous ne serez pas en mesure de faire cela sur nos formules d'hébergement cPanel. Si vous utilisez un framework, renseignez-vous de sa compatibilité avec Phusion Passenger.

Comment installer une application NodeJS ?

Connectez-vous à votre interface de gestion cPanel et cliquez sur l'icône "Setup Node.js App".

Dans la page qui s'ensuit, cliquer sur le bouton "Create Application" pour ajouter une nouvelle application.

Remplissez ensuite les champs conformément aux besoins de votre application :

• Node.js version : la version de NodeJS que votre application requiert.
• Application mode : permet de définir le mode d'exécution de votre application, soit en mode développeur, soit en mode production. Cela manipule la variable d'environnement NODE_ENV et permet ainsi, en mode développeur, d'afficher les erreurs (ce qui est utile pour des fins de débogage, mais peut également être problématique pour une application en production).
• Application root : l'emplacement de votre application NodeJS, par rapport à votre racine FTP. Nous vous recommandons de ne pas mettre votre application NodeJS dans le dossier public_html.
• Application URL : l'URL racine de votre application NodeJS.
• Application startup file : le nom du fichier .js que Passenger communiquera à NodeJS pour démarrer votre application.

Cliquez ensuite sur le bouton "Create" une fois que votre application a été paramétrée.

Si votre application startup file n'existe pas encore, l'outil va créer immédiatement ce fichier avec un contenu à titre d'exemple. Cet exemple affichera « It works! » sur toutes les requêtes HTTP associés à celui-ci.

Voici le contenu de ce script d'exemple :

var http = require('http');
var server = http.createServer(function(req, res) {
    res.writeHead(200, {'Content-Type': 'text/plain'});
    var message = 'It works!\n',
        version = 'NodeJS ' + process.versions.node + '\n',
        response = [message, version].join('\n');
    res.end(response);
});
server.listen();

Vous pouvez également éditer le fichier package.json depuis l'interface pour ajouter des dépendances et installer ces dépendances avec le bouton "Run NPM Install" :

Notez qu'il faut redémarrer votre application si ses dépendances ont été modifiées.

Vous pouvez également définir des variables d'environnement dans la section Environment variables si votre application repose sur ces derniers pour obtenir certains paramètres.

Accéder à votre application depuis le terminal

L'utilisation du terminal en ligne de commande est partie intégrante de l'écosystème NodeJS. Pour accéder à l'environnement de votre application depuis le terminal, connectez-vous à celui-ci (depuis le terminal web cPanel ou depuis un client SSH) et copiez la commande indiquée pour entrer dans l'environnement de votre application :

Cette action activera automatiquement le bon environnement virtuel pour votre application, incluant ainsi la bonne version de NodeJS et NPM, ainsi que les dépendances installées dans l'environnement (au lieu d'être installé dans le dossier "node_modules" de votre dossier d'applications).

Déboguer une application NodeJS

Pour déboguer une application NodeJS, vous pouvez consulter le log d'erreur Apache. Le fichier log d'erreurs Apache contient :

• La sortie STDOUT et STDERR de l'application NodeJS
• Les erreurs liées à Passenger
• Les erreurs liées à Apache

Si vous avez défini manuellement la valeur PassengerLogFile dans le fichier .htaccess de votre site, la sortie STDOUT et STDERR ainsi que les erreurs liées à Passenger sont envoyés dans ce fichier au lieu du fichier log Apache.

Vous pouvez aussi mettre la valeur PassengerFriendlyErrorPages sur on dans votre fichier .htaccess pour afficher directement sur le navigateur web les erreurs liés au démarrage de votre application NodeJS.