如何安装和设置ManifoldScholar
介绍
Manifold 是一个开源网络应用程序,允许您发布基于网络的书籍版本和其他基于文本的媒体,以便用户可以自由阅读和注释这些文本。 Manifold 特别适合与开放获取 (OA) 材料和开放教育资源 (OER) 一起使用,可融入课堂、编码训练营、研讨会、图书馆和其他您可能希望通过协作阅读交流知识的场所。
Manifold 由梅隆基金会资助,最初是在考虑学术专着的情况下制作的,但可以在平台上收集、组织、阅读和注释许多形式的出版(期刊、小册子、收藏)。 要查看 Manifold 书籍的示例,您可以查看免费电子书 How To Code in Python 3 的 Manifold 版本。
在本教程中,我们将在服务器上设置 Manifold 并向您的安装添加文本。
先决条件
为了开始,您应该具备以下条件:
- 一个 Ubuntu 18.04 服务器,至少有 1 个 CPU,最好是 8 GB RAM(至少 6 GB)。
- 具有 sudo 权限的非 root 用户,您可以按照 Ubuntu 18.04 初始服务器设置指南 来实现。
要使 Manifold 在具有 URL 的网站上运行,您必须设置完全限定的域名。 有关设置的指导,您应该阅读您的托管服务提供商提供的文档。 如果您使用的是 DigitalOcean,您可以在我们关于 如何从公共域注册商 指向 DigitalOcean 名称服务器的教程中找到指导。
注意:出于安全和稳定的原因,Manifold 的开发人员建议不要尝试在共享主机环境中安装 Manifold。 Manifold 由许多不同的服务组成,每个服务都需要 RAM 才能正常运行。 在 RAM 小于 6GB 的小型 VM 上,您可能需要启用交换内存或冒着消耗所有可用内存的风险。
如果您目前尚未设置域名,您可以在 /etc/manifold/manifold.rb
中手动设置主机名并重新配置应用程序。 下面讨论重新配置。
具备这些先决条件后,您就可以开始本教程了。
第 1 步 — 下载并安装 Manifold 包
我们将为 Ubuntu 18.04 下载 Manifold。
首先,进入临时目录下载包,因为包是我们以后可以删除的东西。
cd /tmp
接下来,使用带有 -O
标志的 curl
命令将输出写入本地文件。 这会将包下载到我们的服务器。
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
运行此命令时,您应该会收到包含以下行的输出:
Output... Manifold Scholarship manifold: Thank you for installing Manifold! ...
收到这些行后,您可以继续下一步。
第 2 步 — 更新防火墙
如果您遵循初始服务器设置,您的服务器上应该有一个 ufw
防火墙。 如果您没有安装防火墙,您应该按照初始服务器设置指南的 设置基本防火墙步骤 来实施防火墙。
为了允许网络上通过 http
的流量,您应该打开端口 80。
sudo ufw allow 80
您应该会收到已添加此规则的输出。 您可以通过键入 sudo ufw status
查看您的服务器上的当前规则来检查您的防火墙状态。
第 3 步 — 配置歧管
如果您已经在此服务器上设置了完全限定域名,则可能不需要进行更多配置。 如果您收到与您的域名相匹配的以下输出,这将是正确的:
Output... manifold: Manifold should be reachable at http://your-manifold-url ...
但是,如果您现在使用服务器的 IP 地址,或者上面的输出与您的 URL 不匹配,您可以将 Manifold 配置为指向正确的位置。
在 /etc/manifold/manifold.rb
创建了一个文件,您将使用它来配置和管理构成 Manifold 的各种服务。
在您喜欢的文本编辑器中打开此文件(我们将使用 nano)。
sudo nano /etc/manifold/manifold.rb
在此文件中,查找文件顶部附近的 external_url
设置。 将此设置为您的服务器的 IP 地址或您的 Manifold 安装的域名。
等/歧管/歧管.rb
... ## 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 应用程序现在将实施在此文件中所做的更改,以重新生成新的设置和配置文件。 一旦您收到类似于以下内容的输出,此过程将完成:
OutputChef Client finished, 262/347 resources updated in 51 seconds manifold Reconfigured!
您现在可以访问服务器的 URL 或 IP 地址。 您应该会看到一个空的 Manifold 主页。
提供 Manifold 应用程序后,您可以继续下一步。
第 4 步 — 访问后端
存储在 Manifold 中的所有内容(包括文本、项目、作者、资源和用户)都通过 Manifold 的后端 Web 界面通过 /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"]
运行命令后,您将收到类似于以下内容的输出:
OutputINFO: 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
作为标题。
输入该信息后,您可以保存项目并按 继续 。
当您创建一个新项目时,它会自动保存为 draft 模式。 草稿项目仅对登录的管理用户可见。 使用项目详细视图左侧的选项卡,您可以添加缩略图、为面向公众的项目页面上传主图或横幅,以及添加元数据和其他资源。
由于 Manifold 为您提供了文本存储库,因此您可能想要做的第一件事就是添加文本。 为了将文本文件引入您的项目,请单击 texts 选项卡。
您可以将 EPUB、Markdown 和 HTML 文件或 Google Docs 上传到 Manifold。 如果您要使用 Google Docs,您将需要执行 一些额外的配置 。 出于演示目的,我们将把 How To Code in Python 3 EPUB 上传到我们的 Manifold 安装中。 您可以使用此链接直接链接到电子书的 EPUB:
https://assets.digitalocean.com/books/python/how-to-code-in-python.epub
要引入文本,请单击 添加新文本 按钮开始摄取过程。
在我们的演示中,我们将使用上面的链接,但您也可以上传文件或将文件拖到云图标上以从本地硬盘上传文件。 暂存文件后,可以按 继续 。 该应用程序将连接到 Manifold websocket,您现在可以单击 Ingest 开始上传过程。
根据托管环境和您要上传的文件的大小,Manifold 可能需要几分钟才能提取文本。 您应该会看到一个显示摄取状态输出的日志。 此过程完成后,您将在对话框底部看到一个 Complete 按钮。
按下 Complete 按钮后,您将返回到您的项目。
您会在 UNCATEGORIZED 下看到添加的文本。 使用向上箭头将文件移动到 PUBLISHED 状态。
单击眼睛图标旁边项目标题下方的 PREVIEW 链接以查看您当前的项目。 在预览端,您应该会在标题下方看到一个 START READING 按钮。
按下此按钮后,文本应在歧管阅读器中打开。
当您对项目感到满意时,从管理界面的 General 选项卡中,您可以切换可见性以关闭 Draft Mode。
现在,该项目应该在您的主页上可用。
此时,您可以继续处理项目以添加元数据、图像等。
请注意,如果您有一个与您的 Manifold 页面相关联的域,并且希望用户提供文件,则最佳做法是保护您的网站并通过 HTTPS 协议访问它。 要了解如何使用免费证书颁发机构 Let's Encrypt 保护 Manifold,请阅读我们的教程“Let's Encrypt 简介”
结论
恭喜,您完成了 Manifold 安装并创建了您的第一个项目! 您现在应该在 Ubuntu 18.04 服务器上安装了 Manifold。 如果一切按计划进行,您就可以构建自己的项目并在 Manifold 上发布自己的文本。
要了解有关 Manifold 项目、其开发以及使用它的大学出版社的更多信息,请查看以下链接:
- Manifold 的 GitHub 存储库
- 在 Twitter 上关注 Manifold
- 阅读建筑流形开发博客
- 加入 Manifold Community Slack 频道
- 访问 Manifold 网站 获取官方文档
如果您在使用此软件时遇到任何问题,Manifold 团队欢迎您提供反馈; 您可以通过咨询他们的 文档 的 获取支持部分 与他们取得联系。