Come installare Raneto su Ubuntu 17.10

• Prerequisiti
• Entrando
• Installazione di Node.js e PM2
• Installazione di Raneto
• Ulteriore configurazione
• Aggiunta di pagine
• Aggiunta di categorie

Raneto è una knowledge base gratuita e open source, costruita su Node.js che è facile da configurare e utilizzare, nonché facile da amministrare. Le categorie e le pagine sono scritte in Markdown, il che semplifica la modifica. Se Markdown non fa per te, Raneto ti consente anche di utilizzare HTML.

Prerequisiti

• Un VPS con Ubuntu 17.10 installato.
• Accesso SSH al tuo VPS.
• Conoscenza di base del terminale Linux.

Entrando

Innanzitutto, dobbiamo accedere al nostro server utilizzando SSH. Per fare ciò, apri il tuo client SSH preferito.

ssh root@SERVER_IP

Dopo aver inserito la password (è possibile ottenerla dalla dashboard di Vultr) si accederà al VPS.

Installazione di Node.js e PM2

Raneto funziona su Node.js, un runtime javascript e un framework. In questo tutorial, utilizzeremo Node.js v8 a causa del suo supporto a lungo termine. Avviare l'installazione digitando il comando seguente.

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

Al termine dell'esecuzione di questo script, è possibile eseguire l'installazione principale.

sudo apt-get install -y nodejs

Al termine dell'installazione, sul VPS sarà installata una copia aggiornata di Node.js. Successivamente, installeremo PM2, un gestore dei processi per Node.js che semplifica l'esecuzione di Raneto (e molte altre applicazioni Node.js).

npm install pm2 -g

Ora abbiamo tutto il software necessario per installare Raneto.

Installazione di Raneto

Utilizzeremo Git per clonare il repository Raneto sul nostro server.

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

Questo creerà una cartella chiamata Raneto. Inserisci la cartella

cd Raneto

Installa NPM.

npm install

Esegui Gulp digitando quanto segue.

npm run gulp

Una volta che Gulp ha terminato l'esecuzione, possiamo avviare la nostra applicazione utilizzando uno dei due seguenti comandi.

npm start
# or
npm example/server.js

Ora sarai in grado di accedere alla tua nuova installazione di Raneto navigando su SERVER_IP:3000. Il resto di questo tutorial ti insegnerà come configurare ulteriormente Raneto, creare nuove pagine, aggiungere categorie, regolare l'ordinamento, aggiungere una homepage personalizzata e modificare il modello.

Ulteriore configurazione

Ora hai un'installazione predefinita di Raneto ospitata sul tuo VPS. Prima di iniziare a fare qualsiasi altra cosa, ti suggerisco di apportare alcune modifiche alla configurazione e all'impostazione predefinite.

Diamo un'occhiata a config.default.js, che si trova nella examplecartella. Questo file di configurazione è piuttosto lungo, ma per favore non essere sopraffatto, poiché è fortemente commentato. Ecco le proprietà che dovresti modificare:

• site_title - Cambia questo nel titolo del tuo sito web.
• base_url- Questo dovrebbe essere impostato sull'URL del tuo sito. Può essere usato come variabile durante la modifica delle pagine.
• support_email- Cambia questo in un indirizzo email valido. Mostrerà nel piè di pagina del sito.
• copyright - Testo piè di pagina.
• analytics - Aggiungi un codice di monitoraggio di Google Analytics qui.
• allow_editing - Vuoi essere in grado di modificare i file usando l'editor web?
• authentication_for_read - Vuoi che le persone accedano per visualizzare il sito Web?
• credentials - Aggiungi utenti qui se l'accesso è abilitato.
• locale - Linguaggio.
• datetime_format - Formato di data e ora.
• home_meta - Modifica questo per cambiare le meta informazioni della tua homepage.
• table_of_content - Raneto dovrebbe mostrare un sommario?

Utilizzando l'editor online

Raneto ha un'interfaccia online facile da usare per la gestione di pagine, categorie e altro. Sebbene non ti permetta di fare tutto, è sicuramente utile se devi apportare una modifica rapida mentre sei in movimento.

Puoi accedervi abilitando l'impostazione config.default.js(come menzionato sopra) e quindi visitando il tuo VPS e facendo clic sul pulsante di accesso nell'angolo in alto a destra. Inserisci il tuo nome utente e password (puoi cambiarli in config.default.js) e fai clic su Accedi. Basta fare clic sulla pagina che è necessario modificare, fare clic sul Actionsmenu a discesa e scegliere l'azione che si desidera completare. Puoi aggiungere pagine premendo il +pulsante accanto al nome della categoria e puoi creare categorie utilizzando il campo di input nell'angolo in alto a sinistra.

Aggiunta di pagine

Aggiungere pagine è semplice come creare un nuovo .mddocumento Markdown ( ) nella example/contentcartella.

Dopo aver creato un nuovo file Markdown, è importante aggiungere alcune informazioni di base all'inizio del file. Apri il file nel tuo editor di testo preferito. Dobbiamo aggiungere quanto segue all'inizio del file.

/*
 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
 */

Se necessario, puoi anche utilizzare le seguenti variabili nelle tue pagine:

• %base_url% - Questo ti permette di menzionare l'URL del tuo sito web.
• %image_url% - Questo ti permette di ottenere l'URL di base della tua directory di immagini.

Aggiunta di categorie

Puoi aggiungere facilmente categorie alla tua knowledge base. Basta creare una nuova cartella nella example/contentdirectory e inserire le pagine in quella categoria in quella cartella. Per esempio, diciamo che volevamo una categoria chiamata helpcon pagine chiamati contact, help-mee awesome. I file sarebbero così:

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

Puoi aggiungere tutte le sottocartelle che desideri all'interno delle categorie.

Le categorie possono anche contenere meta informazioni. Crea un file chiamato metanella cartella della categoria. Sono supportati i seguenti attributi (tutti facoltativi):

• Titolo: sostituisce il titolo in base al nome della cartella.
• Ordina: consente di ordinare l'ordine delle categorie, funziona allo stesso modo delle pagine di ordinamento.
• ShowOnHome - true / false.

Homepage personalizzata

Se vuoi aggiungere una homepage personalizzata, tutto ciò che devi fare è aggiungere un file markdown chiamato index.mdnella tua example/contentcartella.

Ordinamento delle pagine

Raneto ordina automaticamente le pagine in ordine alfabetico, ma è possibile applicare un ordinamento manuale aggiungendo un Sortelemento alla meta pagina. Il valore di ordinamento deve essere un numero intero, ad esempio:

Sort: 7

Questa pagina verrebbe ora visualizzata prima delle pagine con un valore di ordinamento di 8 o superiore, ma dopo le pagine con un valore di 6 o inferiore.

Modifica del modello

Se hai familiarità con HTML o CSS, puoi facilmente cambiare l'aspetto della tua installazione di Raneto. Raneto utilizza il manubrio, un linguaggio di template JavaScript, che modularizza l'editing HTML. Puoi trovare i file del tema nella themes/defaultcartella. Se desideri maggiori informazioni sulla modifica dei modelli Renato, puoi visitare la loro sezione di aiuto . Una volta terminata la modifica del modello, assicurati di riavviare l'applicazione.