About

Posted by Waynerv on

category: default

Tags:

OriginBlog

OriginBlog 是一个由 FlaskMongoDB 驱动的博客项目。

OriginBlog 的开发目标是打造一个轻量、美观且易扩展的博客系统,它具有以下特性:

  • 支持多用户,允许用户发表文章、参与后台管理
  • 基于角色进行权限访问控制,可自定义角色
  • 提供文章、评论、个人页面、分类、标签、归档等通用功能
  • 支持自定义首页组件
  • 支持通过权重排序或隐藏文章
  • 自动根据文章内容生成可跳转目录
  • 以 Markdown 作为主要编辑格式,支持代码高亮
  • 提供功能齐全的后台管理页面
  • 使用 Restful 风格 API 管理后台资源
  • 通过配置文件与环境变量即可修改博客基本设置
  • 支持 Docker + Nginx + Gunicorn + MongoDB 快速部署

运行

从源码运行

  1. 安装 MongoDB(4.0+) 并启动服务器实例。
  2. 切换到项目根目录下的 app 文件夹。
  3. 创建虚拟环境并根据 Pipfilerequirements.txt 安装依赖(推荐使用 Pipenv)。
  4. (可选)在当前目录创建 .env 配置文件,根据 ./originblog/settings.py 文件中的配置项修改应用配置。
  5. 在虚拟环境下,运行 flask run 命令以调试模式启动应用。

开发环境下可使用 flask forge 命令生成测试数据,flask initdb 命令清空数据库。

通过 Docker 运行(推荐)

推荐使用 Docker 运行项目,仓库中还包含了 MongoDB、Nginx 和 Gunicorn 在部署环境下的配置文件,通过 Docker 可以做到自动化快速部署。

使用前请确保已经正确安装 docker 与 docker-compose 。(建议配置国内的加速镜像源)

首次运行

1. 获取 OriginBlog 镜像

在命令行中切换到项目根目录,运行以下命令构建 OriginBlog 镜像:

$ (sudo) docker build app/ -t originblog:0.1 
# 该命令将根据 app/ 文件夹下的 Dockerfile 构建镜像

默认的 Gunicorn 运行参数可在 Dockerfile 中修改,然后重新构建镜像。

你也可以直接从 DockerHub 拉取已构建好的镜像(视网络状况):

$ (sudo) docker pull waynerv/originblog:0.1

2. 修改编排容器的配置文件(可跳过)

a. 修改 docker-compose.yml

切换到项目根目录下的 compose 文件夹。出于安全考虑,你需要对 docker-compose.yml 文件中的环境变量进行适当修改(开发环境可跳过以下步骤),以下是修改项:

  • MONGODB_ADMINUSERNAME:应用程序连接 MongoDB 的用户名
  • MONGODB_ADMINPASSWORD:应用程序连接 MongoDB 的密码
  • MONGO_INITDB_ROOT_USERNAME:MongoDB 的用户管理员用户名
  • MONGO_INITDB_ROOT_PASSWORD:MongoDB 的用户管理员密码

注:后两项配置为开启 MongoDB 认证机制所需参数,创建用户管理员后才可以启用授权认证并为数据库创建用户和分配权限。

b. 修改 MongoDB 运行脚本

若修改了以上配置,还需要对根目录下 mongodb/entrypoint/init_user.sh 脚本文件中对应的共4项用户名和密码进行修改,该数据库脚本为应用程序创建专门的用户。

以上敏感配置项在部署环境下应在使用后删除。MongoDB 和应用容器间的通讯与外部网络请求隔离在不同的网络环境,但建议仍然开启 MongoDB 的验证机制以提高安全性。

c. 修改 Nginx 配置

部署环境下还需要修改项目根目录下 nginx/project.conf 文件,对 Nginx 的映射域名进行修改:

server_name localhost;
# localhost 改成映射的域名

3. 运行容器

切换到根目录下的 compose 文件夹,运行以下命令:

$ (sudo) docker-compose up -d

容器首次启动需要30秒左右,然后你就可以在浏览器中通过 http://localhost:80 访问OriginBlog 了。

