ソースを参照

Merge remote-tracking branch 'origin/master'

didfet 10 年 前
コミット
cd576ec9e2
1 ファイル変更16 行追加6 行削除
  1. 16 6
      README.md

+ 16 - 6
README.md

@@ -5,7 +5,7 @@
 Logstash-forwarder-java is a log shipper program written in java. This is in fact a java version of [logstash-forwarder](https://github.com/elasticsearch/logstash-forwarder) by jordansissel.
 Logstash-forwarder-java is a log shipper program written in java. This is in fact a java version of [logstash-forwarder](https://github.com/elasticsearch/logstash-forwarder) by jordansissel.
 Here are a few features of this program :
 Here are a few features of this program :
   - compatible with Java 5 runtime
   - compatible with Java 5 runtime
-  - lightweight : requires only a few dependencies and few system resources
+  - lightweight : package size is ~2MB
   - configuration compatible with logstash-forwarder
   - configuration compatible with logstash-forwarder
   - lumberjack output (including zlib compression)
   - lumberjack output (including zlib compression)
 
 
@@ -13,27 +13,37 @@ Here are a few features of this program :
 
 
 Logstash-forwarder is written in go. This programming language is not available on all platforms (for example AIX), that's why a java version is more portable.
 Logstash-forwarder is written in go. This programming language is not available on all platforms (for example AIX), that's why a java version is more portable.
 
 
-Logstash runs on java and provides a lumberjack output, but the file input doesn't run on all plaforms (for example AIX) and logstash requires a recent JVM. Moreover Logstash is heavier : big package and more system resources.
+Logstash runs on java and provides a lumberjack output, but the file input doesn't run on all plaforms (for example AIX) and logstash requires a recent JVM. Moreover Logstash is heavier : it is a big package and uses more system resources.
 
 
 So logstash-forwarder-java is a solution for those who want a portable, lightweight log shipper for their ELK stack.
 So logstash-forwarder-java is a solution for those who want a portable, lightweight log shipper for their ELK stack.
 
 
 ## How to install it ?
 ## How to install it ?
 
 
 Download one of the following archives :
 Download one of the following archives :
-  - [logstash-forwarder-java-0.1.0-bin.zip](https://github.com/didfet/logstash-forwarder-java/releases/download/0.1.0/logstash-forwarder-java-0.1.0-bin.zip)
-  - [logstash-forwarder-java-0.1.0-bin.tar.gz](https://github.com/didfet/logstash-forwarder-java/releases/download/0.1.0/logstash-forwarder-java-0.1.0-bin.tar.gz)
-  - [logstash-forwarder-java-0.1.0-bin.tar.bz2](https://github.com/didfet/logstash-forwarder-java/releases/download/0.1.0/logstash-forwarder-java-0.1.0-bin.tar.bz2)
+  - [logstash-forwarder-java-0.1.1-bin.zip](https://github.com/didfet/logstash-forwarder-java/releases/download/0.1.1/logstash-forwarder-java-0.1.1-bin.zip)
+  - [logstash-forwarder-java-0.1.1-bin.tar.gz](https://github.com/didfet/logstash-forwarder-java/releases/download/0.1.1/logstash-forwarder-java-0.1.1-bin.tar.gz)
+  - [logstash-forwarder-java-0.1.1-bin.tar.bz2](https://github.com/didfet/logstash-forwarder-java/releases/download/0.1.1/logstash-forwarder-java-0.1.1-bin.tar.bz2)
 
 
 Or download the maven project and run maven package. Then you can install one of the archives located in the target directory.
 Or download the maven project and run maven package. Then you can install one of the archives located in the target directory.
 
 
+## How to run it ?
+
+Just run this command :
+
+    java -jar logstash-forwarder-java-X.Y.Z.jar -config /path/to/config/file.json
+
+For help run :
+
+    java -jar logstash-forwarder-java-X.Y.Z.jar -help
+
 ## Differences with logstash-forwarder
 ## Differences with logstash-forwarder
 
 
 ### Configuration
 ### Configuration
 
 
 The configuration file is the same (json format), but there are a few differences :
 The configuration file is the same (json format), but there are a few differences :
   - the ssl ca parameter points to a java keystore containing the root certificate of the server, not a PEM file
   - the ssl ca parameter points to a java keystore containing the root certificate of the server, not a PEM file
-  - the program only uses the first server in the network section for the moment
   - comments are C-style comments
   - comments are C-style comments
+  - the stdin input is not yet implemented
 
 
 ### Command-line options
 ### Command-line options