Comment installer Raneto sur Ubuntu 17.10

• Conditions préalables
• Se connecter
• Installation de Node.js et PM2
• Installation de Raneto
• Configuration supplémentaire
• Ajout de pages
• Ajout de catégories

Raneto est une base de connaissances gratuite et open-source, construite sur Node.js qui est facile à configurer et à utiliser, ainsi que facile à administrer. Les catégories et les pages sont écrites dans Markdown, ce qui facilite leur modification. Si Markdown n'est pas votre truc, Raneto vous permet également d'utiliser HTML.

Conditions préalables

• Un VPS avec Ubuntu 17.10 installé.
• Accès SSH à votre VPS.
• Compréhension de base du terminal Linux.

Se connecter

Tout d'abord, nous devons nous connecter à notre serveur en utilisant SSH. Pour ce faire, ouvrez votre client SSH préféré.

ssh root@SERVER_IP

Après avoir entré votre mot de passe (vous pouvez l'obtenir à partir du tableau de bord Vultr), vous serez connecté à votre VPS.

Installation de Node.js et PM2

Raneto s'exécute sur Node.js, un environnement d'exécution et un framework javascript. Dans ce didacticiel, nous utiliserons Node.js v8 en raison de sa prise en charge à long terme. Démarrez l'installation en tapant la commande suivante.

curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -

Une fois l'exécution de ce script terminée, vous pouvez exécuter l'installation principale.

sudo apt-get install -y nodejs

Une fois ce programme d'installation terminé, vous aurez une copie à jour de Node.js installée sur votre VPS. Ensuite, nous allons installer PM2, un gestionnaire de processus pour Node.js qui facilite l'exécution de Raneto (et de nombreuses autres applications Node.js).

npm install pm2 -g

Nous avons maintenant tous les logiciels dont nous avons besoin pour installer Raneto.

Installation de Raneto

Nous allons utiliser Git pour cloner le référentiel Raneto sur notre serveur.

git clone https://github.com/gilbitron/Raneto.git

Cela va créer un dossier appelé Raneto. Entrez dans le dossier.

cd Raneto

Installez NPM.

npm install

Exécutez Gulp en tapant ce qui suit.

npm run gulp

Une fois Gulp terminé, nous pouvons démarrer notre application à l'aide de l'une des deux commandes suivantes.

npm start
# or
npm example/server.js

Vous pourrez désormais accéder à votre nouvelle installation Raneto en accédant à SERVER_IP:3000. Le reste de ce tutoriel vous apprendra comment configurer davantage Raneto, créer de nouvelles pages, ajouter des catégories, ajuster le tri, ajouter une page d'accueil personnalisée et modifier le modèle.

Configuration supplémentaire

Vous avez maintenant une installation Raneto par défaut hébergée sur votre VPS. Avant de commencer à faire autre chose, je vous suggère d'apporter quelques modifications à la configuration et à la configuration par défaut.

Jetons un coup d'œil à config.default.js, qui se trouve dans le exampledossier. Ce fichier de configuration est assez long, mais ne soyez pas submergé, car il est fortement commenté. Voici les propriétés que vous devez modifier:

• site_title - Modifiez cela pour le titre de votre site Web.
• base_url- Cela doit être défini sur l'URL de votre site. Il peut être utilisé comme variable lors de l'édition de pages.
• support_email- Remplacez-le par un e-mail valide. Il apparaîtra dans le pied de page du site.
• copyright - Texte de pied de page.
• analytics - Ajoutez un code de suivi Google Analytics ici.
• allow_editing - Voulez-vous pouvoir éditer des fichiers à l'aide de l'éditeur Web?
• authentication_for_read - Voulez-vous que les gens se connectent pour consulter le site Web?
• credentials - Ajoutez des utilisateurs ici si la connexion est activée.
• locale - Langue.
• datetime_format - Format de la date et de l'heure.
• home_meta - Modifiez ceci pour changer les méta-informations de votre page d'accueil.
• table_of_content - Raneto doit-il afficher une table des matières?

Utilisation de l'éditeur en ligne

Raneto est livré avec une interface en ligne facile à utiliser pour gérer les pages, les catégories et plus encore. Bien qu'il ne vous permette pas de tout faire, il est certainement utile si vous devez effectuer une modification rapide en déplacement.

Vous pouvez y accéder en activant le paramètre config.default.js(comme mentionné ci-dessus), puis en visitant votre VPS et en cliquant sur le bouton de connexion dans le coin supérieur droit. Saisissez votre nom d'utilisateur et votre mot de passe (vous pouvez les modifier config.default.js) et cliquez sur connexion. Cliquez simplement sur la page à modifier, cliquez sur le Actionsmenu déroulant et choisissez l'action que vous souhaitez effectuer. Vous pouvez ajouter des pages en appuyant sur le +bouton à côté du nom de la catégorie et vous pouvez créer des catégories en utilisant le champ de saisie dans le coin supérieur gauche.

Ajout de pages

L'ajout de pages est aussi simple que la création d'un nouveau .mddocument Markdown ( ) dans le example/contentdossier.

Une fois que vous avez créé un nouveau fichier Markdown, il est important que vous ajoutiez des informations de base en haut du fichier. Ouvrez le fichier dans votre éditeur de texte préféré. Nous devons ajouter ce qui suit en haut du fichier.

/*
 Title: Enter your page title here, if none is added, the file-name will be used
 Description: Enter your page's description here (for search engines and the site search feature)
 ShowOnHome: true/false
 */

Si vous en avez besoin, vous pouvez également utiliser les variables suivantes dans vos pages:

• %base_url% - Cela vous permet de mentionner l'URL de votre site Web.
• %image_url% - Cela vous permet d'obtenir l'URL de base de votre répertoire d'images.

Ajout de catégories

Vous pouvez facilement ajouter des catégories à votre base de connaissances. Créez simplement un nouveau dossier dans le example/contentrépertoire et placez les pages que vous voulez dans cette catégorie dans ce dossier. Par exemple, supposons que nous voulions une catégorie appelée helpavec des pages appelées contact, help-meet awesome. Les fichiers ressembleraient à ceci:

/example/content/help/contact.md
/example/content/help/help-me.md
/example/content/help/awesome.md

Vous pouvez ajouter autant de sous-dossiers que vous le souhaitez dans les catégories.

Les catégories peuvent également contenir des méta-informations. Créez un fichier appelé metadans le dossier de catégorie. Les attributs suivants sont pris en charge (tous facultatifs):

• Titre - Remplace le titre en fonction du nom du dossier.
• Trier - Vous permet de trier l'ordre des catégories, fonctionne de la même manière que le tri des pages.
• ShowOnHome - vrai / faux.

Page d'accueil personnalisée

Si vous souhaitez ajouter une page d'accueil personnalisée, il vous suffit d'ajouter un fichier de démarque appelé index.mddans votre example/contentdossier.

Pages de tri

Raneto trie automatiquement les pages par ordre alphabétique, mais vous pouvez appliquer un tri manuel en ajoutant un Sortélément à la méta de page. La valeur de sort doit être un entier, par exemple:

Sort: 7

Cette page apparaît désormais avant les pages avec une valeur de tri de 8 ou plus, mais après les pages avec une valeur de 6 ou moins.

Modification du modèle

Si vous connaissez HTML ou CSS, vous pouvez facilement changer l'apparence de votre installation Raneto. Raneto utilise Handlebars, un langage de template JavaScript, qui modularise l'édition HTML. Vous pouvez trouver les fichiers de thème dans le themes/defaultdossier. Si vous souhaitez plus d'informations sur la modification des modèles Renato, vous pouvez visiter leur section d'aide . Une fois que vous avez terminé de modifier le modèle, assurez-vous de redémarrer l'application.