Как да инсталирате Raneto на Ubuntu 17.10

Raneto е безплатна база от знания с отворен код, изградена на Node.js, която е лесна за настройка и използване, както и лесна за администриране. Категориите и страниците са написани в Markdown, което го прави лесен за редактиране. Ако Markdown не е вашето нещо, Raneto също ви позволява да използвате HTML.

Предпоставки

• VPS с инсталиран Ubuntu 17.10.
• SSH достъп до вашия VPS.
• Основно разбиране на терминала на Linux.

Влизане

Първо, трябва да влезем в нашия сървър с помощта на SSH. За да направите това, отворете любимия си SSH клиент.

ssh root@SERVER_IP

След като въведете паролата си (можете да я получите от таблото за управление на Vultr), ще влезете във вашия VPS.

Инсталиране на Node.js и PM2

Raneto работи на Node.js, среда за изпълнение на javascript и рамка. В този урок ще използваме Node.js v8 поради неговата дългосрочна поддръжка. Стартирайте инсталацията, като напишете следната команда.

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

След като този скрипт приключи, можете да стартирате основната инсталация.

sudo apt-get install -y nodejs

След като тази инсталационна програма приключи, ще имате актуално копие на Node.js, инсталирано на вашия VPS. След това ще инсталираме PM2, мениджър на процеси за Node.js, който улеснява изпълнението на Raneto (и много други приложения на Node.js).

npm install pm2 -g

Вече имаме целия софтуер, от който се нуждаем, за да инсталираме Raneto.

Инсталиране на Raneto

Ще използваме Git, за да клонираме хранилището на Raneto на нашия сървър.

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

Това ще създаде папка, наречена Raneto. Въведете папката.

cd Raneto

Инсталирайте NPM.

npm install

Стартирайте Gulp, като напишете следното.

npm run gulp

След като Gulp приключи, можем да стартираме нашето приложение, като използваме една от следните две команди.

npm start
# or
npm example/server.js

Вече ще можете да получите достъп до новата си инсталация на Raneto, като отидете до SERVER_IP:3000. Останалата част от този урок ще ви научи как да конфигурирате допълнително Raneto, да създавате нови страници, да добавяте категории, да коригирате сортирането, да добавяте персонализирана начална страница и да редактирате шаблона.

Допълнителна конфигурация

Вече имате инсталация на Raneto по подразбиране, хоствана на вашия VPS. Преди да започнете да правите нещо друго, предлагам да направите няколко промени в конфигурацията и настройката по подразбиране.

Нека да разгледаме config.default.js, който се намира в exampleпапката. Този конфигурационен файл е доста дълъг, но моля, не се претоварвайте, тъй като е силно коментиран. Ето свойствата, които трябва да редактирате:

• site_title - Променете това със заглавието на вашия уебсайт.
• base_url- Това трябва да бъде зададено на URL адреса на вашия сайт. Може да се използва като променлива при редактиране на страници.
• support_email- Променете това на валиден имейл. Ще се покаже в долния колонтитул на сайта.
• copyright - Текст в долния колонтитул.
• analytics - Добавете код за проследяване на Google Analytics тук.
• allow_editing - Искате ли да можете да редактирате файлове с помощта на уеб редактора?
• authentication_for_read - Искате ли хората да влизат, за да видят уебсайта?
• credentials - Добавете потребители тук, ако влизането е активирано.
• locale - Език.
• datetime_format - Формат на датата и часа.
• home_meta - Редактирайте това, за да промените мета информацията на началната си страница.
• table_of_content - Трябва ли Raneto да показва съдържание?

Използване на онлайн редактора

Raneto идва с лесен за използване онлайн интерфейс за управление на страници, категории и други. Въпреки че не ви позволява да правите всичко, със сигурност е полезно, ако трябва да направите бърза редакция в движение.

Можете да получите достъп до него, като активирате настройката в config.default.js(както е споменато по-горе) и след това посетите вашия VPS и щракнете върху бутона за вход в горния десен ъгъл. Въведете вашето потребителско име и парола (можете да ги промените в config.default.js) и щракнете върху вход. Просто щракнете върху страницата, която трябва да редактирате, щракнете върху Actionsпадащото меню и изберете действието, което искате да завършите. Можете да добавяте страници, като натиснете +бутона до името на категорията и можете да създавате категории, като използвате полето за въвеждане в горния ляв ъгъл.

Добавяне на страници

Добавянето на страници е толкова просто, колкото създаването на нов .mdдокумент Markdown ( ) в example/contentпапката.

След като създадете нов файл на Markdown, важно е да добавите основна информация в горната част на файла. Отворете файла в любимия си текстов редактор. Трябва да добавим следното в горната част на файла.

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

Ако трябва, можете също да използвате следните променливи във вашите страници:

• %base_url% - Това ви позволява да споменете URL адреса на вашия уебсайт.
• %image_url% - Това ви позволява да получите основния URL адрес на вашата директория с изображения.

Добавяне на категории

Можете лесно да добавяте категории към вашата база знания. Просто създайте нова папка в example/contentдиректорията и поставете страниците, които искате да бъдат в тази категория, в тази папка. Например, да кажем, че искаме категория, наречена helpсъс страници, наречени contact, help-meи awesome. Файловете ще изглеждат така:

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

Можете да добавите толкова подпапки, колкото искате в категориите.

Категориите също могат да имат мета информация. Създайте файл, наречен metaв папката с категории. Поддържат се следните атрибути (всички по избор):

• Заглавие - Отменя заглавието въз основа на името на папката.
• Сортиране - Позволява ви да сортирате реда на категориите, работи по същия начин като сортирането на страници.
• ShowOnHome - вярно/невярно.

Персонализирана начална страница

Ако искате да добавите персонализирана начална страница, всичко, което трябва да направите, е да добавите файл за маркиране, извикан index.mdкъм вашата example/contentпапка.

Сортиране на страници

Raneto автоматично сортира страниците по азбучен ред, но можете да приложите ръчно сортиране, като добавите Sortелемент към мета страницата. Стойността на сортиране трябва да е цяло число, например:

Sort: 7

Тази страница сега ще се показва преди страници със стойност на сортиране 8 или повече, но след страници със стойност 6 или по-малко.

Промяна на шаблона

Ако сте запознати с HTML или CSS, можете лесно да промените облика на вашата инсталация на Raneto. Raneto използва Handlebars, език за шаблони на JavaScript, който модулира редактирането на HTML. Можете да намерите файловете с теми в themes/defaultпапката. Ако искате повече информация относно редактирането на шаблони на Renato, можете да посетите техния раздел за помощ . След като приключите с редактирането на шаблона, уверете се, че рестартирате приложението.