From cb966e26a10787da4ee2cac6f87e255b9c039c85 Mon Sep 17 00:00:00 2001
From: EEEEEEYHN <cneyhn@gmail.com>
Date: Wed, 16 May 2018 21:11:05 +0800
Subject: [PATCH] docs(install): config and redis tutorial (#145)

* docs(install): delete typos

* docs(install): config

* docs(install): redis tutorial
---
 docs/install/README.md | 98 +++++++++++++++++++++++++++++++++++++-----
 1 file changed, 88 insertions(+), 10 deletions(-)

diff --git a/docs/install/README.md b/docs/install/README.md
index 93e26e0d65..1fc9cf7196 100644
--- a/docs/install/README.md
+++ b/docs/install/README.md
@@ -4,22 +4,22 @@ sidebar: auto
 
 # 部署
 
-部署 RSSHub 非常简单，如果你在部署过程中遇到无法解决的问题请到 [issues](https://github.com/DIYgod/RSSHub/issues) 寻找类似的问题或 [向我们提问](https://github.com/DIYgod/RSSHub/issues/new)，我们会尽快给你答复。
+部署 RSSHub 非常简单，如果您在部署过程中遇到无法解决的问题请到 [issues](https://github.com/DIYgod/RSSHub/issues) 寻找类似的问题或 [向我们提问](https://github.com/DIYgod/RSSHub/issues/new)，我们会尽快给您答复。
 
 [[toc]]
 
 ## 手动部署
 
-部署 `RSSHub` 最直接的方式，你可以按照以下步骤将 `RSSHub` 部署在您的电脑、服务器或者其他任何地方。
+部署 `RSSHub` 最直接的方式，您可以按照以下步骤将 `RSSHub` 部署在您的电脑、服务器或者其他任何地方。
 
 ### 在安装之前
 
-在安装 RSSHub 之前，请确保你到电脑中已经安装了 [Node.js >= 10.0](https://nodejs.org/) 和 [Git](https://git-scm.com/)。
+在安装 RSSHub 之前，请确保您的电脑中已经安装了 [Git](https://git-scm.com/) 和 [Node.js >= 10.0](https://nodejs.org/)。
 
 ### 安装 Git
 
 ::: tip 提示
-首先你应该输入 `git`，看看系统有没有安装 Git：
+首先您应该输入 `git`，看看系统有没有安装 Git：
 
 windows 打开 `cmd`， macOS 打开`终端(terminal)`。
 
@@ -30,9 +30,9 @@ usage: git [--version] [--help] [-C <path>] [-c name=value]
 ```
 :::
 
-- Windows：从Git官网直接[下载安装程序](https://git-scm.com/downloads)。
-- MacOS：使用 [Homebrew](https://brew.sh/) `brew install git` 或者[下载安装程序](https://git-scm.com/download/mac)。
-- Linux：使用你的包管理器安装例如 `sudo apt-get install git`。
+* Windows：从Git官网直接[下载安装程序](https://git-scm.com/downloads)。
+* MacOS：使用 [Homebrew](https://brew.sh/) `$ brew install git` 或者[下载安装程序](https://git-scm.com/download/mac)。
+* Linux：使用您的包管理器安装例如 `$ sudo apt-get install git`。
 
 ### 安装 Node.JS
 
@@ -89,10 +89,84 @@ $ npm start
 
 在浏览器中打开 [http://127.0.0.1:1200/](http://127.0.0.1:1200/)，enjoy it! ✅
 
-## 部署到 docker
+### 添加配置
+
+可以通过修改 `config.js` 或者设置环境变量来配置 RSSHub。
+
+**如何设置环境变量**
+
+Windows 系统在 cmd.exe 中运行 `$ set PORT=1000`
+
+macOS & Linux 运行 `$ PORT=1000`
+
+再运行 `$ npm start` 启动 RSSHub 即可将监听端口设置为 `1000`。
+
+此处设置的环境变量在关闭终端后就会被清除，如果您想保存这些配置可以编写一个简单的 [批处理文件](https://en.wikipedia.org/wiki/Batch_file) 或 [shell](https://en.wikipedia.org/wiki/Shell_script)。
+
+更多配置项请看 [应用配置](#应用配置)
+
+### 使用 Redis 数据库缓存
+
+RSSHub 默认会有 5 分钟的缓存，默认这个缓存是存放在内存中的。RSSHub 还支持 Redis 数据库缓存。
+
+::: tip 提示
+除非流量特别大或者您需要建立分布式集群，否则不需要 Redis 缓存。
+:::
+
+#### 安装 Redis
+
+**Windows**
+
+安装 Redis on Windows 直接[下载安装程序](https://github.com/MicrosoftArchive/redis/releases)。
+
+在安装目录中运行下面的命令启动 Redis。
+
+``` bash
+$ redis-server  redis.windows.conf
+```
+
+**MacOS**
+
+使用 [Homebrew](https://brew.sh/) 安装 Redis。
+
+``` bash
+$ brew install redis
+```
+
+再运行下面的命令启动 Redis。
+
+``` bash
+$ brew services start redis
+```
+
+**Linux**
+
+使用您的包管理器安装 Redis。
+
+``` bash
+# apt
+$ sudo apt install redis-server
+
+# yum
+$ sudo yum install redis
+```
+
+然后运行 `$ redis-server` 启动 Redis。
+
+#### 启用 Redis 数据库缓存
+
+修改配置项 `CACHE_TYPE` 为 `redis`，RSSHub 将使用默认地址 `redis://localhost:6379/` 连接 Redis，如果需要修改地址请看 [应用配置](#应用配置)。
+
+## 部署到 Docker
 
 Docker 属于 Linux 容器的一种封装，提供简单易用的容器使用接口。它是目前最流行的 Linux 容器解决方案。
 
+### 安装 Docker
+
+官方网站上有各种环境下的 [安装指南](https://docs.docker.com/engine/installation/)
+
+### 部署
+
 运行下面的命令下载 RSSHub 镜像。
 
 ``` bash
@@ -125,7 +199,7 @@ $ docker run -d --name rsshub -p 1200:1200 -e CACHE_EXPIRE=3600 PORT=1000 diygod
 
 更多配置项请看 [应用配置](#应用配置)
 
-## 使用 docker-compose 部署
+### 使用 docker-compose 部署
 
 [docker-compose](https://docs.docker.com/compose/overview/) 是用来运行多容器 Docker 应用的小工具，可以简化配置部署过程：
 
@@ -160,6 +234,10 @@ $ docker-compose up
 
 可以通过修改 `config.js` 或者设置环境变量来配置 RSSHub。
 
+::: tip 提示
+建议通过设置环境变量来配置 RSSHub。避免版本更新时的冲突。
+:::
+
 `PORT`: 监听端口，默认为 `1200`
 
 `CACHE_TYPE`: 缓存类型，可为 `memory` 和 `redis`，设为空可以禁止缓存，默认为 `memory`
@@ -168,7 +246,7 @@ $ docker-compose up
 
 `LISTEN_INADDR_ANY`: 是否允许公网连接，默认 1
 
-`REDIS_URL`: Redis 连接地址（memory 缓存类型时无效）
+`REDIS_URL`: Redis 连接地址（memory 缓存类型时无效），默认为 `redis://localhost:6379/`
 
 `REDIS_PASSWORD`: Redis 连接密码（memory 缓存类型时无效）