Skip to content

Commit 029f694

Browse files
authored
Update README.md
1 parent a4e4ac5 commit 029f694

File tree

1 file changed

+65
-0
lines changed

1 file changed

+65
-0
lines changed

README.md

Lines changed: 65 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,2 +1,67 @@
11
# Excel-CellColor-Server
22
A Java Server which returns all colored cells to an uploaded Excel Sheet.
3+
4+
## RUN THE EXCEL SERVER:
5+
6+
You may configure the .jar with two arguments:
7+
- Maximum amount of clients which can be connected at the same time
8+
- Maximal amount of time a client can be connected to the server (Given in milliseconds)
9+
10+
You should only run the .jar file inside a terminal. This way you can cconfigure both arguments as you like.
11+
12+
Example command to run the server:
13+
14+
```java -Xmx1G -jar excelServer.jar 10 10000```
15+
16+
## SERVER FUNCTIONS
17+
18+
In general, it is possible to send commands to the server. These are simple strings sent over a TCP socket.
19+
Clients are resticted to request only one line of String per connection. This would usually be a command with some arguments.
20+
> "do-something"
21+
22+
Data generated and sent back to the requesting client is always in this JSON format:
23+
```json
24+
{
25+
"message": {
26+
"some": "data"
27+
}
28+
"errorMessage": "ErrorMessage"
29+
}
30+
```
31+
Please note that only either the "message" or the "errorMessage" field are present in the JSON. Never both.
32+
Here is a list of the current commands for version 1.1.1:
33+
34+
#### convertxssf
35+
* This commands expects no arguments. When the response "ready" is sent, the server expects the excel file as stream.
36+
When finished, the server will response with a list of cells with their x and y index and their color
37+
38+
## CHANGELOG
39+
40+
### 1.0.1 (OBSOLETE!)
41+
- Fixing a vulnerability
42+
- More detailed logging for better minitoring
43+
- Only errors are logged
44+
- Arguments can become infinite if a value 0 or below 0 is provided.
45+
46+
### 1.1.0
47+
- Logfile creation "instancelog.log".
48+
- Server admin commands:
49+
- A list can be called with "help"
50+
- You can also execute shell commands
51+
- Changed the 'convertxsff' client command flow. `!Aktueller client nicht mehr mit 1.0.1 kompatibel!`
52+
53+
### 1.1.1
54+
- Fixed an issue, where there would always be an error thrown on the first client connection of an instance.
55+
- Various more bugfixes
56+
57+
# Excel Server dependencies:
58+
59+
- <a>https://github.com/DevKevYT/devscript</a> version: '1.9.4'<br>
60+
- <a>https://mvnrepository.com/artifact/org.apache.poi/poi</a> version: '5.1.0'<br>
61+
- <a>https://mvnrepository.com/artifact/org.apache.poi/poi-ooxml</a> version: '5.1.0'<br>
62+
- <a>https://mvnrepository.com/artifact/org.apache.xmlbeans/xmlbeans</a> version: '2.3.0'<br>
63+
- <a>https://mvnrepository.com/artifact/dom4j/dom4j</a> version: '1.6.1'<br>
64+
- <a>https://mvnrepository.com/artifact/org.apache.commons/commons-collections4</a> version: '4.3'<br>
65+
- <a>https://mvnrepository.com/artifact/org.apache.commons/commons-compress</a> version: '1.18'<br>
66+
- <a>https://mvnrepository.com/artifact/org.apache.poi/ooxml-schemas</a> version: '4.1'
67+

0 commit comments

Comments
 (0)