Установка и настройка Manifold Scholar

Ubuntu | Amber | Комментировать запись

Manifold – это веб-приложение с открытым исходным кодом, которое позволяет публиковать веб-издания книг и другие текстовые носители, чтобы пользователи могли свободно читать и комментировать эти тексты. Manifold особенно подходит для использования с материалами в открытом доступе (OA) и открытыми образовательными ресурсами (OER): его можно интегрировать в учебные классы, курсы программирования, семинары, библиотеки и другие учреждения, где вы можете обмениваться знаниями посредством совместного чтения.

При поддержке Mellon Foundation приложение Manifold изначально создавалось с учетом научной монографии, но на этой платформе можно собирать, организовывать, читать и комментировать разные виды публикаций (журналы, брошюры, сборники). Хорошим примером публикации на базе Manifold является бесплатная электронная книга How To Code in Python 3.

Данный мануал поможет вам установить Manifold на сервер и добавить текст.

Требования

Для работы вам понадобится сервер Ubuntu 18.04:

• Минимум 1 CPU и предпочтительно 8 Гб RAM (6 Гб минимум).
• Пользователь sudo (настроить его можно с помощью этого мануала).

Чтобы Manifold работал на веб-сайте с URL-адресом, необходимо настроить полное доменное имя. Инструкции по настройке можно найти в документации вашего хостинг-провайдера.

Примечание: Разработчики Manifold не советуют устанавливать Manifold в среде совместного хостинга по соображениям безопасности и стабильности. Manifold состоит из нескольких отдельных сервисов, каждый из которых для правильной работы требует определенного объема оперативной памяти. На небольшой ВМ с менее чем 6 Гб RAM вам, вероятно, потребуется включить своп – иначе вы рискуете использовать всю доступную память.

Если в данный момент вы не настроили доменное имя, вы можете установить имя хоста вручную в /etc/manifold/manifold.rb и перенастроить приложение. Реконфигурация описана ниже.

1: Загрузка и установка Manifold

Итак, давайте загрузим и установим пакет Manifold для Ubuntu 18.04.

Перейдите в каталог временных файлов, чтобы загрузить в него пакет:

cd /tmp

С помощью команды curl с флагом –O (чтобы записать вывод в локальный файл) загрузите пакет на сервер:

curl -O https://storage.googleapis.com/manifold-dist/ubuntu18/manifold_2.0.0~rc.1-1_amd64.deb

Установите пакет:

sudo dpkg -i manifold_2.0.0~rc.1-1_amd64.deb

В выводе команды должны быть такие строки:

...
Manifold Scholarship
manifold: Thank you for installing Manifold!
...

Если в выводе есть эти строки, вы можете перейти к следующему шагу.

2: Обновление брандмауэра

Если вы полностью выполнили начальную настройку сервера, на вашем сервере должен быть установлен брандмауэр UFW. Если у вас нет брандмауэра, вы должны включить его, выполнив соответствующий раздел в мануале по начальной настройке.

Чтобы разрешить трафик http, вы должны открыть порт 80.

sudo ufw allow 80

Вывод должен сообщить, что это правило было добавлено. Вы можете проверить состояние своего брандмауэра с помощью команды sudo ufw status, чтобы увидеть текущие правила на вашем сервере.

3: Настройка Manifold

Если у вас уже есть настроенное полное доменное имя на этом сервере, дополнительная настройка вам может не потребоваться. Она не нужна, если вы получили следующий вывод:

...
manifold: Manifold should be reachable at http://your-manifold-url
...

Однако если вы сейчас используете IP-адрес сервера или если в выводе URL не соответствует вашему адресу, вы можете настроить Manifold и привязать его к правильному адресу.

Откройте файл:

sudo nano /etc/manifold/manifold.rb

Найдите в нем параметр external_url (он будет расположен в верхней части файла). В нем нужно указать IP-адрес сервера или доменное имя установки Manifold.

...
## Manifold URL
##! URL on which Manifold will be reachable.
##! For more details on configuring external_url see:
external_url 'http://your-IP-or-your-URL'

Например, если ваш сайт – example.com, этот параметр будет выглядеть так:

external_url 'http://example.com'

Если ваш IP-адрес – 192.0.2.0, строка будет выглядеть так:

external_url 'http://192.0.2.0'

Теперь сохраните и закройте файл. Для этого нужно нажать Ctrl + X, затем y для подтверждения, а затем Enter.

На этом этапе вы можете перенастроить Manifold с помощью следующей команды.

sudo /usr/local/bin/manifold-ctl reconfigure

Приложение Manifold теперь внедрит все изменения, внесенные в этот файл, и пересоздаст все файлы настроек и конфигурации. Когда этот процесс будет завершен, вы получите такой вывод:

Chef Client finished, 262/347 resources updated in 51 seconds
manifold Reconfigured!

Теперь вы можете посетить URL или IP-адрес вашего сервера. Вы должны увидеть пустую домашнюю страницу Manifold.

Welcome to Manifold. An intuitive, collaborative, open-source platform for scholarly publishing

4: Доступ к бэкэнду

