A Raneto telepítése Ubuntu 17.10-re

A Raneto egy ingyenes, nyílt forráskódú tudásbázis, amely Node.js-re épül, és amely könnyen beállítható és használható, valamint könnyen adminisztrálható. A kategóriák és az oldalak a Markdown-ban vannak írva, ami megkönnyíti a szerkesztést. Ha a Markdown nem a te dolgod, a Raneto lehetővé teszi a HTML használatát is.

Előfeltételek

• VPS Ubuntu 17.10 telepítve.
• SSH hozzáférés a VPS-hez.
• A Linux terminál alapvető ismerete.

Bejelentkezés

Először is be kell jelentkeznünk a szerverünkre SSH használatával. Ehhez nyissa meg kedvenc SSH-kliensét.

ssh root@SERVER_IP

Miután megadta jelszavát (a Vultr irányítópultjáról szerezheti be), bejelentkezik a VPS-be.

A Node.js és a PM2 telepítése

A Raneto a Node.js-n fut, amely egy JavaScript futási környezet és keretrendszer. Ebben az oktatóanyagban a Node.js v8-at fogjuk használni a hosszú távú támogatása miatt. Indítsa el a telepítést a következő parancs beírásával.

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

Miután a szkript futott, futtathatja a fő telepítést.

sudo apt-get install -y nodejs

Amint ez a telepítő befejeződött, a Node.js legfrissebb példánya telepítve lesz a VPS-re. Ezután telepíteni fogjuk a PM2-t, a Node.js folyamatkezelőjét, amely megkönnyíti a Raneto (és sok más Node.js alkalmazás) futtatását.

npm install pm2 -g

Mostantól minden szoftverünk megvan, ami a Raneto telepítéséhez szükséges.

Raneto telepítése

A Git segítségével klónozzuk a Raneto adattárat a szerverünkre.

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

Ezzel létrehoz egy mappát, melynek neve Raneto. Írja be a mappát.

cd Raneto

Telepítse az NPM-et.

npm install

Futtassa a Gulp-ot a következő beírásával.

npm run gulp

Ha a Gulp fut, elindíthatjuk alkalmazásunkat a következő két parancs valamelyikével.

npm start
# or
npm example/server.js

Mostantól hozzáférhet az új Raneto-telepítéshez a címre navigálva SERVER_IP:3000. Az oktatóanyag további része megtanítja Önnek a Raneto további konfigurálását, új oldalak létrehozását, kategóriák hozzáadását, rendezés beállítását, egyéni kezdőlap hozzáadását és a sablon szerkesztését.

További konfigurálás

Most már van egy alapértelmezett Raneto telepítése a VPS-en. Mielőtt bármi máshoz kezdene, azt javaslom, hogy végezzen néhány változtatást az alapértelmezett konfiguráción és beállításon.

Vessünk egy pillantást config.default.jsa examplemappára , amely a mappában található. Ez a konfigurációs fájl meglehetősen hosszú, de ne légy túlterhelve, mert erősen kommentálva van. Íme a szerkesztendő tulajdonságok:

• site_title - Módosítsa ezt a webhely címére.
• base_url- Ezt a webhely URL-címére kell beállítani. Változóként használható oldalak szerkesztésekor.
• support_email- Módosítsa ezt egy érvényes e-mailre. Megjelenik a webhely láblécében.
• copyright - Lábléc szövege.
• analytics - Adjon hozzá egy Google Analytics követőkódot itt.
• allow_editing - Szeretne szerkeszteni fájlokat a webszerkesztővel?
• authentication_for_read - Szeretné, hogy az emberek bejelentkezzenek a weboldal megtekintéséhez?
• credentials - Adjon hozzá felhasználókat ide, ha a bejelentkezés engedélyezett.
• locale - Nyelv.
• datetime_format - A dátum és az idő formátuma.
• home_meta - Szerkessze ezt a kezdőlap metainformációinak módosításához.
• table_of_content - Mutasson Ranetónak egy tartalomjegyzéket?

