update docs

README.md

@@ -10,6 +10,9 @@
 
 整个博客系统涉及到模块如下：
 
+* 自动更新证书：
+  * 接入 [acme/autocert](https://github.com/golang/crypto/tree/master/acme/autocert)，在 TLS 层开启全自动更新证书，从此证书的更新再也不用惦记了。
+  * 如果你采用如 Nginx 代理，你可能需要 [acme.sh](https://github.com/Neilpang/acme.sh) 实现证书的自动。博主实现 aliyun dns 的自动验证方式，详见 [Makefile/gencert](https://github.com/eiblog/eiblog/blob/master/Makefile)。
 * `MongoDB`，博客采用 mongodb 作为存储数据库。
 * `Elasticsearch`，采用 `elasticsearch` 作为博客的站内搜索，尽管占用内存稍高。
 * `Disqus`，作为博客评论系统，国内大部分被墙，故实现两种评论方式。
@@ -19,7 +22,7 @@
 
 ### 图片展示
 
-可以容易的看到[httpsecurityreport](https://httpsecurityreport.com/?report=deepzz.com)评分`96`，[ssllabs](https://www.ssllabs.com/ssltest/analyze.html?d=deepzz.com&latest)评分`A+`，堪称完美。这些安全的相关配置会在后面的部署过程中接触到。
+可以容易的看到 [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](http://7xokm2.com1.z0.glb.clouddn.com/static/img/show-home1.png)
@@ -35,7 +38,7 @@
 ### 极速体验
 1. 到 [这里](https://github.com/eiblog/eiblog/releases) 下载对应平台 `.tar.gz` 文件。
 
-2. 搭建`MongoDB`（必须）和`Elasticsearch`（可选）服务。
+2. 搭建 `MongoDB`（必须）和 `Elasticsearch`（可选）服务，正式部署需要。
 
 3. 修改 `/etc/hosts` 文件，添加 `MongoDB` 数据库 IP 地址，如：`127.0.0.1       mongodb`。
 
@@ -47,7 +50,7 @@
 ```
 代表运行成功了。
 
-默认监听`9000`端口，后台`/admin/login`，默认账号密码均为`deepzz`。更多详细请查阅[安装部署](https://github.com/eiblog/eiblog/blob/master/docs/install.md)文档。
+默认监听 `HTTP 9000` 端口，后台 `/admin/login`，默认账号密码均为 `deepzz`。更多详细请查阅 [安装部署](https://github.com/eiblog/eiblog/blob/master/docs/install.md) 文档。
 
 ### 特色功能
 
@@ -74,6 +77,7 @@
 
 ### 文档
 
+* [证书更新](https://github.com/eiblog/eiblog/blob/master/docs/autocert.md)
 * [安装部署](https://github.com/eiblog/eiblog/blob/master/docs/install.md)
 * [写作需知](https://github.com/eiblog/eiblog/blob/master/docs/writing.md)
 * [好玩的功能](https://github.com/eiblog/eiblog/blob/master/docs/amusing.md)

docs/autocert.md

@@ -0,0 +1,63 @@
+### 证书自动更新
+
+本博客证书自动更新有两种方式：
+
+* [acme/autocert](https://github.com/golang/crypto/tree/master/acme/autocert)，博客内部集成，通过 tls-sni 验证，实现全自动更新证书，一键开启关闭。请在裸服务器的情况下使用（不要使用代理）。单证书
+* [acme.sh](https://github.com/Neilpang/acme.sh)，强大的 acme 脚本，多种自动更新证书方式，满足你各方面的需求。双证书
+
+#### 方式一
+
+一键开启 autocert 功能，修改 `conf/app.yml` 文件内容：
+
+```
+# 运行模式
+mode:
+  # http server
+  enablehttp: true
+  httpport: 9000
+  # https server
+  enablehttps: true                     # 必须开启
+  autocert: false                       # autocert 功能开关
+  httpsport: 9001
+  certfile: conf/ssl/domain.rsa.pem
+  keyfile: conf/ssl/domain.rsa.key
+  domain: deepzz.com
+```
+
+首先，使用 HTTPS 必须启用  `enablehttps`，它有两个作用：
+
+* 如果 `enablehttp` 开启，会自动 301 重定向到 https。
+* 作为开启 autocert 的前提条件。
+
+其次， `autocert` 是否开启也有两个作用：
+
+* false，服务器将使用 `httpsport`、`certfile`、`keyfile` 作为参数启动 https 服务器。
+* true，服务器直接使用 443 端口启动 https 服务器，并且自动申请证书，且在证书只有 30 天有效期时自动更新证书。域名为 *运行模式* 下的 mode->domain。
+
+#### 方式二
+
+使用方式二，你需要了解 acme.sh 的具体使用方式，非常简单。选择适合自己的方式实现自动更新证书。
+
+博主，这里实现了 aliyun dns 的自动验证，自动更新证书。详情参见 Makefile->gencert。这里实现了自动申请 ecc、rsa 双证书，并且自动申请 scts，自动安装，自动更新。
+
+基本流程如下：
+
+1. 创建相关目录：`/data/eiblog/conf/ssl`、`/data/eiblog/conf/scts/rsa`、`/data/eiblog/conf/scts/ecc`。
+2. 自动下载安装 acme.sh 脚本。
+3. 自动申请 RSA 证书并且自动获取 scts，并且自动安装到指定位置。
+4. 自动申请 ECC 证书并且自动获取 scts，并且自动安装到指定位置。
+
+##### 使用方式
+
+导出环境变量，Aliyun dns 的环境变量为：
+
+```
+export Ali_Key="sdfsdfsdfljlbjkljlkjsdfoiwje"
+export Ali_Secret="jlsdflanljkljlfdsaklkjflsa"
+```
+
+执行命令：
+
+```
+$ make gencert -cn=common_name -sans="-d example.com  -d example1.com"
+```

docs/install.md

@@ -6,23 +6,20 @@ $ curl -L https://github.com/eiblog/eiblog/releases/download/v1.0.0/eiblog-v1.0.
 
 2、如果有幸你也是 `Gopher`，相信你会亲自动手，你可以通过：
 ``` sh
-$ go get https://github.com/eiblog/eiblog
+$ go get -u https://github.com/eiblog/eiblog
 ```
 进行源码编译二进制文件运行。
 
 3、如果你对 `docker` 技术也有研究的话，你也可以通过 `docker` 来安装：
 ``` sh
 $ docker pull registry.cn-hangzhou.aliyuncs.com/deepzz/eiblog:v1.2.0
-
 ```
-镜像内部只提供了`eiblog`的二进制文件，因为其它内容定制化的需求过高。所以需要将`conf`、`static`、`views`目录映射出来，后面会具体说到。
+`注意`，镜像内部没有提供 conf 文件夹内的配置内容，因为该内容定制化的需求过高。所以需要将 `conf` 目录映射出来，后面会具体说到。
 
 ### 本地测试
-在我们下载好可执行程序之后，我们可以开始本地测试的工作了。
+采用二进制包进行测试，在下载好可执行程序之后，我们可以开始本地测试的工作了。本地测试需要搭建两个服务 `mongodb` （必须）和 `elasticsearch2.4.1`（可选，搜索服务不可用）。
 
-本地测试需要搭建两个服务`mongodb`和`elasticsearch2.4.1`（可选，搜索服务不可用）。
+`Eiblog ` 默认会连接 `hostname` 为 `mongodb` 和 `elasticsearch` 的地址，因此你需要将信息填入 `/etc/hosts` 下。假如你搭建的 `mongodb` 地址为 `127.0.0.1:27017`，`elasticsearch` 地址为 `192.168.99.100:9200`，如：
-
-`Eiblog`默认会连接`hostname`为`mongodb`和`elasticsearch`，因此你需要将信息填入`/etc/hosts`下。假如你搭建的`mongodb`地址为`127.0.0.1:27017`，`elasticsearch`地址为`192.168.99.100:9200`，如：
 ``` sh
 $ sudo vi /etc/hosts
 
@@ -31,38 +28,40 @@ $ sudo vi /etc/hosts
 192.168.99.100  elasticsearch
 ```
 
+下面先看两个服务的搭建。
+
 #### MongoDB 搭建
-1、`MongoDB`搭建，Mac 可通过`brew install mongo`进行安装，其它平台请查询资料。
+
+`MongoDB` 搭建，Mac 可通过 `brew install mongo` 进行安装，其它平台请查询资料。
 #### Elasticsearch 搭建
-2、`Elasticsearch`搭建，它的搭建要些许复杂。博主尚未接触如何直接安装，因此建议通过`docker`搭建。需要注意的是 es 自带的分析器对中文分词是不友好的，这里采用了`elasticsearch-analysis-ik`分词器。如果你想了解更多[Github](https://github.com/medcl/elasticsearch-analysis-ik)或则如何实现[博客站内搜索](https://imququ.com/post/elasticsearch.html)。
+`Elasticsearch `搭建，它的搭建要些许复杂。建议通过 `docker` 搭建。需要注意的是 es 自带的分析器对中文分词是不友好的，这里采用了 `elasticsearch-analysis-ik` 分词器。如果你想了解更多 [Github](https://github.com/medcl/elasticsearch-analysis-ik) 或则如何实现 [博客站内搜索](https://imququ.com/post/elasticsearch.html)。
 
-* pull 镜像`docker pull elasticsearch:2.4.1`，必需使用该版本。
+1. pull 镜像  `docker pull elasticsearch:2.4.1`。
-* 添加环境变量`ES_JAVA_OPTS: "-Xms512m -Xmx512m"`，除非你想让你的服务器爆掉。
+
-* 映射相关目录：
+2. 添加环境变量 `ES_JAVA_OPTS: "-Xms512m -Xmx512m"`，除非你想让你的服务器爆掉。
+
+3. 映射相关目录：
 
    ```
-  conf/es/config:/usr/share/elasticsearch/config
+   $PWD/conf/es/config:/usr/share/elasticsearch/config
-  conf/es/plugins:/usr/share/elasticsearch/plugins
+   $PWD/conf/es/plugins:/usr/share/elasticsearch/plugins
-  conf/es/data:/usr/share/elasticsearch/data
-  conf/es/logs:/usr/share/elasticsearch/logs
    ```
-  请将这四个目录映射至`eiblog`下的`conf`目录。如果你想查看更多，请查看`docker-compose.yml`文件。
+
+博主已经准备好了必要的 es 配置文件，请将这四个目录映射至 `eiblog` 下的 `conf` 目录。如果你想查看更多，请查看 `docker-compose.yml` 文件。
 
 总结一下，`docker` 运行 es 的命令为：
 ``` sh
 $ docker run -d --name eisearch \
     -p 9200:9200 \
-    -e ES_JAVA_OPTS: "-Xms512m -Xmx512m" \
+    -e ES_JAVA_OPTS="-Xms512m -Xmx512m" \
-    -v conf/es/config:/usr/share/elasticsearch/config \
+    -v $PWD/conf/es/config:/usr/share/elasticsearch/config \
-    -v conf/es/plugins:/usr/share/elasticsearch/plugins \
+    -v $PWD/conf/es/plugins:/usr/share/elasticsearch/plugins \
-    -v conf/es/data:/usr/share/elasticsearch/data \
-    -v conf/es/logs:/usr/share/elasticsearch/logs \
     elasticsearch:2.4.1
 ```
 
 之后执行 `./eiblog`，咱们的 `eiblog` 就可以运行起来了。
 
-通过`127.0.0.1:9000`可以进入博客首页，`127.0.0.1:9000/admin/login`进入后台登陆，账号密码为`eiblog/conf/app.yml`下的`username`和`password`。也就是初始账号密码`deepz`、`deepzz`。
+通过 `127.0.0.1:9000` 可以进入博客首页，`127.0.0.1:9000/admin/login` 进入后台登陆，账号密码为 `eiblog/conf/app.yml` 下的 `username` 和 `password`。初始账号密码 `deepz`、`deepzz`。
 
 > `注意`，因为配置 `conf/app.yml` 均是博主自用配置。有些操作可能（如评论）会评论到我的博客，还请尽量避免，谢谢。
 
@@ -76,7 +75,7 @@ $ docker run -d --name eisearch \
 
 * `一台服务器`。
 * `一个域名`，国内服务器需备案。
-* `有效的证书`。一般使用免费的就可以。如：`Let‘s Encrypt`，另外`qcloud`、`七牛`也提供了免费证书的申请，均是全球可信。
+* `有效的证书`。通过开启 autocert 可自动申请更新证书。也可去七牛、qcloud 申请一年有效证书。
 * `七牛CDN`。博客只设计接入了 七牛cdn，相信该 CDN 服务商不会让你失望。
 * `Disqus`。作为博客评论系统，你得有翻墙的能力注册到该账号，具体配置我想又可以写一片博客了。简单说需要 `shorname` 和 `public key`。
 * `Google Analystic`。数据统计分析工具。
@@ -85,18 +84,16 @@ $ docker run -d --name eisearch \
 
 是不是这么多要求，很费解。其实当初该博客系统只是为个人而设计的，是自己心中想要的那一款。博主些这篇文章不是想要多少人来用该博客，而是希望对那些追求至极的朋友说：你需要这款博客系统。
 #### 文件准备
-尽管大多数文件已经准备好。但有些默认的文件需要特别指出来，需要你在 CDN 上写特殊的路径。
+博主是一个有强迫症的人，一些文件的路径我使用了固定的路径，请大家见谅。假如你的 cdn 域名为 `st.example.com`，你需要确定这些文件已经在你的 cdn 中，它们路径分别是：
 
-假如你的 CDN 域名为`st.example.com`，那么请确保你的 CDN 中已经上传以下文件：
+* `favicon.ico`，默认为 `st.example.com/static/img/favicon.ico`。故你在 cdn 中的文件名为 `static/img/favicon.ico`，以下如是。
+* `bg04.jpg`，左侧背景图片，`500*1200` 左右，cdn 文件名：`static/img/bg04.jpg`。如需更改，请在 `eiblog/view/st_blog.css` 中替换该名称。
+* `avatar.jpg`，左侧头像，`160*160~256*256`之间，cdn 文件名：`static/img/avatar.jpg`。
+* `blank.gif`，cdn 文件名：`static/img/blank.gif`。该图片请从 [这里](https://st.deepzz.com/static/img/blank.gif) 下载并上传至你的 cdn。
+* `default_avatar.png`，Disqus 默认头像，cdn 文件名：`static/img/default_avatar.png`，请从 [这里](https://st.deepzz.com/static/img/default_avatar.png) 下载并上传至你的 cdn。
+* `disqus.js`，该文件是专属的，通过 https://short_name.disqus.com/embed.js 下载，替换掉 short_name。，cdn 文件名格式是：`static/js/disqus_xxx.js`。在我写这篇文章是使用的是：`static/js/disqus_a9d3fd.js`。另外修改 `eiblog/views/st_blog.js` 中的`disqus_a9d3fd.js` 为你新文件的名称，提升一个静态文件版本（请看配置文件说明）。
 
-* `favicon.ico`，默认为`st.example.com/static/img/favicon.ico`。故你在 CDN 中的文件名为`static/img/favicon.ico`，以下如是。
+> 注意：每次修改 views 内的以 `st_` 开头的文件，请将 `app.yml` 中的 staticversion 提高一个版本。 cdn 提到的文件下载，请复制链接进行下载，因为博主使用了防盗链功能。
-* `bg04.jpg`，左侧背景图片，`500*1200`左右，CDN 中文件名：`static/img/bg04.jpg`。如需更改，请在`eiblog/view/st_blog.css`中替换该名称。
-* `avatar.jpg`，左侧头像，`160*160~256*256`之间，CDN 文件名：`static/img/avatar.jpg`。另外你需要将该图片 `Base64` 编码后替换掉`eiblog/views/st_blog.css`中合适位置的图片。
-* `blank.gif`，CDN 文件名：`static/img/blank.gif`。该图片请从[这里](https://st.deepzz.com/static/img/blank.gif)下载并上传至你的 CDN。
-* `default_avatar.png`，Disqus 默认头像，CDN 文件名：`static/img/default_avatar.png`，请从[这里](https://st.deepzz.com/static/img/default_avatar.png)下载并上传至你的 CDN。
-* `disqus.js`，通过 https://short_name.disqus.com/embed.js 下载，替换掉 short_name。CDN 文件名格式是：`static/js/disqus_xxx.js`。在我写这篇文章是使用的是：`static/js/disqus_a9d3fd.js`。另外修改`eiblog/views/st_blog.js`中的`disqus_a9d3fd.js`为你新文件的名称。
-
-> 注意：每次修改 views 内的以 `st_` 开头的文件，请将 `app.yml` 中的 staticversion 提高一个版本。 
 
 #### 配置说明
 走到这里，我相信只走到 `60%` 的路程。放弃还来得及。
@@ -115,16 +112,20 @@ $ docker run -d --name eisearch \
 │       └── ik1.10.1                # ik 分词器
 ├── nginx                           # nginx 配置
 │   ├── domain                      # 域名配置，nginx 会读区改文件夹下的 .conf 文件
-│   │   └── deepzz.conf
+│   │   └── eiblog.conf
 │   ├── ip.blacklist                # nginx ip黑名单
-│   └── nginx.conf                  # nginx配置，请替换原有配置
+│   └── nginx.conf                  # nginx 配置，请替换 nginx 原有配置
-├── scts                            # ct文件
+├── scts                            # ct 透明
+│   ├── ecc
+│   │   ├── aviator.sct
+│   │   └── digicert.sct
+│   └── rsa
 │       ├── aviator.sct
 │       └── digicert.sct
-├── ssl                             # 证书文件，具体请看deepzz.conf
+├── ssl                             # 证书相关文件，可参考 eiblog.conf 生成
 │   ├── dhparams.pem
-│   ├── domain.key
+│   ├── domain.rsa.key
-│   ├── domain.pem
+│   ├── domain.rsa.pem
 │   ├── full_chained.pem
 │   └── session_ticket.key
 └── tpl                             # 模版文件
@@ -133,7 +134,6 @@ $ docker run -d --name eisearch \
     ├── opensearchTpl.xml
     ├── robotsTpl.xml
     └── sitemapTpl.xml
-
 ```
 1、app.yml，整个程序的配置文件，里面已经列出了所有配置项的说明，这里不再阐述。 
 2、blackip.yml，如果没有使用 `Nginx`，博客内置 `ip` 过滤系统。 
@@ -153,7 +153,7 @@ $ docker run -d --name eisearch \
 
 > `注意`，scripts 文件夹虽然是空的，但必需存在，不然 elasticsearch 报错。
 
-4、`nginx`，系统采用`nginx`作为代理(相信博客系统也不会独占一台服务器～)。请使用`nginx.conf`替换原`nginx`的配置。博客系统的配置文件是`domain/deepzz.conf`，或则重命名(只要是满足`*.conf`)。`deepzz.conf`文件里面学问是最多的。或许你想一一弄懂，或许…。
+4、`nginx`，系统采用 `nginx` 作为代理(相信博客系统也不会独占一台服务器～)。请使用 `nginx.conf` 替换原 `nginx` 的配置。博客系统的配置文件是 `domain/eiblog.conf`，或则重命名(只要是满足`*.conf`)。`eiblog.conf`文件里面学问是最多的。或许你想一一弄懂，或许…。
 
 > 注意本配置需要更新 nginx 到最新版，openssl 更新到1.0.2j，具体请到 Jerry Qu 的 [本博客 Nginx 配置之完整篇](https://imququ.com/post/my-nginx-conf.html) 查看，了解详情。
 
@@ -175,13 +175,11 @@ $ docker run -d --name eisearch \
 #### docker
 请确定你已经完成了上面所说的所有步骤，在本地已经测试成功。服务器上 `MognoDB` 和`Elasticsearch` 已经安装并已经运行成功。
 
-首先，请将本地测试好的`conf`，`static`，`views`文件夹上传至服务器，建议存储到服务器`/data/eiblog`下。
+首先，请将本地测试好的 `conf` 文件夹上传至服务器，建议存储到服务器 `/data/eiblog` 下。
 ``` sh
 $ tree /data/eiblog -L 1
 
 ├── conf
-├── static
-├── views
 ```
 
 然后，将镜像 PULL 到服务器本地。
@@ -200,8 +198,6 @@ $ docker run -d --name eiblog --restart=always \
     -e GODEBUG=netdns=cgo \
     -v /data/eiblog/logdata:/eiblog/logdata \
     -v /data/eiblog/conf:/eiblog/conf \
-    -v /data/eiblog/static:/eiblog/static \
-    -v /data/eiblog/views:/eiblog/views \
     registry.cn-hangzhou.aliyuncs.com/deepzz/eiblog
 ```
 这里默认 `MongDB` 和 `Elasticsearch` 均为 `docker` 部署，且名称为`eidb`，`eisearch`。
@@ -211,16 +207,14 @@ $ docker run -d --name eiblog --restart=always \
 
 请确认你已经成功安装好 `Nginx`、`docker`、`docker-compose`。Nginx 请一定参照 Jerry Qu 的[Nginx 配置完整篇](https://imququ.com/post/my-nginx-conf.html)。
 
-首先，请将本地测试好的`conf`，`static`，`views`，`docker-compose.yml`文件夹和文件上传至服务器。前三个文件夹建议存储到服务器`/data/eiblog`下，`docker-compose.yml`存放在你使用方便的地方。
+首先，请将本地测试好的 `conf`，`docker-compose.yml` 文件夹和文件上传至服务器。`conf` 建议存储到服务器 `/data/eiblog` 下，`docker-compose.yml` 存放在你使用方便的地方。
 
-> 注意检查`conf/es/config/scripts`空文件夹是否存在
+> 注意检查 `conf/es/config/scripts` 空文件夹是否存在，不存在即创建。
 
 ``` sh
 $ tree /data/eiblog -L 1
 
 ├── conf
-├── static
-├── views
 
 $ ls ~/
 
@@ -234,5 +228,3 @@ $ docker-compose up -d
 ```
 
 等待些许时间，成功运行。
-
-