Hur man installerar Raneto på Ubuntu 17.10

Raneto är en gratis kunskapsbas med öppen källkod, byggd på Node.js som är enkel att installera och använda, samt lätt att administrera. Kategorier och sidor skrivs i Markdown, vilket gör det enkelt att redigera. Om Markdown inte är din grej, låter Raneto dig också använda HTML.

Förutsättningar

• En VPS med Ubuntu 17.10 installerad.
• SSH-åtkomst till din VPS.
• Grundläggande förståelse för Linux-terminalen.

Loggar in

Först måste vi logga in på vår server med SSH. För att göra detta, öppna din favorit SSH-klient.

ssh root@SERVER_IP

Efter att ha angett ditt lösenord (du kan få det från Vultr-instrumentpanelen) kommer du att loggas in på din VPS.

Installerar Node.js & PM2

Raneto körs på Node.js, en Javascript-körtid och ramverk. I den här handledningen kommer vi att använda Node.js v8 på grund av dess långsiktiga stöd. Starta installationen genom att skriva följande kommando.

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

När det här skriptet har körts klart kan du köra huvudinstallationen.

sudo apt-get install -y nodejs

När det här installationsprogrammet är klart kommer du att ha en uppdaterad kopia av Node.js installerad på din VPS. Därefter ska vi installera PM2, en processhanterare för Node.js som gör det lättare att köra Raneto (och många andra Node.js-applikationer).

npm install pm2 -g

Vi har nu all programvara vi behöver för att installera Raneto.

Installerar Raneto

Vi kommer att använda Git för att klona Raneto-förvaret till vår server.

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

Detta skapar en mapp som heter Raneto. Gå in i mappen.

cd Raneto

Installera NPM.

npm install

Kör Gulp genom att skriva följande.

npm run gulp

När Gulp har kört klart kan vi starta vår applikation med ett av de två följande kommandona.

npm start
# or
npm example/server.js

Du kommer nu att kunna komma åt din nya Raneto-installation genom att navigera till SERVER_IP:3000. Resten av denna handledning kommer att lära dig hur du konfigurerar Raneto ytterligare, skapar nya sidor, lägger till kategorier, justerar sortering, lägger till en anpassad hemsida och redigerar mallen.

Ytterligare konfiguration

Du har nu en standard Raneto-installation på din VPS. Innan du börjar göra något annat föreslår jag att du gör några ändringar i standardkonfigurationen och inställningarna.

Låt oss ta en titt på config.default.js, som finns i examplemappen. Den här konfigurationsfilen är ganska lång, men snälla var inte överväldigad, eftersom den är mycket kommenterad. Här är egenskaperna du bör redigera:

• site_title - Ändra detta till din webbplatstitel.
• base_url- Detta bör ställas in på din webbplats URL. Den kan användas som en variabel vid redigering av sidor.
• support_email- Ändra detta till en giltig e-post. Det kommer att visas i sidans sidfot.
• copyright - Sidfotstext.
• analytics - Lägg till en Google Analytics-spårningskod här.
• allow_editing - Vill du kunna redigera filer med webbredigeraren?
• authentication_for_read – Vill du att folk ska logga in för att se webbplatsen?
• credentials - Lägg till användare här om inloggning är aktiverad.
• locale - Språk.
• datetime_format - Format för datum och tid.
• home_meta - Redigera detta för att ändra din hemsidas metainformation.
• table_of_content - Ska Raneto visa en innehållsförteckning?

Använda Online Editor

Raneto kommer med ett lättanvänt onlinegränssnitt för att hantera sidor, kategorier och mer. Även om det inte tillåter dig att göra allt, är det verkligen användbart om du behöver göra en snabb redigering när du är på språng.

Du kan komma åt den genom att aktivera inställningen i config.default.js(som nämnts ovan) och sedan besöka din VPS och klicka på inloggningsknappen i det övre högra hörnet. Ange ditt användarnamn och lösenord (du kan ändra dessa i config.default.js) och klicka på logga in. Klicka bara på sidan du behöver redigera, klicka på Actionsrullgardinsmenyn och välj den åtgärd du vill slutföra. Du kan lägga till sidor genom att trycka på +knappen bredvid kategorinamnet, och du kan skapa kategorier med inmatningsfältet i det övre vänstra hörnet.

Lägga till sidor

Att lägga till sidor är lika enkelt som att skapa ett nytt Markdown- .mddokument ( ) i example/contentmappen.

När du har skapat en ny Markdown-fil är det viktigt att du lägger till lite grundläggande information överst i filen. Öppna filen i din favorittextredigerare. Vi måste lägga till följande till toppen av 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
 */

Om du behöver kan du även använda följande variabler på dina sidor:

• %base_url% - Detta gör att du kan nämna webbadressen till din webbplats.
• %image_url% - Detta låter dig få basadressen till din bildkatalog.

Lägga till kategorier

Du kan enkelt lägga till kategorier till din kunskapsbas. Skapa bara en ny mapp i example/contentkatalogen och lägg de sidor du vill ska vara i den kategorin i den mappen. Säg till exempel att vi ville ha en kategori som heter helpmed sidor som heter contact, help-meoch awesome. Filerna skulle se ut så här:

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

Du kan lägga till så många undermappar som du vill i kategorier.

Kategorier kan också ha metainformation. Skapa en fil som heter metai kategorimappen. Följande attribut stöds (alla valfria):

• Titel - Åsidosätter titel baserat på mappnamn.
• Sortera - Låter dig sortera ordningen på kategorier, fungerar på samma sätt som att sortera sidor.
• ShowOnHome - sant/falskt.

Anpassad hemsida

Om du vill lägga till en anpassad hemsida behöver du bara lägga till en markdown-fil som kallas index.mdtill din example/contentmapp.

Sortera sidor

Raneto sorterar automatiskt sidor alfabetiskt, men du kan använda en manuell sortering genom att lägga till ett Sortobjekt i sidans meta. Värdet för sort måste vara ett heltal, till exempel:

Sort: 7

Den här sidan skulle nu visas före sidor med ett sorteringsvärde på 8 eller mer, men efter sidor med ett värde på 6 eller mindre.

Ändra mallen

Om du är bekant med HTML eller CSS kan du enkelt ändra utseendet på din Raneto-installation. Raneto använder Handlebars, ett JavaScript-mallspråk, som modulariserar HTML-redigering. Du hittar temafilerna i themes/defaultmappen. Om du vill ha mer information om att redigera Renato-mallar kan du besöka deras hjälpsektion . När du är klar med att redigera mallen, se till att du startar om programmet.