Skip to content

Commit 8aa0c85

Browse files
author
Robin Duda
committed
Updated README with contribution notes and version bump.
1 parent d87b55d commit 8aa0c85

File tree

1 file changed

+22
-5
lines changed

1 file changed

+22
-5
lines changed

README.md

Lines changed: 22 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# parser-excel-elasticsearch [![Build Status](https://travis-ci.org/codingchili/parser-excel-elasticsearch.svg?branch=master)](https://travis-ci.org/codingchili/parser-excel-elasticsearch)
22

3-
Parses XLSX files into ElasticSearch using column titles from specified row combined with data in columns on each row. For use with Kibana or other visualization applications, example result using a transaction log in excel format [image](https://raw.githubusercontent.com/codingchili/parser-banktrans-es/master/sample-redacted.png). The application comes with a web-interface to simplify uploading.
3+
Parses XLSX files into ElasticSearch using column titles from a specified row combined with data in columns on each row. May be used with Kibana or other visualization applications, example result using a transaction log in excel format [image](https://raw.githubusercontent.com/codingchili/parser-banktrans-es/master/sample-redacted.png). The application comes with a web-interface to simplify uploading.
44

55
![sample UI image](https://raw.githubusercontent.com/codingchili/parser-excel-elasticsearch/master/excelastic.png)
66

@@ -10,26 +10,30 @@ Parses XLSX files into ElasticSearch using column titles from specified row comb
1010
- csv files can be converted to .xlsx using office and then imported.
1111
- clear the index before importing, or append to existing index.
1212
- basic authentication when uploading from the application to elasticsearch.
13+
- support for importing to TLS enabled elasticsearch servers.
14+
- supports concurrent parsing of excel files and importing for better performance.
15+
- parses the whole file before starting the import - to make sure your index is not left in an undesired state.
1316

1417
## Prerequisites
1518
The application requires ElasticSearch as its output.
1619

1720
1. ElasticSearch (version 5+/6+) should not require any additional configuration or installation, just download and run from [Elastic](https://www.elastic.co/products).
1821

19-
2. Download the latest release of excelastic-1.2.6.jar and the configuration.json (optional) file from [GitHub releases](https://github.com/codingchili/parser-excel-elasticsearch/releases).
22+
2. Grab the latest .jar file from [releases](https://github.com/codingchili/parser-excel-elasticsearch/releases).
2023

21-
Tested with ElasticSearch 5.6.2 and 6.1.0.
24+
Tested with ElasticSearch 5.6.2 and 6.2.3.
2225

2326
## Running
27+
2428
Running the application, filename and index is required, to import from the terminal run:
2529
```
26-
java -Xmx1g -jar excelastic-1.2.6.jar <filename> <index> <mapping> --clear
30+
java -Xmx2g -jar excelastic-1.2.7.jar <fileName> <indexName> --mapping mappingName --clear
2731
```
2832
If running with --clear, then the existing index will be cleared before the import starts.
2933

3034
To run with the web interface, run the following in your terminal:
3135
```
32-
java -Xmx1g -jar excelastic-1.2.6.jar
36+
java -Xmx2g -jar excelastic-1.2.7.jar
3337
```
3438
When the application successfully connects to the ElasticSearch server, the browser will automatically open a new tab.
3539

@@ -60,3 +64,16 @@ If no configuration file is present the values in the above example will be used
6064
Note that the comments cannot be included in the configuration file.
6165

6266
If no configuration file is present a new configuration file will be created using the default values listed here.
67+
68+
## Contributing
69+
70+
If you want to contribute to this project, open an issue or pull request. ::
71+
72+
In the 1.2.7 release we have cleaned up the code and added even more javadoc
73+
in order to promote contributions! :astonished:
74+
75+
---
76+
77+
Thanks to JetBrains for providing free open source licenses
78+
79+
[![](documentation/images/logo_jetbrains.png)](http://www.jetbrains.com)[![](documentation/images/logo_intellij_idea.png)](http://www.jetbrains.com/idea/)

0 commit comments

Comments
 (0)