除了数据库用户密码以外,应用程序使用的环境变量还可以在 docker.env 文件中修改。

示例:

# MongoDB的连接配置,谨慎修改
MONGO_HOST=mongo 
MONGO_PORT=27017
DB_NAME=originblog

# Flask使用的密钥,应使用随机生成值
SECRET_KEY=random_value1231

# 应用邮件服务器的配置
MAIL_SERVER=xxxx
MAIL_USERNAME=xxxx
MAIL_PASSWORD=xxxx
MAIL_USE_TLS=True
MAIL_PORT=xxxx

# 以此邮箱注册将赋予管理员角色
ORIGINBLOG_ADMIN_EMAIL=xxxx

# SEO相关配置
baidu_submit_url=xxxx
baidu_site_verificatio=xxxx

# 博客内容配置
name=Waynerv's Blog
subtitle=Concentration and Perseverance matter.
description=Origin Blog Description
keywords=python,flask,web,MongoDB
owner=Waynerv

更多配置项参见 ./originblog/settings.py

4. 进入 OriginBlog 容器

如果你想进入 OriginBlog 应用容器的内部,可执行以下命令:

$ (sudo) docker exec -it blog ash
# orginblog 运行在alpine(一个极简Linux)环境中,ash=alpine shell

首次运行后

  • 关闭 OriginBlog
$ (sudo) docker-compose stop
  • 启动 OriginBlog
$ (sudo) docker-compose start
  • 删除 OriginBlog
$ (sudo) docker-compose down

docker-compose 命令应在切换到根目录下 compose/ 文件夹中时执行。

容器运行时产生的数据包括数据库文件可通过 docker volume 进行删除、备份等操作。

使用 OriginBlog

1. 创建管理员账户

ORIGINBLOG_ADMIN_EMAIL 环境参数值为邮箱注册的用户将成为管理员。

开发环境下可使用 Role 模型的 init 方法重置角色权限,然后运行 flask init 注册管理员用户。

2. 进入博客后台

登录后通过首页右上角 USER 下拉菜单的 Dashboard 进入管理后台。

在博客后台可执行发布文章、审核评论、添加用户、增加首页组件、查看统计数据等管理功能。

3. 创建专用页面

专用页面是指博客的介绍、捐赠页面等具有专门作用的页面,该页面将在首页上方的导航栏拥有入口。

创建专用页面首先需要设置 settings.py 文件中BLOG_METAindex_nav 参数(默认最多同时展示两个),然后在后台点击 New Page 创建与 index_nav 同名的文章即可。

4. 修改更多默认配置

你可以通过修改 app/originblog/settings.py 文件,修改 .env 文件或者直接添加环境参数来修改博客的各项配置。

注意 docker.env 配置文件仅在使用 docker-compose 运行容器时有效。

解释

权重:

权重用于排序文章,每篇文章的默认权重为10,如果文章的权重大于10将在首页优先显示;如果权重为负,文章不会在首页显示。

配置文件:

博客所使用的配置项在 app/originblog/settings.py 文件中定义,并在未设置环境参数时使用默认值。以源码运行时创建 app/.env 文件添加环境参数。以 Docker 运行时修改 compose/docker.env 文件添加环境参数。

为何使用 MongoDB:

参见Thinking in Documents

为何在部署时需要启用 MongoDB 的授权认证:

参见MongoDB数据库未授权访问漏洞

依赖

所有依赖均基于当前(2019.4)发布的最新版本。

后端

  • Flask
    • flask-login
    • flask-mail
    • Flask-WTF
    • bootstrap-flask
    • flask-mongoengine
    • flask-moment
  • WTForms
  • mongoengine
  • markdown2
  • bleach

前端

许可证

MIT

更新计划

本项目将持续添加新特性并完善修复现有功能。

  • [ ] 优化后台编辑页面的表单布局
  • [ ] 向管理后台添加内容搜索功能
  • [ ] 使用前端框架实现前后端分离

注:转载本文,请与作者联系




如果觉得文章对您有价值,请作者喝杯咖啡吧

|
donate qrcode

欢迎通过微信与我联系

wechat qrcode

0 Comments latest

No comments.