Skip to content

Latest commit

 

History

History
54 lines (41 loc) · 2.6 KB

README_ZH_CN.md

File metadata and controls

54 lines (41 loc) · 2.6 KB

🕊️ Project Vireo

English README

Vireo是一个基于Lumen (Laravel) 5.8的开源博客系统。

Vireo旨在作为一个轻量级,具有高拓展性和自定义能力的动态博客系统来替代Hexo。

设置服务器

  1. 购买一台服务器和域名(可选)。
  2. 准备生产环境(如果你不是老司机,推荐使用LAMP一键安装脚本):
    • Linux: CentOS 7 or Ubuntu 18.04 recommended
    • Apache httpd 2 (Nginx not recommended)
    • MariaDB 10 (MySQL also acceptable)
    • PHP 7.2.18+
  3. 复制这个仓库并克隆到你的服务器上,然后执行composer install来安装PHP依赖库。
  4. 拷贝一份.env.example并命名为.env,修改.env中的配置,并生成一个越长越好的部署密钥(32位足矣)。
  5. 使用刚刚设置的用户、密码、表名设置MariaDB数据库。
  6. 运行php artisan migrate来移植数据表。
  7. 运行php artisan key:generate来生成存储密钥。
  8. 运行sudo chgrp -R www-data .来改变工程目录的文件夹所有者。注意部分安装环境(如LAMP脚本)中Apache用户的名称是apache而不是www-data
  9. 运行sudo chmod +x auto-deploy.sh来给予脚本可执行权限。
  10. 启动Apache服务端并使用刚才的部署密钥给你的远程仓库添加地址为https://your_site.com/deploy的Webhook。

写作与部署

  1. 将代码克隆到本地(本地需要有PHP和数据库环境)。在/recources文件夹中存放了博客和文档文件夹。
  2. 运行php -S localhost:8000 -t public来启动本地服务器。
  3. 要写博客,运行php artisan vireo:post并输入详细信息。博客文件会生成在/resources/posts/date-slug/content.md
  4. 要写文档,运行php artisan vireo:document并输入详细信息。文档文件会生成在/resources/docs/category-date-slug/content.md
  5. 要添加图片或者附件,只要把它们放在和contend.md同一个文件夹下。
  6. 运行php artisan vireo:cache来更新博客和文档的缓存。
  7. 刷新页面,此时即可看到更新后的内容。

扩展与自定义

  • 你可以添加更多的功能、页面等,详见Laravel开发文档
  • /resources/views文件夹下你可以修改页面的内容。页面渲染使用Laravel blade格式,详见文档。
  • /resources/views/layouts/html_base文件夹下你可以修改页面使用的CSS样式表和JS脚本。

License

Vireo can be distributed under the MIT License.

Used libraries are (through CDN):

  • Bootstrap
  • CookieBanner
  • Fancybox
  • FontAwesome5
  • JQuery
  • MathJax
  • MDBootstrap