Merge pull request #16 from materliu/master

feat: add JIRA&Crowd FAQ

README.md

@@ -1,7 +1,7 @@
 # Atlassian Agent
 
 #### Support (almost any version, include 8.0):
-* JIRA Software
+* JIRA Software [FAQ](doc/JIRA_FAQ.md)
 * JIRA Core
 * JIRA Service Desk
 * JIRA plugin: Capture
@@ -13,7 +13,7 @@
 * Bamboo
 * Bitbucket
 * FishEye
-* Crowd
+* Crowd [FAQ](doc/Crowd_FAQ.md)
 * Crucible
 * Third party plugins
 

doc/Crowd_FAQ.md

@@ -0,0 +1,7 @@
+# Crowd FAQ
+
+### 明明按照文档中说的配置了agent，并且成功激活了confluence，但Crowd激活时提示生成的密钥无效
+这种情况往往是 `JAVA_OPTS` 设置的问题，如果是按照下边方式设置的 `JAVA_OPTS` ，会出现激活失败
+   * 你可以把：`export JAVA_OPTS="-javaagent:/path/to/atlassian-agent.jar ${JAVA_OPTS}"` 这样的命令放到 `.bashrc` 或 `.bash_profile` 这样的文件内。
+
+原因即是 Crowd 并没有使用全局设置的这个变量，主要还是依赖的其自身目录中 `安装目录下/apache-tomcat/bin/setenv.sh` 中的配置，所以编辑这个文件，加上 `JAVA_OPTS="-javaagent:/atlassian-agent存放目录/atlassian-agent.jar $JAVA_OPTS"`，再重新尝试激活即可

doc/JIRA_FAQ.md

@@ -0,0 +1,7 @@
+# JIRA FAQ
+
+### 明明按照文档中说的配置了agent，并且成功激活了confluence，但Crowd激活时提示生成的密钥无效
+这种情况往往是 `JAVA_OPTS` 设置的问题，如果是按照下边方式设置的 `JAVA_OPTS` ，会出现激活失败
+   * 你可以把：`export JAVA_OPTS="-javaagent:/path/to/atlassian-agent.jar ${JAVA_OPTS}"` 这样的命令放到 `.bashrc` 或 `.bash_profile` 这样的文件内。
+
+原因即是 JIRA 并没有使用全局设置的这个变量，主要还是依赖的其自身目录中 `安装目录下/bin/setenv.sh` 中的配置，所以编辑这个文件，加上 `JAVA_OPTS="-javaagent:/atlassian-agent存放目录/atlassian-agent.jar $JAVA_OPTS"` 在 `JAVA_OPTS` 处，再重新尝试激活即可