Com instal·lar Raneto a Ubuntu 17.10

Raneto és una base de coneixement gratuïta i de codi obert, basada en Node.js que és fàcil de configurar i utilitzar, així com fàcil d'administrar. Les categories i les pàgines estan escrites a Markdown, cosa que facilita l'edició. Si Markdown no és el vostre, Raneto també us permet utilitzar HTML.

Requisits previs

• Un VPS amb Ubuntu 17.10 instal·lat.
• Accés SSH al vostre VPS.
• Coneixement bàsic del terminal Linux.

Inicia sesió

En primer lloc, hem d'iniciar sessió al nostre servidor mitjançant SSH. Per fer-ho, obriu el vostre client SSH favorit.

ssh root@SERVER_IP

Després d'introduir la vostra contrasenya (la podeu obtenir des del tauler de control de Vultr) iniciareu la sessió al vostre VPS.

Instal·lació de Node.js i PM2

Raneto s'executa a Node.js, un marc i un temps d'execució de javascript. En aquest tutorial, utilitzarem Node.js v8 a causa del seu suport a llarg termini. Inicieu la instal·lació escrivint la següent comanda.

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

Un cop s'hagi acabat d'executar aquest script, podeu executar la instal·lació principal.

sudo apt-get install -y nodejs

Un cop finalitzat aquest instal·lador, tindreu una còpia actualitzada de Node.js instal·lada al vostre VPS. A continuació, instal·larem PM2, un gestor de processos per a Node.js que facilita l'execució de Raneto (i moltes altres aplicacions de Node.js).

npm install pm2 -g

Ara tenim tot el programari que necessitem per instal·lar Raneto.

Instal·lació de Raneto

Utilitzarem Git per clonar el dipòsit de Raneto al nostre servidor.

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

Això crearà una carpeta anomenada Raneto. Entra a la carpeta.

cd Raneto

Instal·leu NPM.

npm install

Executeu Gulp escrivint el següent.

npm run gulp

Un cop s'hagi acabat d'executar Gulp, podem iniciar la nostra aplicació mitjançant una de les dues ordres següents.

npm start
# or
npm example/server.js

Ara podreu accedir a la vostra nova instal·lació de Raneto navegant a SERVER_IP:3000. La resta d'aquest tutorial us ensenyarà a configurar encara més Raneto, crear pàgines noves, afegir categories, ajustar l'ordenació, afegir una pàgina d'inici personalitzada i editar la plantilla.

Configuració addicional

Ara teniu una instal·lació predeterminada de Raneto allotjada al vostre VPS. Abans de començar a fer qualsevol altra cosa, us suggereixo que feu alguns canvis a la configuració i configuració per defecte.

Fem una ullada a config.default.js, que es troba a la examplecarpeta. Aquest fitxer de configuració és força llarg, però si us plau, no us desbordeu, ja que està molt comentat. Aquestes són les propietats que hauríeu d'editar:

• site_title - Canvieu-ho pel títol del vostre lloc web.
• base_url- S'ha d'establir a l'URL del vostre lloc. Es pot utilitzar com a variable en editar pàgines.
• support_email- Canvieu-lo a un correu electrònic vàlid. Es mostrarà al peu de pàgina del lloc.
• copyright - Text del peu de pàgina.
• analytics - Afegiu aquí un codi de seguiment de Google Analytics.
• allow_editing - Vols poder editar fitxers amb l'editor web?
• authentication_for_read - Vols que la gent iniciï sessió per veure el lloc web?
• credentials - Afegiu usuaris aquí si l'inici de sessió està habilitat.
• locale - Llenguatge.
• datetime_format - Format de la data i l'hora.
• home_meta - Editeu-ho per canviar la metainformació de la vostra pàgina d'inici.
• table_of_content - Raneto hauria de mostrar una taula de continguts?

Utilitzant l'editor en línia

Raneto inclou una interfície en línia fàcil d'utilitzar per gestionar pàgines, categories i molt més. Tot i que no us permet fer-ho tot, sens dubte és útil si necessiteu fer una edició ràpida sobre la marxa.

Podeu accedir-hi activant la configuració config.default.js(com s'ha esmentat anteriorment) i després visitant el vostre VPS i fent clic al botó d'inici de sessió a l'extrem superior dret. Introduïu el vostre nom d'usuari i contrasenya (pots canviar-los a config.default.js) i fes clic a Iniciar sessió. Simplement feu clic a la pàgina que voleu editar, feu clic al Actionsmenú desplegable i trieu l'acció que voleu completar. Podeu afegir pàgines prement el +botó que hi ha al costat del nom de la categoria i podeu crear categories mitjançant el camp d'entrada de l'extrem superior esquerre.

Afegint Pàgines

Afegir pàgines és tan senzill com crear un nou .mddocument Markdown ( ) a la example/contentcarpeta.

Un cop hàgiu creat un fitxer Markdown nou, és important que afegiu informació bàsica a la part superior del fitxer. Obriu el fitxer al vostre editor de text preferit. Hem d'afegir el següent a la part superior del fitxer.

/*
 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 ho necessiteu, també podeu utilitzar les variables següents a les vostres pàgines:

• %base_url% - Això us permet esmentar l'URL del vostre lloc web.
• %image_url% - Això us permet obtenir l'URL base del vostre directori d'imatges.

Afegint categories

Podeu afegir categories a la vostra base de coneixements fàcilment. Només example/contentheu de crear una carpeta nova al directori i posar les pàgines que voleu que estiguin en aquesta categoria en aquesta carpeta. Per exemple, diem que volíem una categoria anomenada helpamb pàgines trucades contact, help-mei awesome. Els fitxers tindrien aquest aspecte:

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

Podeu afegir tantes subcarpetes com vulgueu dins de les categories.

Les categories també poden tenir metainformació. Creeu un fitxer anomenat metaa la carpeta de categories. S'admeten els atributs següents (tots opcionals):

• Títol: substitueix el títol en funció del nom de la carpeta.
• Ordenar: us permet ordenar l'ordre de les categories, funciona de la mateixa manera que ordenar pàgines.
• ShowOnHome - vertader/fals.

Pàgina d'inici personalitzada

Si voleu afegir una pàgina d'inici personalitzada, tot el que heu de fer és afegir un fitxer de marcatge anomenat index.mda la vostra example/contentcarpeta.

Ordenant pàgines

Raneto ordena automàticament les pàgines alfabèticament, però podeu aplicar una ordenació manual afegint un Sortelement al meta de la pàgina. El valor de sort ha de ser un nombre enter, per exemple:

Sort: 7

Ara aquesta pàgina apareixerà abans de pàgines amb un valor d'ordenació de 8 o més, però després de pàgines amb un valor de 6 o menys.

Canvi de plantilla

Si esteu familiaritzat amb HTML o CSS, podeu canviar fàcilment l'aspecte de la vostra instal·lació de Raneto. Raneto utilitza Handlebars, un llenguatge de plantilles JavaScript, que modula l'edició HTML. Podeu trobar els fitxers del tema a la themes/defaultcarpeta. Si voleu més informació sobre l'edició de plantilles de Renato, podeu visitar la seva secció d'ajuda . Un cop hàgiu acabat d'editar la plantilla, assegureu-vos de reiniciar l'aplicació.