Preduvjeti
Prijavljivanje
Instalacija Node.js & PM2
Instalacija Raneta
Daljnja konfiguracija
Dodavanje stranica
Dodavanje kategorija
Raneto je besplatna baza znanja otvorenog koda, izgrađena na Node.js koja je jednostavna za postavljanje i korištenje, kao i za administraciju. Kategorije i stranice su napisane u Markdownu, što olakšava uređivanje. Ako Markdown nije vaša stvar, Raneto vam također omogućuje korištenje HTML-a.
Preduvjeti
- VPS s instaliranim Ubuntu 17.10.
- SSH pristup vašem VPS-u.
- Osnovno razumijevanje Linux terminala.
Prijavljivanje
Prvo se moramo prijaviti na naš poslužitelj koristeći SSH. Da biste to učinili, otvorite svoj omiljeni SSH klijent.
ssh root@SERVER_IP
Nakon što unesete svoju lozinku (možete je dobiti na Vultr nadzornoj ploči) bit ćete prijavljeni na svoj VPS.
Instalacija Node.js & PM2
Raneto radi na Node.js, javascript runtime i framework. U ovom vodiču koristit ćemo Node.js v8 zbog njegove dugoročne podrške. Započnite instalaciju upisivanjem sljedeće naredbe.
curl -sL https://deb.nodesource.com/setup_8.x | sudo -E bash -
Nakon što se ova skripta završi s radom, možete pokrenuti glavnu instalaciju.
sudo apt-get install -y nodejs
Nakon što ovaj instalacijski program završi, imat ćete ažuriranu kopiju Node.js instaliranu na vašem VPS-u. Zatim ćemo instalirati PM2, upravitelj procesa za Node.js koji olakšava pokretanje Raneta (i mnogih drugih Node.js aplikacija).
npm install pm2 -g
Sada imamo sav softver koji nam je potreban da instaliramo Raneto.
Instalacija Raneta
Koristit ćemo Git za kloniranje Raneto spremišta na naš poslužitelj.
git clone https://github.com/gilbitron/Raneto.git
Ovo će stvoriti mapu pod nazivom Raneto. Unesite mapu.
cd Raneto
Instalirajte NPM.
npm install
Pokrenite Gulp upisivanjem sljedećeg.
npm run gulp
Nakon što Gulp završi s radom, možemo pokrenuti našu aplikaciju pomoću jedne od dvije sljedeće naredbe.
npm start
# or
npm example/server.js
Sada ćete moći pristupiti vašoj novoj Raneto instalaciji tako što ćete otići na SERVER_IP:3000. Ostatak ovog vodiča će vas naučiti kako dodatno konfigurirati Raneto, napraviti nove stranice, dodati kategorije, prilagoditi sortiranje, dodati prilagođenu početnu stranicu i urediti predložak.
Daljnja konfiguracija
Sada imate zadanu Raneto instalaciju smještenu na vašem VPS-u. Prije nego počnete raditi bilo što drugo, predlažem da napravite nekoliko promjena u zadanoj konfiguraciji i postavkama.
Pogledajmo config.default.js, koji se nalazi u examplemapi. Ova konfiguracijska datoteka je prilično duga, ali nemojte biti preopterećeni jer je jako komentirana. Ovo su svojstva koja biste trebali urediti:
site_title - Promijenite ovo u naslov svoje web stranice.
base_url- Ovo bi trebalo biti postavljeno na URL vaše web-lokacije. Može se koristiti kao varijabla prilikom uređivanja stranica.
support_email- Promijenite ovo u valjanu e-poštu. Prikazat će se u podnožju stranice.
copyright - Tekst u podnožju.
analytics - Ovdje dodajte kôd za praćenje usluge Google Analytics.
allow_editing - Želite li moći uređivati datoteke pomoću web uređivača?
authentication_for_read - Želite li da se ljudi prijavljuju za pregled web stranice?
credentials - Ovdje dodajte korisnike ako je prijava omogućena.
locale - Jezik.
datetime_format - Format datuma i vremena.
home_meta - Uredite ovo da promijenite meta informacije svoje početne stranice.
table_of_content - Treba li Raneto prikazati sadržaj?
Korištenje mrežnog uređivača
Raneto dolazi s online sučeljem jednostavnim za korištenje za upravljanje stranicama, kategorijama i još mnogo toga. Iako vam ne dopušta da učinite sve, svakako je od pomoći ako trebate napraviti brzu uređivanje u pokretu.
Možete mu pristupiti tako da omogućite postavku u config.default.js(kao što je gore spomenuto), a zatim posjetite svoj VPS i kliknete gumb za prijavu u gornjem desnom kutu. Unesite svoje korisničko ime i lozinku (možete ih promijeniti u config.default.js) i kliknite prijava. Jednostavno kliknite na stranicu koju trebate urediti, kliknite Actionspadajući izbornik i odaberite radnju koju želite dovršiti. Stranice možete dodati pritiskom na +gumb pored naziva kategorije, a kategorije možete kreirati pomoću polja za unos u gornjem lijevom kutu.
Dodavanje stranica
Dodavanje stranica jednostavno je kao stvaranje novog Markdown ( .md) dokumenta u example/contentmapi.
Nakon što izradite novu datoteku Markdown, važno je da dodate neke osnovne informacije na vrh datoteke. Otvorite datoteku u svom omiljenom uređivaču teksta. Moramo dodati sljedeće na vrh datoteke.
/*
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
*/
Ako trebate, možete koristiti i sljedeće varijable na svojim stranicama:
%base_url% - To vam omogućuje da spomenete URL svoje web stranice.
%image_url% - Ovo vam omogućuje da dobijete osnovni URL vašeg imenika slika.
Dodavanje kategorija
Svojoj bazi znanja možete jednostavno dodati kategorije. Samo stvorite novu mapu u example/contentimeniku i stavite stranice koje želite da budu u toj kategoriji u tu mapu. Na primjer, recimo da želimo kategoriju nazvanu helpsa stranicama pod nazivom contact, help-mei awesome. Datoteke bi izgledale ovako:
/example/content/help/contact.md
/example/content/help/help-me.md
/example/content/help/awesome.md
Unutar kategorija možete dodati onoliko podmapa koliko želite.
Kategorije također mogu imati meta informacije. Napravite datoteku pod nazivom metau mapi kategorije. Podržani su sljedeći atributi (svi izborni):
- Naslov - Poništava naslov na temelju naziva mape.
- Sortiraj - Omogućuje vam sortiranje redoslijeda kategorija, radi na isti način kao i sortiranje stranica.
- ShowOnHome - točno/netočno.
Prilagođena početna stranica
Ako želite dodati prilagođenu početnu stranicu, sve što trebate učiniti je dodati markdown datoteku koja se zove index.mdu vašu example/contentmapu.
Razvrstavanje stranica
Raneto automatski sortira stranice po abecedi, ali možete primijeniti ručno sortiranje dodavanjem Sortstavke u meta stranice. Vrijednost sortiranja mora biti cijeli broj, na primjer:
Sort: 7
Ova stranica bi se sada pojavila prije stranica s vrijednošću sortiranja 8 ili više, ali nakon stranica s vrijednošću 6 ili manje.
Promjena predloška
Ako ste upoznati s HTML-om ili CSS-om, lako možete promijeniti izgled svoje Raneto instalacije. Raneto koristi Handlebars, JavaScript šablonski jezik, koji modularizira HTML uređivanje. Datoteke tema možete pronaći u themes/defaultmapi. Ako želite više informacija o uređivanju Renato predložaka, možete posjetiti njihov odjeljak za pomoć . Nakon što završite s uređivanjem predloška, provjerite jeste li ponovno pokrenuli aplikaciju.