Як встановити 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спадне меню та виберіть дію, яку потрібно виконати. Ви можете додати сторінки, натиснувши +кнопку поруч із назвою категорії, а також створити категорії за допомогою поля введення у верхньому лівому куті.

Додавання сторінок

Додавання сторінок так само просто, як створення нового документа Markdown ( .md) у 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, ви можете відвідати їх розділ довідки . Після завершення редагування шаблону переконайтеся, що ви перезавантажили програму.