add module deployment doc in Chinese

vae520283995 · Jan 15, 2020 · 4e257a9 · 4e257a9
1 parent 814be8e
commit 4e257a9
Showing 1 changed file with 54 additions and 0 deletions.
diff --git a/docs/modular-deployment-zh.md b/docs/modular-deployment-zh.md
@@ -0,0 +1,54 @@
+# 模块化后的 java-tron 部署方式
+
+模块化后，命令行下的程序启动方式将不再使用 `java -jar FullNode.jar` 的方式启动，而是使用脚本的方式启动，本文内容基于 develop 分支。
+
+*原有的启动方式依然保留，但即将废弃*。
+
+## 下载
+
+```
+git clone git@github.com:tronprotocol/java-tron.git
+```
+
+## 编译
+
+进入项目目录执行：
+```
+./gradlew build
+```
+编译成功后在 java-tron/build/distributions 目录下生成 zip 压缩包：java-tron-1.0.0.zip
+
+## 解压
+
+解压 java-tron-1.0.0.zip
+```
+cd java-tron/build/distributions
+unzip -o java-tron-1.0.0.zip
+```
+解压后的 java-tron 目录中有 bin 和 lib 两个文件夹，bin 目录中存放的是可执行脚本，lib 下存放程序依赖的 jar 包。
+
+## 启动
+
+不同的 os 对应不同脚本，windows 即为 bat 文件，以 linux 系统为例启动 java-tron：
+```
+# 默认配置文件启动
+java-tron-1.0.0/bin/FullNode
+# 自定义配置文件启动, java-tron/framework/build/resources 目录下有默认的配置文件提供选择
+java-tron-1.0.0/bin/FullNode -c config.conf
+# SR 模式启动，需要加上：-w
+java-tron-1.0.0/bin/FullNode -c config.conf -w
+```
+
+## jvm参数配置
+
+java-tron 支持对 jvm 参数进行配置，配置文件为 bin 目录下的 java-tron.vmoptions 文件。
+```
+# demo
+-XX:+UseConcMarkSweepGC
+-XX:+PrintGCDetails
+-Xloggc:./gc.log
+-XX:+PrintGCDateStamps
+-XX:+CMSParallelRemarkEnabled
+-XX:ReservedCodeCacheSize=256m
+-XX:+CMSScavengeBeforeRemark
+```