You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: README.md
+20-28Lines changed: 20 additions & 28 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -14,6 +14,10 @@ SteVe is considered as an open platform to implement, test and evaluate novel id
14
14
The project is distributed under [GPL](LICENSE.txt) and is free to use.
15
15
If you are going to deploy it we are happy to see the [logo](website/logo/managed-by-steve.pdf) on a charge point.
16
16
17
+
## Relation to Powerfill
18
+
19
+
[Powerfill](https://powerfill.co/) is a SaaS company to expand beyond the basics of SteVe: While SteVe covers the basics of OCPP functionality in a DIY sense, Powerfill offers more and enterprise features with ease of use. [See the announcement](https://github.com/steve-community/steve/issues/1643) and [sign up for early access](https://powerfill.co/early-access/).
20
+
17
21
### Charge Point Support
18
22
19
23
Electric charge points using the following OCPP versions are supported:
@@ -25,15 +29,18 @@ Electric charge points using the following OCPP versions are supported:
25
29
* OCPP1.6S
26
30
* OCPP1.6J
27
31
32
+
⚠️ Currently, Steve doesn't support [the OCPP-1.6 security whitepaper](https://openchargealliance.org/wp-content/uploads/2023/11/OCPP-1.6-security-whitepaper-edition-3-2.zip) yet (see [#100](https://github.com/steve-community/steve/issues/100)) and anyone can send events to a public steve instance once the chargebox id is known.
33
+
Please, don't expose a Steve instance without knowing that risk.
* JDK 11 (both Oracle JDK and OpenJDK are supported)
41
+
* JDK 17 or newer
35
42
* Maven
36
-
*MariaDB 10.2.1 or later. MySQL 5.7.7 or later works as well, but especially MySQL 8 introduces more hassle. We suggest MariaDB 10.3.
43
+
*MySQL or MariaDB. You should use [one of these](.github/workflows/main.yml#L11) supported versions.
37
44
38
45
to build and run.
39
46
@@ -47,26 +54,12 @@ SteVe is designed to run standalone, a java servlet container / web server (e.g.
47
54
48
55
Make sure MySQL is reachable via TCP (e.g., remove `skip-networking` from `my.cnf`).
49
56
The following MySQL statements can be used as database initialization (adjust database name and credentials according to your setup).
50
-
51
-
* For MariaDB (all versions) and MySQL 5.7:
52
-
```
53
-
CREATE DATABASE stevedb CHARACTER SET utf8 COLLATE utf8_unicode_ci;
54
-
CREATE USER 'steve'@'localhost' IDENTIFIED BY 'changeme';
55
-
GRANT ALL PRIVILEGES ON stevedb.* TO 'steve'@'localhost';
56
-
GRANT SELECT ON mysql.proc TO 'steve'@'localhost';
57
-
```
58
-
59
-
* For MySQL 8:
60
-
```
61
-
CREATE DATABASE stevedb CHARACTER SET utf8 COLLATE utf8_unicode_ci;
62
-
CREATE USER 'steve'@'localhost' IDENTIFIED BY 'changeme';
63
-
GRANT ALL PRIVILEGES ON stevedb.* TO 'steve'@'localhost';
64
-
GRANT SUPER ON *.* TO 'steve'@'localhost';
65
-
```
66
-
Note: The statement `GRANT SUPER [...]` is only necessary to execute some of the previous migration files and is only needed for the initial database setup. Afterwards, you can remove this privilege by executing
67
-
```
68
-
REVOKE SUPER ON *.* FROM 'steve'@'localhost';
69
-
```
57
+
58
+
```
59
+
CREATE DATABASE stevedb CHARACTER SET utf8 COLLATE utf8_unicode_ci;
60
+
CREATE USER 'steve'@'localhost' IDENTIFIED BY 'changeme';
61
+
GRANT ALL PRIVILEGES ON stevedb.* TO 'steve'@'localhost';
62
+
```
70
63
71
64
2. Download and extract tarball:
72
65
@@ -92,7 +85,7 @@ SteVe is designed to run standalone, a java servlet container / web server (e.g.
92
85
To compile SteVe simply use Maven. A runnable `jar` file containing the application and configuration will be created in the subdirectory `steve/target`.
93
86
94
87
```
95
-
# mvn package
88
+
# ./mvnw package
96
89
```
97
90
98
91
5. Run SteVe:
@@ -105,13 +98,13 @@ SteVe is designed to run standalone, a java servlet container / web server (e.g.
105
98
106
99
# Docker
107
100
108
-
If you prefer to build and start this project via docker (you can skip the steps 1, 4 and 5 from above), this can be done as follows: `docker-compose up -d`
101
+
If you prefer to build and start this project via docker (you can skip the steps 1, 4 and 5 from above), this can be done as follows: `dockercompose up -d`
109
102
110
-
Because the docker-compose file is written to build the project for you, you still have to change the project configuration settings from step 3.
103
+
Because the dockercompose file is written to build the project for you, you still have to change the project configuration settings from step 3.
111
104
Instead of changing the [main.properties in the prod directory](src/main/resources/config/prod/main.properties), you have to change the [main.properties in the docker directory](src/main/resources/config/docker/main.properties). There you have to change all configurations which are described in step 3.
112
-
The database password for the user "steve" has to be the same as you have configured it in the docker-compose file.
105
+
The database password for the user "steve" has to be the same as you have configured it in the dockercompose file.
113
106
114
-
With the default docker-compose configuration, the web interface will be accessible at: `http://localhost:8180`
107
+
With the default dockercompose configuration, the web interface will be accessible at: `http://localhost:8180`
115
108
116
109
# Kubernetes
117
110
@@ -143,7 +136,6 @@ After SteVe has successfully started, you can access the web interface using the
0 commit comments