restore docs

meolu · Jan 17, 2016 · 63e9014 · 63e9014
1 parent 0d19a01
commit 63e9014
Show file tree

Hide file tree

Showing 8 changed files with 803 additions and 0 deletions.
diff --git a/docs/config-git-en.md b/docs/config-git-en.md
@@ -0,0 +1,70 @@
+Walle's configuration guide
+==========================
+
+1.Requirements：
+--------------
+
+* The ssh-key of the user of php process in host should be added to github/gitlab/bitbucket's ssh-keys. Of course you can specify the repo url input like this: `https://username:[email protected]/meolu/walle-web.git`, but it is not recommended.
+    * how to find out the user of php process:
+
+        ```
+        ps aux|grep php
+        ```
+    * how to find out the ssh-key of user:
+
+        ```
+        su user-name && cat ~/.ssh/id_rsa.pub
+        ```
+* The ssh-key of the user of php process in host should be added to target servers authorized_keys
+    * how to add a ssh-key to remote server:
+
+        ```
+        su user-name && ssh-copy-id -i ~/.ssh/id_rsa.pub remote_user@remote_server
+        # need remote_user's password
+        ```
+
+2.Configuration
+---------------
+
+![](https://github.com/meolu/walle-web/blob/master/screenshots/task-en.jpg)
+
+3.Detection
+-----------
+
+if project's configuration works after detection, have a try to deploy : )
+
+![](https://github.com/meolu/walle-web/blob/master/screenshots/detection-en.png)
+
+4.Detection errors and solutions
+-------------------------------
+
+- hosted server error: please make sure the user {user} of php process have the access permission of {path}，and add the ssh-key to github/gitlab\'s deploy-keys。error：{error}
+    - make sure the user {user} have access permission of {path}
+
+        ```
+        ll {path}
+        chown {user} -R {path}
+        chmod 755 -R {path}
+        ```
+    - add the ssh-key to github/gitlab\'s deploy-keys
+
+        ```
+        su {user} && cat ~/.ssh/id_rsa.pub
+        open github/gitlab/bitbucket, add the ssh-key
+        ```
+- target server error: please make sure the ssh-key of user {local_user} of php process is added to target servers\'s user {remote_user}\'s authorized_keys, and {remote_user} have the access permission of {path} on target servers. error：{error}
+    - please make sure the ssh-key of user {local_user} of php process is added to target servers\'s user {remote_user}\'s authorized_keys
+
+        ```
+        su {local_user} && ssh-copy-id -i ~/.ssh/id_rsa.pub remote_user@remote_server
+        # need remote_user's password
+        ```
+    - {remote_user} have the access permission of {path} on target servers
+
+        ```
+        su remote_user
+        ll {path}
+        chown {remote_user} -R {path}
+        chmod 755 -R {path}
+        ````
+
diff --git a/docs/config-git.md b/docs/config-git.md
@@ -0,0 +1,60 @@
+Walle 瓦力 git 部署配置指南
+==========================
+
+git部署是最推荐的方式，它无论对于何种语言都是合适的。
+
+
+一、基本要求：
+-----------
+
+1. 宿主机php进程用户www_php(假如，可通过配置的检测查看或ps aux|grep php)的ssh-key要加入git/gitlab的deploy-keys。当然也可以http地址带用户名密码（不推荐）：https://username:[email protected]/meolu/walle-web.git
+2. 宿主机php进程用户www_php(假如，可通过配置的检测查看或ps aux|grep php)要加入目标机群部署用户www_remote(配置中)ssh-key信任，具体怎么添加可找sa或者百度或者[](https://github.com/meolu/walle-web/blob/master/docs/faq.md#如何添加用户ssh-key到目标机群部署用户ssh-key信任)，这一般是用户最不理解的地方，建议先花半小时理解linux用户概念和php配置。
+
+
+二、配置项目
+----------
+
+![](https://github.com/meolu/walle-web/blob/master/screenshots/base-git.jpg)
+![](https://github.com/meolu/walle-web/blob/master/screenshots/task.jpg)
+
+三、检测项目配置
+-------------
+
+配置完毕之后，先检测下，如无问题则可以发起上线单了：）
+![](https://github.com/meolu/walle-web/blob/master/screenshots/detection.png)
+
+四、检测的错误和解决办法
+--------------------
+- 宿主机代码检出检测出错，请确认php进程用户{user}有代码存储仓库{path}读写权限，且把ssh-key加入git的deploy-keys列表。详细错误：{error}
+
+    - 问题：**请确认php进程用户{user}有代码存储仓库{path}读写权限**
+
+        ```
+        没有权限，是因为用户{user}对目录{path}没有读写权限，给权限即可
+        ll {path}
+        chown {user} -R {path}
+        chmod 755 -R {path}
+        ```
+    - 问题：**把ssh-key加入git的deploy-keys列表**
+
+        ```
+        su {user} && cat ~/.ssh/id_rsa.pub
+        打开 github/gitlab/bitbucket 网站, 添加 ssh-key 到ssh-keys列表
+        ```
+
+- 目标机器部署出错，请确认php进程{local_user}用户ssh-key加入目标机器的{remote_user}用户ssh-key信任列表，且{remote_user}有目标机器发布版本库{path}写入权限。详细错误：{error}
+    - 问题：**请确认php进程{local_user}用户ssh-key加入目标机器的{remote_user}用户ssh-key信任列表**
+
+        ```
+        添加机器信任，还是没理解请百度吧（因为太多的同学问这问题，实在没办法只能这么啰嗦）
+        su {local_user} && ssh-copy-id -i ~/.ssh/id_rsa.pub remote_user@remote_server
+        # need remote_user's password
+        ```
+    - 问题：**{remote_user}有目标机器发布版本库{path}写入权限**
+
+        ```
+        su remote_user
+        ll {path}
+        chown {remote_user} -R {path}
+        chmod 755 -R {path}
+        ````
diff --git a/docs/config-svn-en.md b/docs/config-svn-en.md
@@ -0,0 +1,93 @@
+Walle's svn configuration guide
+===============================
+
+
+1.Requirements：
+-----------
+
+- Svn's directory like flowing, or you can create a svn project in [riouxsvn](https://riouxsvn.com) for test.
+
+    - branches
+    - tags
+    - trunk
+
+- The ssh-key of the user of php process in host should be added to target servers authorized_keys
+    - how to find out the user of php process:
+
+        ```
+        ps aux|grep php
+        ```
+    - how to find out the ssh-key of user:
+
+        ```
+        su user-name && cat ~/.ssh/id_rsa.pub
+        ```
+    - how to add a ssh-key to remote server:
+
+        ```
+        su user-name && ssh-copy-id -i ~/.ssh/id_rsa.pub remote_user@remote_server
+        # need remote_user's password
+        ```
+
+2.Configuration
+---------------
+
+![](https://github.com/meolu/walle-web/blob/master/screenshots/base-svn-en.jpg)
+![](https://github.com/meolu/walle-web/blob/master/screenshots/task-en.jpg)
+
+3.Detection
+-----------
+
+if project's configuration works after detection, have a try to deploy : )
+
+![](https://github.com/meolu/walle-web/blob/master/screenshots/detection-en.png)
+
+4. Detection errors and solutions
+--------------------------------
+
+- hosted server error: please make sure the user {user} of php process have the access permission of {path}. error：{error}
+
+    ```
+    ll {path}
+    chown {user} -R {path}
+    chmod 755 -R {path}
+    ```
+- target server error: please make sure the ssh-key of user {local_user} of php process is added to target servers\'s user {remote_user}\'s authorized_keys, and {remote_user} have the access permission of {path} on target servers. error：{error}
+    - please make sure the ssh-key of user {local_user} of php process is added to target servers\'s user {remote_user}\'s authorized_keys
+
+        ```
+        su {local_user} && ssh-copy-id -i ~/.ssh/id_rsa.pub remote_user@remote_server
+        # need remote_user's password
+        ```
+    - {remote_user} have the access permission of {path} on target servers
+
+        ```
+        su remote_user
+        ll {path}
+        chown {remote_user} -R {path}
+        chmod 755 -R {path}
+        ````
+
+5.Deployment
+------------
+In svn mode, you can deploy all code, or deploy specified files incrementally.
+
+- Rsync all code
+
+    ```
+    *
+    ```
+-  Rsync specified files incrementally
+
+    ```
+    file_name1
+    file_name2
+    ```
+-  Rsync specified files of specified version incrementally
+
+    ```
+    file_name1 commit_id
+    file_name2 commit_id
+    ```
+
+![](https://github.com/meolu/walle-web/blob/master/screenshots/walle-svn-submit.jpg)
diff --git a/docs/config-svn.md b/docs/config-svn.md
@@ -0,0 +1,80 @@
+Walle 瓦力 svn 部署配置、上线指南
+==============================
+
+svn部署上线与git有点不太一样，svn是推荐增量发布（当然也可以全量更新），在开发者提交文件列表（可能带版本号），管理员审核上线单。发起部署时，为该上线单开辟一个独立空间，检出代码，选择上线单中的文件（可能带版本号）同步到目标机群。有不了解宿主机和目标机群关系、上线流程的同学先到项目主页了解。
+
+因为svn没有git的版本快照，所以在部署需要全量代码编译操作时，只能选择全量更新，此时要求发布的分支/tag/trunk是可发布状态。建议java + git组合。同理其它需要全量代码在宿主机做编译相关的操作的语言，且为svn版本管理，请慎用。
+
+一、基本要求：
+-----------
+
+1. svn目录推荐以下规范，详细可以注册[riouxsvn](https://riouxsvn.com)，作为svn测试地址。当然三无（无trunk、无branches、无tags）也是支持：）
+
+    - branches
+    - tags
+    - trunk
+2. 宿主机php进程用户www_php(假如，可通过配置的检测查看或ps aux|grep php)要加入目标机群部署用户www_remote(配置中)ssh-key信任，具体怎么添加可找sa或者百度或者[](https://github.com/meolu/walle-web/blob/master/docs/faq.md#如何添加用户ssh-key到目标机群部署用户ssh-key信任)，这一般是用户最不理解的地方，建议先花半小时理解linux用户概念和php配置。
+
+二、配置项目
+----------
+
+![](https://github.com/meolu/walle-web/blob/master/screenshots/base-svn.jpg)
+![](https://github.com/meolu/walle-web/blob/master/screenshots/task.jpg)
+
+三、检测项目配置
+-------------
+
+配置完毕之后，先检测下，如无问题则可以发起上线单了：）
+![](https://github.com/meolu/walle-web/blob/master/screenshots/detection.png)
+
+四、检测的错误和解决办法
+--------------------
+- 宿主机代码检出检测出错，请确认php进程用户{user}有代码存储仓库{path}读写权限。详细错误：{error}
+
+    ```
+    没有权限，是因为用户{user}对目录{path}没有读写权限，给权限即可
+    ll {path}
+    chown {user} -R {path}
+    chmod 755 -R {path}
+    ```
+
+- 目标机器部署出错，请确认php进程{local_user}用户ssh-key加入目标机器的{remote_user}用户ssh-key信任列表，且{remote_user}有目标机器发布版本库{path}写入权限。详细错误：{error}
+    - 问题：**请确认php进程{local_user}用户ssh-key加入目标机器的{remote_user}用户ssh-key信任列表**
+
+        ```
+        添加机器信任，还是没理解请百度吧（因为太多的同学问这问题，实在没办法只能这么啰嗦）
+        su {local_user} && ssh-copy-id -i ~/.ssh/id_rsa.pub remote_user@remote_server
+        # need remote_user's password
+        ```
+    - 问题：**{remote_user}有目标机器发布版本库{path}写入权限**
+
+        ```
+        su remote_user
+        ll {path}
+        chown {remote_user} -R {path}
+        chmod 755 -R {path}
+        ````
+
+五、提交上线单
+------------
+svn上线单有全量上线和增量上线两种主要形式，增量上线支持指定文件的版本号。分别看下可以有哪些格式填写上线单：
+
+- 上线全量文件  
+
+    ```
+    *
+    ```
+- 增量上线指定文件
+
+    ```
+    file_name1
+    file_name2
+    ```
+- 增量上线指定文件的指定版本
+
+    ```
+    file_name1 commit_id
+    file_name2 commit_id
+    ```
+
+![](https://github.com/meolu/walle-web/blob/master/screenshots/walle-svn-submit.jpg)