Как установить Raneto в Ubuntu 17.10

• Предпосылки
• Вход в систему
• Установка Node.js и PM2
• Установка Raneto
• Дальнейшая настройка
• Добавление страниц
• Добавление категорий

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

По завершении этого установщика на вашем VPS будет установлена ​​обновленная копия Node.js. Далее мы собираемся установить 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 - true / false.

Пользовательская домашняя страница

Если вы хотите добавить пользовательскую домашнюю страницу, все, что вам нужно сделать, это добавить файл уценки, называемый index.mdвашей example/contentпапкой.

Сортировка страниц

Raneto автоматически сортирует страницы по алфавиту, но вы можете применить сортировку вручную, добавив Sortэлемент в мета-страницу. Значение sort должно быть целым числом, например:

Sort: 7

Эта страница теперь будет отображаться перед страницами со значением сортировки 8 или более, но после страниц со значением 6 или менее.

Изменение шаблона

Если вы знакомы с HTML или CSS, вы можете легко изменить внешний вид вашей установки Raneto. Raneto использует Handlebars, язык шаблонов JavaScript, который модулирует редактирование HTML. Вы можете найти файлы темы в themes/defaultпапке. Если вам нужна дополнительная информация о редактировании шаблонов Renato, вы можете посетить их раздел справки . После того, как вы закончили редактирование шаблона, убедитесь, что вы перезапустите приложение.