diff --git a/README.md b/README.md index d752490..6303755 100644 --- a/README.md +++ b/README.md @@ -1,56 +1,88 @@ -# APP Demo +# EiBlog [![Build Status](https://travis-ci.org/eiblog/eiblog.svg?branch=v1.3.0)](https://travis-ci.org/eiblog/eiblog) [![License](https://img.shields.io/badge/license-MIT-brightgreen.svg)](LICENSE.md) [![Versuib](https://img.shields.io/github/tag/eiblog/eiblog.svg)](https://github.com/eiblog/eiblog/releases) -Since there are many Web apps developed, a common development template is put together here. +> 博客项目结构参考模版：https://github.com/deepzz0/appdemo -### New app -1、You need copy `appdemo` to your `GOPATH` and rename: -``` -$ git clone git@github.com:deepzz0/appdemo.git -``` +用过其它博客系统，不喜欢，不够轻，不够快！这是我开发的第二款博客系统，也实在不想再在这件事情上过多纠结了。`EiBlog` 是一个比较稳定的博客系统，现已迭代至 `2.0` 版本，稳定性和维护你是不用担心的。 -3、Enter your app, run: -``` -$ cd -$ make _app -``` +但它有着部署简单（上线复杂！）的特点，不推荐没有计算机知识的朋友搭建，欢迎咨询。该博客的个中优点（简洁、轻快，安全），等你体验。 -3、Push the code to new repo: -``` -$ git add . -$ git commit -m "init repo" -$ git remote add origin -$ git push -u origin master -``` +### 功能特性 -4、`make demo` you can start your web app. - -### Development - -**Step1** - -Understand the directory. +本着博客本质用来分享知识的特点，`EiBlog` 不会有较强的定制功能（包括主题，CDN支持等），仅保持常用简单页面与功能： ``` -. -├── build # Packaging and CI. -├── cmd # Main applications for this app. -├── conf # Static configuration file. -├── docs # Design and user documents. -├── pkg # Library code that's ok to use by external applications. -├── scripts # Scripts to perform various build, install, analysis, etc operations. -├── website # APP's website data. -├── CHANGELOG.md # Record version change. -├── LICENSE # Open source license -├── Makefile # Makefile: call scripts -├── README.md # Read me docs. -└── go.mod # Go mod file. +首页、专题、归档、友链、关于、搜索 ``` +功能说明： +- [x] 博客归档，利用时间线帮助我们将归纳博文，内容少于一年按月归档，大于则按年归档。 +- [x] 博客专题，有时候博文是同一系列，专题能够帮助我们很好归纳博文，对阅读者是非常友好的。 +- [x] 标签系统，每篇博文都可以打上不同标签，使得在归档和专题不满足的情况下自定义归档，这块辅助搜索简直完美。 +- [x] 搜索系统，依托ElasticSearch实现的站内搜索，速度与效率并存，再加上google opensearch，搜索只流畅。 +- [x] 管理后台，内嵌全功能 `Typecho` 后台系统，全功能 `Markdown` 编辑器让你感觉什么是简洁清爽。 +- [x] 谷歌统计，由于google api的速度问题，从而实现了后端API异步统计，使得博客页面加载飞速。 +- [x] Disqus评论，国内评论系统不友好，因此选择disqus，又由于众所周知原因国内不能用，实现另类disqus评论方式。 +- [x] 多存储后端，支持mongodb、mysql、postgres、sqlite等存储后端。 +- [x] 七牛CDN，支持在 `Markdown` 编辑器直接上传附件，让你只考虑编辑内容，解放思想。 +- [x] 自动备份，支持多存储后端的备份功能，备份数据保存到七牛CDN上。 -**Step2** +当然，为了让整个系统加载速度更快，还做了更多优化措施： -Code in pkg and cmd or website. +* 文章评论数量（不重要）通过后端跑定时任务获取，所以有时评论数量是不对的，这样减少了 API 调用。 +* 整站内容全部内存缓存，`mardown` 文档全部转换为 html 进行缓存，减少了转换过程。 +* `.js`、`.css` 等静态文件浏览器本地存储，小图片 base64 内置到 css 中，二次访问不会产生网络带来的延迟，加速访问。通过版本控制更新。 +* 最佳时间 nginx 配置，可以查看 `eiblog.conf`，开启压缩缩小传输量，服务器传输证书链、开启 `Session Resumption`、`Session Ticket`、`OCSP Stapling `等加速证书握手，再次提高速度。 +### 博客页面 +可以容易的看到 [httpsecurityreport](https://httpsecurityreport.com/?report=deepzz.com) 评分`96`，[ssllabs](https://www.ssllabs.com/ssltest/analyze.html?d=deepzz.com&latest) 评分`A+`，[myssl](https://myssl.com/deepzz.com) 评分`A+`，堪称完美。这些安全的相关配置会在后面的部署过程中接触到。 + +相关图片展示： + +![show-home](https://st.deepzz.com/blog/img/show-home.png) +![show-home2](https://st.deepzz.com/blog/img/show-home2.png) + +![show-admin](https://st.deepzz.com/blog/img/show-admin.png) + +![eiblog-mem](https://st.deepzz.com/blog/img/eiblog-mem.png) + +> 注：图片1，图片2是博客界面，图片3是后台界面，图片4是内存占用。 + +### 快速体验 + +1、下载程序压缩包：到 [这里](https://github.com/eiblog/eiblog/releases) 下载，解压缩。 + +2、启动数据库服务，博客支持多种数据库后端：MongoDB、MySQL、Postgres、SQLite等： + +``` +# 修改 conf/app.yml 数据库连接配置 +# driver可选：mongodb、mysql、postgres、sqlite、sqlserver、clickhouse、redis等 +# source为相应的连接地址 +database: + driver: postgres + source: host=localhost port=5432 user=postgres dbname=eiblog sslmode=disable password=MTI3LjAuMC4x +``` + +3、启动 ES 搜索服务，博客使用 ElasticSearch 做为搜索引擎： + +``` +# 修改 conf/app.yml ElasticSearch连接配置 +# 如果不启用搜索功能可以置空 +eshost: http://localhost:9200 +``` + +4、启动博客程序： + +``` +./backend +``` + +### 贡献成员 + +![graphs/contributors](https://opencollective.com/eiblog/contributors.svg?width=890&button=false) + +### 授权许可 + +本项目采用 MIT 开源授权许可证，完整的授权说明已放置在 [LICENSE](https://github.com/eiblog/eiblog/blob/master/LICENSE) 文件中。