如何在Ubuntu上安装Raneto
Tianye
・8 分钟阅读
Raneto是一个免费的开源知识库,建立在node js上,易于设置和使用,也易于管理,类别和页面是用Markdown编写的,这使得编辑变得容易,如果Markdown不是你想要的,raneto也允许你使用HTML。
前提条件
- 安装了Ubuntu 的VPS ,
- SSH访问你的VPS ,
- 对Linux终端的基本了解,
正在登录
首先,我们需要使用SSH登录到我们的服务器,为此,打开你最喜欢的SSH客户端。
ssh root@SERVER_IP
安装Node.js
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
接下来,我们将安装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
你现在可以通过导航到SERVER_IP:3000
来访问你的新Raneto安装,本教程的其余部分将教你如何进一步配置Raneto创建新页面、添加类别、调整排序、添加自定义主页和编辑模板。
进一步配置
现在,你的VPS上托管了一个默认的Raneto安装,在开始做其他事情之前,我建议你对缺省配置和设置做一些修改。
让我们看一下config.default.js
,它位于example
文件夹中,这个配置文件很长,但是,请不要被淹没,因为它的注释很多。以下是你应该编辑的属性:
site_title
-将这个更改为你的网站标题,base_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
下拉,并且选择要完成的操作,通过按类别名称旁边的+
按钮可以添加页面,你可以使用左上角的输入字段创建类别。
添加页面
添加页面与在example/content
文件夹中创建新的Markdown (.md
)文档一样简单。
创建了一个新的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%
-这允许你提及网站的网址,%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
的文件,支持以下属性(所有选项):
- Title -根据文件夹名称替代标题,
- Sort -允许对类别排序,与排序页面的方式相同,
- ShowOnHome -true/false ,
自定义主页
如果要添加自定义主页,只需将名为index.md
的Markdown文件添加到example/content
文件夹中。
排序页面
Raneto按字母顺序自动排序页面,但是,你可以通过将Sort
项添加到页元文件来应用手动排序,排序的值必须是整数,例如:
Sort: 7
此页面现在将显示在排序值为8或更大的页面之前,但是,在值为6或更小的页面之后。
更改模板
如果你熟悉HTML或CSS,你可以轻松地更改Raneto安装的外观,Raneto使用Handlebars,一种JavaScript模板语言,模块化HTML编辑。你可以在themes/default
文件夹中找到主题文件,如果你想要更多关于编辑Renato模板的信息,可以访问帮助部分 ,完成模板编辑后,请确保重新启动应用程序。