Hoe Raneto op Ubuntu 17.10 te installeren

• Vereisten
• Inloggen
• Node.js & PM2 installeren
• Raneto installeren
• Verdere configuratie
• Pagina's toevoegen
• Categorieën toevoegen

Raneto is een gratis en open-source kennisbank, gebouwd op Node.js die gemakkelijk te installeren en te gebruiken is, en ook gemakkelijk te beheren. Categorieën en pagina's zijn geschreven in Markdown, waardoor het gemakkelijk te bewerken is. Als Markdown niet jouw ding is, kun je met Raneto ook HTML gebruiken.

Vereisten

• Een VPS met Ubuntu 17.10 geïnstalleerd.
• SSH-toegang tot je VPS.
• Basiskennis van de Linux-terminal.

Inloggen

Eerst moeten we inloggen op onze server met SSH. Om dit te doen, opent u uw favoriete SSH-client.

ssh root@SERVER_IP

Nadat je je wachtwoord hebt ingevoerd (je kunt het verkrijgen via het Vultr-dashboard), word je ingelogd op je VPS.

Node.js & PM2 installeren

Raneto draait op Node.js, een javascript-runtime en framework. In deze zelfstudie gebruiken we Node.js v8 vanwege de langdurige ondersteuning. Start de installatie door de volgende opdracht te typen.

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

Nadat dit script is uitgevoerd, kunt u de hoofdinstallatie uitvoeren.

sudo apt-get install -y nodejs

Zodra dit installatieprogramma is voltooid, heb je een up-to-date exemplaar van Node.js op je VPS geïnstalleerd. Vervolgens gaan we PM2 installeren, een procesmanager voor Node.js die het uitvoeren van Raneto (en vele andere Node.js-applicaties) gemakkelijker maakt.

npm install pm2 -g

We hebben nu alle software die we nodig hebben om Raneto te installeren.

Raneto installeren

We gaan Git gebruiken om de Raneto-repository naar onze server te klonen.

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

Hierdoor wordt een map met de naam gemaakt Raneto. Voer de map in.

cd Raneto

Installeer NPM.

npm install

Voer Gulp uit door het volgende te typen.

npm run gulp

Zodra Gulp is uitgevoerd, kunnen we onze applicatie starten met een van de volgende twee opdrachten.

npm start
# or
npm example/server.js

Je hebt nu toegang tot je nieuwe Raneto-installatie door naar te navigeren SERVER_IP:3000. In de rest van deze tutorial leert u hoe u Raneto verder kunt configureren, nieuwe pagina's kunt maken, categorieën kunt toevoegen, sortering kunt aanpassen, een aangepaste startpagina kunt toevoegen en de sjabloon kunt bewerken.

Verdere configuratie

Je hebt nu een standaard Raneto-installatie gehost op je VPS. Voordat u iets anders gaat doen, raad ik u aan een paar wijzigingen aan te brengen in de standaardconfiguratie en configuratie.

Laten we eens kijken config.default.js, die zich in de examplemap bevindt. Dit configuratiebestand is vrij lang, maar wees alsjeblieft niet overweldigd, omdat er veel commentaar op wordt gegeven. Dit zijn de eigenschappen die u moet bewerken:

• site_title - Wijzig dit in de titel van uw website.
• base_url- Dit moet worden ingesteld op de URL van uw site. Het kan als variabele worden gebruikt bij het bewerken van pagina's.
• support_email- Wijzig dit in een geldig e-mailadres. Het wordt weergegeven in de voettekst van de site.
• copyright - Voettekst.
• analytics - Voeg hier een Google Analytics-trackingcode toe.
• allow_editing - Wil je bestanden kunnen bewerken met de webeditor?
• authentication_for_read - Wil je dat mensen inloggen om de website te bekijken?
• credentials - Voeg gebruikers hier toe als inloggen is ingeschakeld.
• locale - Taal.
• datetime_format - Formaat van de datum en tijd.
• home_meta - Bewerk dit om de metagegevens van uw startpagina te wijzigen.
• table_of_content - Moet Raneto een inhoudsopgave weergeven?

De online editor gebruiken

Raneto wordt geleverd met een gebruiksvriendelijke online interface voor het beheren van pagina's, categorieën en meer. Hoewel u niet alles kunt doen, is het zeker handig als u onderweg snel een bewerking moet uitvoeren.

Je kunt er toegang toe krijgen door de instelling in te schakelen config.default.js(zoals hierboven vermeld) en vervolgens naar je VPS te gaan en op de login-knop in de rechterbovenhoek te klikken. Voer uw gebruikersnaam en wachtwoord in (u kunt deze wijzigen in config.default.js) en klik op inloggen. Klik gewoon op de pagina die u wilt bewerken, klik op de Actionsvervolgkeuzelijst en kies de actie die u wilt voltooien. U kunt pagina's toevoegen door op de +knop naast de categorienaam te drukken en u kunt categorieën maken met behulp van het invoerveld in de linkerbovenhoek.

Pagina's toevoegen

Pagina's toevoegen is net zo eenvoudig als het aanmaken van een nieuw Markdown ( .md) document in de example/contentmap.

Nadat u een nieuw Markdown-bestand heeft gemaakt, is het belangrijk dat u wat basisinformatie aan de bovenkant van het bestand toevoegt. Open het bestand in je favoriete teksteditor. We moeten het volgende toevoegen aan de bovenkant van het bestand.

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

Indien nodig kunt u ook de volgende variabelen op uw pagina's gebruiken:

• %base_url% - Hiermee kunt u de URL van uw website vermelden.
• %image_url% - Hiermee kunt u de basis-URL van uw afbeeldingsdirectory ophalen.

Categorieën toevoegen

U kunt eenvoudig categorieën aan uw kennisbank toevoegen. Maak gewoon een nieuwe map in de example/contentmap en plaats de pagina's die u in die categorie wilt hebben in die map. Stel dat we een categorie willen met de naam helppagina's contact, help-meen awesome. De bestanden zien er als volgt uit:

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

Je kunt zoveel submappen toevoegen als je wilt in categorieën.

Categorieën kunnen ook meta-informatie bevatten. Maak een bestand met de naam metain de categoriemap. De volgende kenmerken worden ondersteund (alle optioneel):

• Titel: overschrijft de titel op basis van de mapnaam.
• Sorteren - Hiermee kunt u de volgorde van categorieën sorteren, werkt op dezelfde manier als het sorteren van pagina's.
• ShowOnHome - waar / onwaar.

Aangepaste homepage

Als u een aangepaste startpagina wilt toevoegen, hoeft u alleen maar een markdown-bestand index.mdaan uw example/contentmap toe te voegen .

Pagina's sorteren

Raneto sorteert pagina's automatisch alfabetisch, maar u kunt een handmatige sortering toepassen door een Sortitem toe te voegen aan de paginameta. De waarde van sorteren moet een geheel getal zijn, bijvoorbeeld:

Sort: 7

Deze pagina verschijnt nu voor pagina's met een sorteerwaarde van 8 of meer, maar na pagina's met een waarde van 6 of minder.

De sjabloon wijzigen

Als u bekend bent met HTML of CSS, kunt u eenvoudig het uiterlijk van uw Raneto-installatie wijzigen. Raneto gebruikt Handlebars, een JavaScript-templating-taal die HTML-bewerking moduleert. Je vindt de themabestanden in de themes/defaultmap. Als u meer informatie wilt over het bewerken van Renato-sjablonen, kunt u hun helpgedeelte bezoeken . Zodra u klaar bent met het bewerken van de sjabloon, moet u de toepassing opnieuw opstarten.