Hvordan installere Raneto på Ubuntu 17.10

Raneto er en gratis og åpen kildekode kunnskapsbase, bygget på Node.js som er enkel å sette opp og bruke, samt enkel å administrere. Kategorier og sider er skrevet i Markdown, som gjør det enkelt å redigere. Hvis Markdown ikke er din greie, lar Raneto deg også bruke HTML.

Forutsetninger

• En VPS med Ubuntu 17.10 installert.
• SSH-tilgang til din VPS.
• Grunnleggende forståelse av Linux-terminalen.

Logger inn

Først må vi logge inn på serveren vår ved hjelp av SSH. For å gjøre dette, åpne din favoritt SSH-klient.

ssh root@SERVER_IP

Etter å ha skrevet inn passordet ditt (du kan få det fra Vultr-dashbordet) blir du logget inn på din VPS.

Installerer Node.js & PM2

Raneto kjører på Node.js, en javascript kjøretid og rammeverk. I denne opplæringen bruker vi Node.js v8 på grunn av dens langsiktige støtte. Start installasjonen ved å skrive inn følgende kommando.

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

Etter at dette skriptet er ferdig kjørt, kan du kjøre hovedinstallasjonen.

sudo apt-get install -y nodejs

Når dette installasjonsprogrammet er ferdig, vil du ha en oppdatert kopi av Node.js installert på din VPS. Deretter skal vi installere PM2, en prosessbehandler for Node.js som gjør det enklere å kjøre Raneto (og mange andre Node.js-applikasjoner).

npm install pm2 -g

Vi har nå all programvaren vi trenger for å installere Raneto.

Installerer Raneto

Vi skal bruke Git til å klone Raneto-depotet til serveren vår.

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

Dette vil opprette en mappe kalt Raneto. Gå inn i mappen.

cd Raneto

Installer NPM.

npm install

Kjør Gulp ved å skrive følgende.

npm run gulp

Når Gulp er ferdig med å kjøre, kan vi starte applikasjonen vår ved å bruke en av de to følgende kommandoene.

npm start
# or
npm example/server.js

Du vil nå få tilgang til din nye Raneto-installasjon ved å navigere til SERVER_IP:3000. Resten av denne opplæringen vil lære deg hvordan du kan konfigurere Raneto ytterligere, lage nye sider, legge til kategorier, justere sortering, legge til en egendefinert hjemmeside og redigere malen.

Ytterligere konfigurasjon

Du har nå en standard Raneto-installasjon på din VPS. Før du begynner å gjøre noe annet, foreslår jeg at du gjør noen endringer i standardkonfigurasjonen og oppsettet.

La oss ta en titt på config.default.js, som ligger i examplemappen. Denne konfigurasjonsfilen er ganske lang, men vær så snill å ikke bli overveldet, siden den er mye kommentert. Her er egenskapene du bør redigere:

• site_title - Endre dette til nettstedets tittel.
• base_url– Dette bør settes til nettstedets URL. Den kan brukes som en variabel ved redigering av sider.
• support_email- Endre dette til en gyldig e-post. Det vises i bunnteksten til nettstedet.
• copyright - Bunntekst.
• analytics – Legg til en Google Analytics-sporingskode her.
• allow_editing - Vil du kunne redigere filer ved hjelp av nettredigering?
• authentication_for_read – Vil du at folk skal logge på for å se nettsiden?
• credentials - Legg til brukere her hvis pålogging er aktivert.
• locale - Språk.
• datetime_format - Format for dato og klokkeslett.
• home_meta - Rediger dette for å endre startsidens metainformasjon.
• table_of_content – Bør Raneto vise en innholdsfortegnelse?

Bruke Online Editor

Raneto kommer med et brukervennlig nettgrensesnitt for å administrere sider, kategorier og mer. Selv om det ikke lar deg gjøre alt, er det absolutt nyttig hvis du trenger å gjøre en rask redigering mens du er på farten.

Du får tilgang til den ved å aktivere innstillingen i config.default.js(som nevnt ovenfor) og deretter besøke VPS-en din og klikke på påloggingsknappen øverst til høyre. Skriv inn brukernavn og passord (du kan endre disse i config.default.js) og klikk på logg inn. Bare klikk på siden du trenger å redigere, klikk på Actionsrullegardinmenyen og velg handlingen du vil fullføre. Du kan legge til sider ved å trykke på +knappen ved siden av kategorinavnet, og du kan opprette kategorier ved å bruke inntastingsfeltet øverst i venstre hjørne.

Legger til sider

Å legge til sider er like enkelt som å lage et nytt Markdown ( .md) dokument i example/contentmappen.

Når du har opprettet en ny Markdown-fil, er det viktig at du legger til litt grunnleggende informasjon øverst i filen. Åpne filen i din favoritt tekstredigerer. Vi må legge til følgende øverst i filen.

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

Hvis du trenger det, kan du også bruke følgende variabler på sidene dine:

• %base_url% – Dette lar deg nevne URL-en til nettstedet ditt.
• %image_url% - Dette lar deg få basis-URLen til bildekatalogen din.

Legger til kategorier

Du kan enkelt legge til kategorier i kunnskapsbasen din. Bare opprett en ny mappe i example/contentkatalogen og legg sidene du ønsker skal være i den kategorien i den mappen. Si for eksempel at vi ønsket en kategori kalt helpmed sider kalt contact, help-meog awesome. Filene vil se slik ut:

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

Du kan legge til så mange undermapper du vil i kategorier.

Kategorier kan også ha metainformasjon. Lag en fil som heter metai kategorimappen. Følgende attributter støttes (alle valgfrie):

• Tittel – Overstyrer tittel basert på mappenavn.
• Sorter - Lar deg sortere rekkefølgen på kategorier, fungerer på samme måte som sortering av sider.
• ShowOnHome - sant/usant.

Egendefinert hjemmeside

Hvis du vil legge til en egendefinert hjemmeside, er alt du trenger å gjøre å legge til en nedmerkingsfil kalt index.mdtil example/contentmappen din .

Sortering av sider

Raneto sorterer automatisk sider alfabetisk, men du kan bruke en manuell sortering ved å legge til et Sortelement i sidens meta. Verdien av sort må være et heltall, for eksempel:

Sort: 7

Denne siden vil nå vises foran sider med en sorteringsverdi på 8 eller mer, men etter sider med en verdi på 6 eller mindre.

Endre malen

Hvis du er kjent med HTML eller CSS, kan du enkelt endre utseendet på Raneto-installasjonen. Raneto bruker Handlebars, et JavaScript-malspråk, som modulariserer HTML-redigering. Du finner temafilene i themes/defaultmappen. Hvis du ønsker mer informasjon om redigering av Renato maler, kan du besøke deres hjelp delen . Når du er ferdig med å redigere malen, sørg for at du starter programmet på nytt.