Весь контент, который хранится в Manifold (включая тексты, проекты, авторов, ресурсы и пользователей), управляется через внутренний интерфейс Manifold – через путь /backend.

Чтобы получить доступ к бэкэнду, вам нужно будет создать на сервере администратора. Команду для создания этого пользователя нужно вызывать через исполняемый файл manifold-api.

В команде нужно ввести свои данные, в том числе адрес электронной почты, пароль, имя и фамилию, это делается в следующем формате:

sudo manifold-api manifold:user:create:admin["your_email@domain.com","password","first_name","lastName"]

Например:

sudo manifold-api manifold:user:create:admin["virginia@woolf.com","l1ghth0us3","Virginia","Woolf"]

Команда вернет:

INFO: A User has been created. Its ID is 4a38dbb4-212b-4387-ad32-5e014459cd11

Создав этого пользователя, вернитесь в браузер и кликните по аватарке в правом верхнем углу Manifold, чтобы войти.

После того, как вы введете свои учетные данные и войдите в систему, вы увидите кнопку ENTER ADMIN MODE.

Нажмите эту кнопку, чтобы получить доступ к бэкэнду Manifold.

5: Создание проекта

Бэкэнд откроет вам доступ туда, где будут жить ваши будущие проекты.

Чтобы создать новый проект, нажмите Projects в верхней панели, затем нажмите Add a New Project. Вам будет предложено ввести заголовок, опционально субтитры и описание. Для примера вы можете попробовать загрузить бесплатную книгу How To Code in Python 3, тогда в качестве заголовка можно ввести строку How To Code in Python 3.

После этого можно сохранить проект и нажать Continue.

Когда вы создаете новый проект, он автоматически сохраняется в качестве черновика. Проекты, которые являются черновиками, видны только зарегистрированным пользователям с правами администратора. Используя вкладки слева, вы можете добавить миниатюру, загрузить изображение героя или баннер для общедоступной страницы проекта, а также добавить метаданные и дополнительные ресурсы.

Поскольку Manifold предоставляет вам хранилище для текстов, первое, что вы, вероятно, захотите сделать, это добавить текст. Чтобы вставить текстовый файл в свой проект, откройте вкладку texts.

Вы можете загружать в Manifold файлы EPUB, Markdown и HTML, а также документы Google. Если вы собираетесь работать с документами Google, вам потребуется выполнить некоторые дополнительные настройки. В демонстрационных целях мы загрузим в нашу установку Manifold How To Code в Python 3 EPUB. Найти EPUB книги можно непосредственно по этой ссылке.

Чтобы ввести текст, нажмите кнопку Add a new text.

В нашем примере мы будем использовать приведенную выше ссылку, но вы также можете загрузить или перетащить файл на значок облака, чтобы загрузить файл с локального жесткого диска. Когда вы добавите файл, вы можете нажать Continue. Приложение подключится к веб-сокету Manifold, и после этого можно нажать Ingest, чтобы начать процесс загрузки.

В зависимости от среды размещения и размера файла, который вы загружаете, Manifold может потребоваться несколько минут для загрузки текста. Вы должны увидеть лог, показывающий статус продукта. Когда этот процесс завершится, вы увидите кнопку Complete в нижней части диалогового окна.

Вы увидите, что ваш текст добавлен в UNCATEGORIZED. Используйте стрелку вверх, чтобы переместить файл в состояние PUBLISHED.

Нажмите на ссылку PREVIEW под заголовком проекта рядом со значком глаза, чтобы просмотреть текущий проект. На предпросмотре под заголовком вы должны увидеть кнопку START READING.

После того как вы нажмете эту кнопку, текст должен открыться в Manifold.

Когда вы будете довольны своим проектом, вы можете переключить видимость во вкладке General в интерфейсе администратора, чтобы отключить черновой режим (Draft Mode).

Теперь проект будет доступен на вашей главной странице.

На этом этапе вы можете продолжить работу над проектом: добавить метаданные, изображения и многое другое.

Обратите внимание: если у вас есть домен, связанный с вашей страницей Manifold, и вы хотите, чтобы пользователи могли добавлять файлы, рекомендуется защитить ваш веб-сайт по протоколу HTTPS. Чтобы больше узнать о защите Manifold с помощью бесплатного сертификата Let’s Encrypt, читайте мануал Краткий обзор сервиса Let’s Encrypt.

Заключение

Поздравляем, вы завершили установку Manifold и создали свой первый проект! Теперь на вашем сервере Ubuntu 18.04 есть экземпляр Manifold. Если все прошло по плану, платформа готова к созданию ваших проектов и публикации текстов.

Чтобы узнать больше о проекте Manifold, его разработке и университетах, использующих его, перейдите по следующим ссылкам:

• GitHub репозиторий Manifold
• Manifold в Twitter
• Блог о разработке Manifold
• Канал сообщества Manifold в Slack
• Официальная документация на сайте проекта

Если во время использования Manifold вы столкнетесь с какими-либо проблемами, команда Manifold поможет вам разобраться. Вы можете связаться с ними с помощью раздела поддержки в документации.