Az online szerkesztő használata

A Raneto egy könnyen használható online felülettel rendelkezik az oldalak, kategóriák és egyebek kezeléséhez. Bár nem teszi lehetővé mindent, mindenképpen hasznos, ha gyors szerkesztést kell végrehajtania útközben.

Hozzáférhet úgy, hogy engedélyezi a beállítást config.default.js(amint fentebb említettük), majd felkeresi a VPS-t, és rákattint a jobb felső sarokban található bejelentkezés gombra. Adja meg felhasználónevét és jelszavát (ezeket itt módosíthatja config.default.js), majd kattintson a Bejelentkezés gombra. Egyszerűen kattintson a szerkeszteni kívánt oldalra, kattintson a Actionslegördülő menüre, és válassza ki a végrehajtani kívánt műveletet. Oldalakat +a kategória neve melletti gomb megnyomásával adhatunk hozzá , kategóriákat pedig a bal felső sarokban található beviteli mező segítségével hozhatunk létre.

Oldalak hozzáadása

Az oldalak hozzáadása olyan egyszerű, mint egy új Markdown ( .md) dokumentum létrehozása a example/contentmappában.

Miután létrehozott egy új Markdown fájlt, fontos, hogy néhány alapvető információt adjon hozzá a fájl tetejéhez. Nyissa meg a fájlt kedvenc szövegszerkesztőjében. A következőt kell hozzáadnunk a fájl tetejéhez.

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

Ha szükséges, az alábbi változókat is használhatja oldalain:

• %base_url% - Ez lehetővé teszi webhelye URL-címének megemlítését.
• %image_url% - Ez lehetővé teszi a képkönyvtár alap URL-címének lekérését.

Kategóriák hozzáadása

Könnyen hozzáadhat kategóriákat tudásbázisához. Csak hozzon létre egy új mappát a example/contentkönyvtárban, és helyezze el ebbe a mappába az adott kategóriába sorolni kívánt oldalakat. Tegyük fel például, hogy szeretnénk egy kategóriát helpa contact, help-meés az oldalakkal awesome. A fájlok így néznének ki:

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

A kategóriákon belül tetszőleges számú almappát adhat hozzá.

A kategóriák metainformációkkal is rendelkezhetnek. Hozzon létre egy nevű fájlt metaa kategória mappájában. A következő attribútumok támogatottak (minden nem kötelező):

• Cím – Felülbírálja a címet a mappa neve alapján.
• Rendezés – Lehetővé teszi a kategóriák sorrendjének rendezését, ugyanúgy működik, mint az oldalak rendezése.
• ShowOnHome – igaz/hamis.

Egyedi kezdőlap

Ha egyéni kezdőlapot szeretne hozzáadni, mindössze annyit kell tennie, hogy hozzáad egy leértékelési fájlt index.mda example/contentmappájához.

Oldalak rendezése

A Raneto automatikusan ábécé szerint rendezi az oldalakat, de manuális rendezést is alkalmazhat, ha hozzáad egy Sortelemet az oldal metaadataihoz. A rendezés értékének egész számnak kell lennie, például:

Sort: 7

Ez az oldal most a 8-as vagy annál nagyobb rendezési értékű oldalak előtt jelenik meg, de a 6-os vagy annál kisebb értékű oldalak után.

A sablon módosítása

Ha ismeri a HTML-t vagy a CSS-t, könnyen megváltoztathatja Raneto telepítésének kinézetét. A Raneto a Handlebars-t, egy JavaScript-sablonnyelvet használ, amely modularizálja a HTML-szerkesztést. A témafájlokat a themes/defaultmappában találja . Ha további információra van szüksége a Renato-sablonok szerkesztésével kapcsolatban, keresse fel a súgójukat . Miután befejezte a sablon szerkesztését, feltétlenül indítsa újra az alkalmazást.