Jak nainstalovat Raneto na Ubuntu 17.10

Raneto je bezplatná znalostní báze s otevřeným zdrojovým kódem postavená na Node.js, která se snadno nastavuje a používá a také se snadno spravuje. Kategorie a stránky jsou napsány v Markdown, což usnadňuje jejich úpravy. Pokud vás Markdown nebaví, Raneto vám také umožňuje používat HTML.

Předpoklady

• VPS s nainstalovaným Ubuntu 17.10.
• SSH přístup k vašemu VPS.
• Základní znalost linuxového terminálu.

Přihlášení

Nejprve se musíme přihlásit k našemu serveru pomocí SSH. Chcete-li to provést, otevřete svého oblíbeného klienta SSH.

ssh root@SERVER_IP

Po zadání hesla (můžete ho získat z řídicího panelu Vultr) budete přihlášeni do svého VPS.

Instalace Node.js a PM2

Raneto běží na Node.js, běhovém prostředí a frameworku javascriptu. V tomto tutoriálu budeme používat Node.js v8 kvůli jeho dlouhodobé podpoře. Spusťte instalaci zadáním následujícího příkazu.

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

Po dokončení tohoto skriptu můžete spustit hlavní instalaci.

sudo apt-get install -y nodejs

Po dokončení tohoto instalačního programu budete mít na svém VPS nainstalovanou aktuální kopii Node.js. Dále nainstalujeme PM2, správce procesů pro Node.js, který usnadňuje spouštění Raneto (a mnoha dalších aplikací Node.js).

npm install pm2 -g

Nyní máme veškerý software, který potřebujeme k instalaci Raneta.

Instalace Raneto

Budeme používat Git ke klonování úložiště Raneto na náš server.

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

Tím se vytvoří složka s názvem Raneto. Zadejte složku.

cd Raneto

Nainstalujte NPM.

npm install

Spusťte Gulp zadáním následujícího.

npm run gulp

Jakmile Gulp skončí, můžeme naši aplikaci spustit pomocí jednoho ze dvou následujících příkazů.

npm start
# or
npm example/server.js

Nyní budete mít přístup k vaší nové instalaci Raneto přechodem na SERVER_IP:3000. Zbytek tohoto tutoriálu vás naučí, jak dále konfigurovat Raneto, vytvářet nové stránky, přidávat kategorie, upravovat řazení, přidávat vlastní domovskou stránku a upravovat šablonu.

Další konfigurace

Nyní máte výchozí instalaci Raneto hostovanou na vašem VPS. Než začnete dělat cokoli jiného, ​​navrhuji provést několik změn ve výchozí konfiguraci a nastavení.

Podívejme se na config.default.js, který se nachází ve examplesložce. Tento konfigurační soubor je poměrně dlouhý, ale prosím, nenechte se zahltit, protože je silně komentován. Zde jsou vlastnosti, které byste měli upravit:

• site_title - Změňte toto na název svého webu.
• base_url– Toto by mělo být nastaveno na adresu URL vašeho webu. Lze jej použít jako proměnnou při úpravě stránek.
• support_email- Změňte toto na platný e-mail. Zobrazí se v patičce webu.
• copyright - Text zápatí.
• analytics – Sem přidejte sledovací kód Google Analytics.
• allow_editing - Chcete mít možnost upravovat soubory pomocí webového editoru?
• authentication_for_read - Chcete, aby se lidé přihlásili, aby si prohlíželi web?
• credentials - Zde přidejte uživatele, pokud je povoleno přihlášení.
• locale - Jazyk.
• datetime_format - Formát data a času.
• home_meta - Upravte toto, chcete-li změnit metainformace své domovské stránky.
• table_of_content - Měl by Raneto zobrazit obsah?

Pomocí online editoru

Raneto přichází se snadno použitelným online rozhraním pro správu stránek, kategorií a dalších. I když vám to neumožňuje dělat všechno, určitě je užitečné, pokud potřebujete provést rychlou úpravu na cestách.

Můžete se k němu dostat tak, že povolíte nastavení v config.default.js(jak je uvedeno výše) a poté navštívíte své VPS a kliknete na tlačítko přihlášení v pravém horním rohu. Zadejte své uživatelské jméno a heslo (můžete je změnit v config.default.js) a klikněte na přihlášení. Jednoduše klikněte na stránku, kterou potřebujete upravit, klikněte na Actionsrozbalovací nabídku a vyberte akci, kterou chcete dokončit. Stránky můžete přidat stisknutím +tlačítka vedle názvu kategorie a kategorie můžete vytvořit pomocí vstupního pole v levém horním rohu.

Přidávání stránek

Přidání stránek je stejně jednoduché jako vytvoření nového .mddokumentu Markdown ( ) ve example/contentsložce.

Jakmile vytvoříte nový soubor Markdown, je důležité, abyste na začátek souboru přidali některé základní informace. Otevřete soubor ve svém oblíbeném textovém editoru. Na začátek souboru musíme přidat následující.

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

Pokud potřebujete, můžete na svých stránkách použít také následující proměnné:

• %base_url% - To vám umožní zmínit adresu URL vašeho webu.
• %image_url% - To vám umožní získat základní adresu URL vašeho adresáře s obrázky.

Přidávání kategorií

Kategorie můžete snadno přidat do své znalostní báze. Stačí v example/contentadresáři vytvořit novou složku a do této složky umístit stránky, které chcete v dané kategorii spadat. Řekněme například, že chceme kategorii nazvanou helpse stránkami nazvanými contact, help-mea awesome. Soubory by vypadaly takto:

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

Do kategorií můžete přidat tolik podsložek, kolik chcete.

Kategorie mohou mít také metainformace. Vytvořte soubor s názvem metave složce kategorie. Jsou podporovány následující atributy (vše volitelné):

• Název – Přepíše název podle názvu složky.
• Třídit – Umožňuje seřadit pořadí kategorií, funguje stejně jako řazení stránek.
• ShowOnHome - true/false.

Vlastní domovská stránka

Pokud chcete přidat vlastní domovskou stránku, vše, co musíte udělat, je přidat soubor markdown nazvaný index.mddo vaší example/contentsložky.

Třídění stránek

Raneto automaticky řadí stránky podle abecedy, ale můžete použít ruční řazení přidáním Sortpoložky do meta stránky. Hodnota sort musí být celé číslo, například:

Sort: 7

Tato stránka se nyní zobrazí před stránkami s hodnotou řazení 8 nebo více, ale za stránkami s hodnotou 6 nebo méně.

Změna šablony

Pokud jste obeznámeni s HTML nebo CSS, můžete snadno změnit vzhled své instalace Raneto. Raneto používá Handlebars, šablonovací jazyk JavaScriptu, který modularizuje úpravy HTML. Soubory motivů najdete ve themes/defaultsložce. Pokud byste chtěli další informace o úpravě šablon Renato, můžete navštívit jejich sekci nápovědy . Po dokončení úprav šablony nezapomeňte restartovat aplikaci.