Ako nainštalovať Raneto na Ubuntu 17.10

Raneto je bezplatná vedomostná základňa s otvoreným zdrojovým kódom postavená na Node.js, ktorá sa ľahko nastavuje a používa a tiež sa jednoducho spravuje. Kategórie a stránky sú napísané v Markdown, čo uľahčuje ich úpravu. Ak vám Markdown nevyhovuje, Raneto vám tiež umožňuje používať HTML.

Predpoklady

• VPS s nainštalovaným Ubuntu 17.10.
• SSH prístup k vášmu VPS.
• Základné pochopenie linuxového terminálu.

Prihlasovanie

Najprv sa musíme prihlásiť na náš server pomocou SSH. Ak to chcete urobiť, otvorte svojho obľúbeného klienta SSH.

ssh root@SERVER_IP

Po zadaní hesla (môžete ho získať z ovládacieho panela Vultr) budete prihlásení do svojho VPS.

Inštalácia Node.js a PM2

Raneto beží na Node.js, javascriptovom runtime a frameworku. V tomto návode budeme používať Node.js v8 kvôli jeho dlhodobej podpore. Spustite inštaláciu zadaním nasledujúceho príkazu.

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

Po dokončení tohto skriptu môžete spustiť hlavnú inštaláciu.

sudo apt-get install -y nodejs

Po dokončení tohto inštalačného programu budete mať na svojom VPS nainštalovanú aktuálnu kópiu Node.js. Ďalej nainštalujeme PM2, správcu procesov pre Node.js, ktorý uľahčuje spustenie Raneto (a mnohých ďalších aplikácií Node.js).

npm install pm2 -g

Teraz máme všetok softvér, ktorý potrebujeme na inštaláciu Raneto.

Inštalácia Raneto

Na klonovanie úložiska Raneto na náš server použijeme Git.

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

Tým sa vytvorí priečinok s názvom Raneto. Zadajte priečinok.

cd Raneto

Nainštalujte NPM.

npm install

Spustite Gulp zadaním nasledujúceho.

npm run gulp

Po spustení Gulpu môžeme spustiť našu aplikáciu pomocou jedného z dvoch nasledujúcich príkazov.

npm start
# or
npm example/server.js

Teraz budete mať prístup k vašej novej inštalácii Raneto tak, že prejdete na SERVER_IP:3000. Zvyšok tohto tutoriálu vás naučí, ako ďalej konfigurovať Raneto, vytvárať nové stránky, pridávať kategórie, upravovať triedenie, pridávať vlastnú domovskú stránku a upravovať šablónu.

Ďalšia konfigurácia

Teraz máte na svojom VPS hosťovanú predvolenú inštaláciu Raneto. Skôr ako začnete robiť čokoľvek iné, navrhujem, aby ste urobili niekoľko zmien v predvolenej konfigurácii a nastavení.

Poďme sa pozrieť na config.default.js, ktorý sa nachádza v examplepriečinku. Tento konfiguračný súbor je pomerne dlhý, ale nenechajte sa zahltiť, pretože je silne komentovaný. Tu sú vlastnosti, ktoré by ste mali upraviť:

• site_title - Zmeňte to na názov svojej webovej stránky.
• base_url– Toto by malo byť nastavené na adresu URL vašej stránky. Dá sa použiť ako premenná pri úprave stránok.
• support_email- Zmeňte toto na platný e-mail. Zobrazí sa v päte lokality.
• copyright - Text päty.
• analytics - Sem pridajte kód sledovania Google Analytics.
• allow_editing - Chcete mať možnosť upravovať súbory pomocou webového editora?
• authentication_for_read - Chcete, aby sa ľudia prihlásili, aby si prezerali webovú stránku?
• credentials - Tu pridajte používateľov, ak je povolené prihlásenie.
• locale - Jazyk.
• datetime_format - Formát dátumu a času.
• home_meta - Upravte toto, ak chcete zmeniť meta informácie svojej domovskej stránky.
• table_of_content - Mal by Raneto zobraziť obsah?

Používanie online editora

Raneto prichádza s ľahko použiteľným online rozhraním na správu stránok, kategórií a ďalších. Aj keď vám to neumožňuje robiť všetko, určite je to užitočné, ak potrebujete urobiť rýchlu úpravu na cestách.

Môžete k nemu pristupovať tak, že povolíte nastavenie v config.default.js(ako je uvedené vyššie) a potom navštívite svoje VPS a kliknete na tlačidlo prihlásenia v pravom hornom rohu. Zadajte svoje používateľské meno a heslo (môžete ich zmeniť v config.default.js) a kliknite na tlačidlo Prihlásiť. Jednoducho kliknite na stránku, ktorú potrebujete upraviť, kliknite na Actionsrozbaľovaciu ponuku a vyberte akciu, ktorú chcete dokončiť. Stránky môžete pridať stlačením +tlačidla vedľa názvu kategórie a kategórie môžete vytvoriť pomocou vstupného poľa v ľavom hornom rohu.

Pridávanie stránok

Pridávanie strán je také jednoduché ako vytvorenie nového .mddokumentu Markdown ( ) v example/contentpriečinku.

Po vytvorení nového súboru Markdown je dôležité, aby ste na začiatok súboru pridali niekoľko základných informácií. Otvorte súbor vo svojom obľúbenom textovom editore. Na začiatok súboru musíme pridať nasledujúce.

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

V prípade potreby môžete na svojich stránkach použiť aj nasledujúce premenné:

• %base_url% - To vám umožní uviesť adresu URL vašej webovej stránky.
• %image_url% - To vám umožní získať základnú adresu URL vášho adresára obrázkov.

Pridávanie kategórií

Kategórie môžete jednoducho pridať do svojej vedomostnej databázy. Stačí vytvoriť nový priečinok v example/contentadresári a do tohto priečinka umiestniť stránky, ktoré chcete v danej kategórii zaradiť. Povedzme napríklad, že chceme kategóriu helps názvom so stránkami s názvom contact, help-mea awesome. Súbory budú vyzerať takto:

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

V rámci kategórií môžete pridať toľko podpriečinkov, koľko chcete.

Kategórie môžu mať aj meta informácie. Vytvorte súbor s názvom metav priečinku kategórie. Podporované sú nasledujúce atribúty (všetky sú voliteľné):

• Title – Prepíše názov podľa názvu priečinka.
• Zoradiť – Umožňuje zoradiť poradie kategórií, funguje rovnako ako triedenie stránok.
• ShowOnHome - pravda/nepravda.

Vlastná domovská stránka

Ak chcete pridať vlastnú domovskú stránku, všetko, čo musíte urobiť, je pridať súbor markdown s názvom index.mddo vášho example/contentpriečinka.

Triedenie stránok

Raneto automaticky triedi stránky podľa abecedy, ale môžete použiť manuálne triedenie pridaním Sortpoložky do meta stránky. Hodnota triedenia musí byť celé číslo, napríklad:

Sort: 7

Táto stránka sa teraz zobrazí pred stránkami s hodnotou zoradenia 8 alebo viac, ale za stránkami s hodnotou 6 alebo menej.

Zmena šablóny

Ak poznáte HTML alebo CSS, môžete jednoducho zmeniť vzhľad svojej inštalácie Raneto. Raneto používa Handlebars, jazyk šablón JavaScriptu, ktorý modularizuje úpravy HTML. Súbory tém nájdete v themes/defaultpriečinku. Ak by ste chceli viac informácií o úprave šablón Renato, môžete navštíviť ich sekciu pomocníka . Po dokončení úprav šablóny nezabudnite reštartovať aplikáciu.