Sådan installeres Raneto på Ubuntu 17.10

Raneto er en gratis og open source vidensbase, bygget på Node.js, der er nem at konfigurere og bruge, samt nem at administrere. Kategorier og sider er skrevet i Markdown, hvilket gør det nemt at redigere. Hvis Markdown ikke er din ting, giver Raneto dig også mulighed for at bruge HTML.

Forudsætninger

• En VPS med Ubuntu 17.10 installeret.
• SSH-adgang til din VPS.
• Grundlæggende forståelse af Linux-terminalen.

Logger ind

Først skal vi logge ind på vores server ved hjælp af SSH. For at gøre dette skal du åbne din foretrukne SSH-klient.

ssh root@SERVER_IP

Når du har indtastet din adgangskode (du kan få den fra Vultr-dashboardet), bliver du logget på din VPS.

Installation af Node.js & PM2

Raneto kører på Node.js, et javascript-runtime og framework. I denne tutorial bruger vi Node.js v8 på grund af dens langsigtede support. Start installationen ved at skrive følgende kommando.

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

Når dette script er færdigt med at køre, kan du køre hovedinstallationen.

sudo apt-get install -y nodejs

Når dette installationsprogram er afsluttet, vil du have en opdateret kopi af Node.js installeret på din VPS. Dernæst skal vi installere PM2, en procesmanager for Node.js, der gør det nemmere at køre Raneto (og mange andre Node.js-applikationer).

npm install pm2 -g

Vi har nu al den software, vi skal bruge for at installere Raneto.

Installation af Raneto

Vi vil bruge Git til at klone Raneto-lageret til vores server.

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

Dette vil oprette en mappe kaldet Raneto. Indtast mappen.

cd Raneto

Installer NPM.

npm install

Kør Gulp ved at skrive følgende.

npm run gulp

Når Gulp er færdig med at køre, kan vi starte vores applikation ved hjælp af en af ​​de to følgende kommandoer.

npm start
# or
npm example/server.js

Du vil nu kunne få adgang til din nye Raneto-installation ved at navigere til SERVER_IP:3000. Resten af ​​denne tutorial vil lære dig, hvordan du yderligere konfigurerer Raneto, laver nye sider, tilføjer kategorier, justerer sortering, tilføjer en brugerdefineret hjemmeside og redigerer skabelonen.

Yderligere konfiguration

Du har nu en standard Raneto-installation hostet på din VPS. Før du begynder at gøre noget andet, foreslår jeg, at du foretager et par ændringer til standardkonfigurationen og opsætningen.

Lad os tage et kig på config.default.js, som er placeret i examplemappen. Denne konfigurationsfil er ret lang, men vær venlig ikke at blive overvældet, da den er meget kommenteret. Her er de egenskaber, du bør redigere:

• site_title - Skift dette til dit websteds titel.
• base_url- Dette skal indstilles til dit websteds URL. Den kan bruges som en variabel ved redigering af sider.
• support_email- Skift dette til en gyldig e-mail. Det vises i sidefoden.
• copyright - Sidefodstekst.
• analytics - Tilføj en Google Analytics-sporingskode her.
• allow_editing - Vil du være i stand til at redigere filer ved hjælp af webeditoren?
• authentication_for_read - Vil du have folk til at logge ind for at se hjemmesiden?
• credentials - Tilføj brugere her, hvis login er aktiveret.
• locale - Sprog.
• datetime_format - Format for dato og klokkeslæt.
• home_meta - Rediger dette for at ændre din hjemmesides metaoplysninger.
• table_of_content - Skal Raneto vise en indholdsfortegnelse?

Brug af Online Editor

Raneto kommer med en brugervenlig onlinegrænseflade til styring af sider, kategorier og mere. Selvom det ikke tillader dig at gøre alt, er det bestemt nyttigt, hvis du skal lave en hurtig redigering på farten.

Du kan få adgang til den ved at aktivere indstillingen i config.default.js(som nævnt ovenfor) og derefter besøge din VPS og klikke på login-knappen i øverste højre hjørne. Indtast dit brugernavn og adgangskode (du kan ændre disse i config.default.js), og klik på login. Du skal blot klikke på den side, du skal redigere, klikke på Actionsrullemenuen og vælge den handling, du vil udføre. Du kan tilføje sider ved at trykke på +knappen ved siden af ​​kategorinavnet, og du kan oprette kategorier ved hjælp af indtastningsfeltet i øverste venstre hjørne.

Tilføjelse af sider

Tilføjelse af sider er lige så simpelt som at oprette et nyt Markdown ( .md) dokument i example/contentmappen.

Når du har oprettet en ny Markdown-fil, er det vigtigt, at du tilføjer nogle grundlæggende oplysninger til toppen af ​​filen. Åbn filen i din foretrukne teksteditor. Vi skal tilføje følgende til toppen af ​​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 har brug for det, kan du også bruge følgende variabler på dine sider:

• %base_url% - Dette giver dig mulighed for at nævne URL'en på din hjemmeside.
• %image_url% - Dette giver dig mulighed for at få basis-URL'en til din billedmappe.

Tilføjelse af kategorier

Du kan nemt tilføje kategorier til din videnbase. Du skal bare oprette en ny mappe i example/contentmappen og placere de sider, du ønsker skal være i den kategori, i den mappe. Lad os f.eks. sige, at vi ønskede en kategori kaldet helpmed sider, der hedder contact, help-meog awesome. Filerne ville se sådan ud:

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

Du kan tilføje så mange undermapper, som du vil, inden for kategorier.

Kategorier kan også have metaoplysninger. Opret en fil kaldet metai kategorimappen. Følgende attributter understøttes (alle valgfri):

• Titel - Tilsidesætter titel baseret på mappenavn.
• Sorter - Giver dig mulighed for at sortere rækkefølgen af ​​kategorier, fungerer på samme måde som sortering af sider.
• ShowOnHome - sand/falsk.

Brugerdefineret hjemmeside

Hvis du vil tilføje en brugerdefineret hjemmeside, skal du blot tilføje en markdown-fil, der kaldes index.mdtil din example/contentmappe.

Sortering af sider

Raneto sorterer automatisk sider alfabetisk, men du kan anvende en manuel sortering ved at tilføje et Sortelement til sidens meta. Værdien af ​​sort skal være et heltal, for eksempel:

Sort: 7

Denne side vil nu blive vist før sider med en sorteringsværdi på 8 eller mere, men efter sider med en værdi på 6 eller mindre.

Ændring af skabelonen

Hvis du er fortrolig med HTML eller CSS, kan du nemt ændre udseendet af din Raneto-installation. Raneto bruger Handlebars, et JavaScript-skabelonsprog, der modulariserer HTML-redigering. Du kan finde temafilerne i themes/defaultmappen. Hvis du vil have mere information om redigering af Renato-skabeloner, kan du besøge deres hjælpesektion . Når du er færdig med at redigere skabelonen, skal du sørge for at genstarte applikationen.