Skip to content

Commit 24fe53c

Browse files
committed
Update README.md [ci skip]
1 parent f21553f commit 24fe53c

1 file changed

Lines changed: 14 additions & 9 deletions

File tree

README.md

Lines changed: 14 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -24,30 +24,35 @@ Requirements & Configuration
2424
- SOAP: `http://<your-server-ip>:<port>/steve/services/CentralSystemService`
2525
- WebSocket/JSON: `ws://<your-server-ip>:<port>/steve/websocket/CentralSystemService/<chargeBoxId>`
2626

27-
3. Configuration is defined in [main.properties](src/main/resources/config/prod/main.properties):
28-
- You _must_ change [database configuration](src/main/resources/config/prod/main.properties#L3-L7)
29-
- You _must_ change [the host](src/main/resources/config/prod/main.properties#L16) to the correct IP address of your server
30-
- You _must_ change [web interface credentials](src/main/resources/config/prod/main.properties#L11-L12)
31-
- You _can_ access the application via HTTPS, by [enabling it and setting the keystore properties](src/main/resources/config/prod/main.properties#L25-L28)
32-
33-
4. The following MySQL statements can be used as database initialization (adjust according to your setup):
27+
3. The following MySQL statements can be used as database initialization (adjust according to your setup):
3428

3529
```
3630
CREATE DATABASE stevedb;
3731
GRANT ALL PRIVILEGES ON stevedb.* TO 'steve'@'localhost' IDENTIFIED BY 'changeme';
3832
GRANT SELECT ON mysql.proc TO 'steve'@'localhost' IDENTIFIED BY 'changeme';
3933
```
4034
35+
4. Basic Configuration is defined in [main.properties](src/main/resources/config/prod/main.properties):
36+
- You _must_ change [database configuration](src/main/resources/config/prod/main.properties#L3-L7)
37+
- You _must_ change [the host](src/main/resources/config/prod/main.properties#L16) to the correct IP address of your server. Using `0.0.0.0` to bind to all Interfaces should work as well, but might have security implications
38+
- You _must_ change [web interface credentials](src/main/resources/config/prod/main.properties#L11-L12)
39+
- You _can_ access the application via HTTPS, by [enabling it and setting the keystore properties](src/main/resources/config/prod/main.properties#L25-L28)
40+
41+
5. Log File Configuration is defined in [log4j2.xml](src/main/resources/config/prod/log4j2.xml):
42+
- You _can_ change the [log directory](src/main/resources/config/prod/log4j2.xml#L10).
43+
The default Location is `$HOME/logs/steve.log`. A more suitable location might be `/var/log/steve/steve.log` (remember to set directory permissions accordingly)
44+
- You _can_ change the [log level](src/main/resources/config/prod/log4j2.xml#L28)
45+
4146
How to use?
4247
-----
4348
4449
Compile and build an archive ready to run:
4550
4651
mvn package
4752
48-
Start the application:
53+
Start the application (please do not run SteVe as root):
4954
50-
java -jar steve-***.jar
55+
java -jar target/steve-*.jar
5156
5257
Access the Web interface:
5358

0 commit comments

Comments
 (0)