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
[](https://github.com/RWTH-i5-IDSG/steve/actions/workflows/main.yml)
3
+
[](https://github.com/steve-community/steve/actions/workflows/main.yml)
4
4
5
5
6
6
# Introduction
7
7
8
-
SteVe was developed at the RWTH Aachen University and means Steckdosenverwaltung, namely socket administration in German. The aim of SteVe is to support the deployment and popularity of electric mobility, so it is easy to install and to use. SteVe provides basic functions for the administration of charge points, user data, and RFID cards for user authentication and was tested successfully in operation.
8
+
SteVe started its life at the RWTH Aachen University [in 2013](https://github.com/steve-community/steve/issues/827).
9
+
The name is derived from _Steckdosenverwaltung_ in German (in English: socket administration).
10
+
The aim of SteVe is to support the deployment and popularity of electric mobility, so it is easy to install and to use.
11
+
It provides basic functions for the administration of charge points, user data, and RFID cards for user authentication and was tested successfully in operation.
9
12
10
-
SteVe is considered as an open platform to implement, test and evaluate novel ideas for electric mobility, like authentication protocols, reservation mechanisms for charge points, and business models for electric mobility. SteVe is distributed under [GPL](LICENSE.txt) and is free to use. If you are going to deploy SteVe we are happy to see the [logo](website/logo/managed-by-steve.pdf) on a charge point.
13
+
SteVe is considered as an open platform to implement, test and evaluate novel ideas for electric mobility, like authentication protocols, reservation mechanisms for charge points, and business models for electric mobility.
14
+
The project is distributed under [GPL](LICENSE.txt) and is free to use.
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
+
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/).
11
20
12
21
### Charge Point Support
13
22
@@ -20,15 +29,18 @@ Electric charge points using the following OCPP versions are supported:
20
29
* OCPP1.6S
21
30
* OCPP1.6J
22
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 21 or newer
30
42
* Maven
31
-
*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.
32
44
33
45
to build and run.
34
46
@@ -42,32 +54,18 @@ SteVe is designed to run standalone, a java servlet container / web server (e.g.
42
54
43
55
Make sure MySQL is reachable via TCP (e.g., remove `skip-networking` from `my.cnf`).
44
56
The following MySQL statements can be used as database initialization (adjust database name and credentials according to your setup).
45
-
46
-
* For MariaDB (all versions) and MySQL 5.7:
47
-
```
48
-
CREATE DATABASE stevedb CHARACTER SET utf8 COLLATE utf8_unicode_ci;
49
-
CREATE USER 'steve'@'localhost' IDENTIFIED BY 'changeme';
50
-
GRANT ALL PRIVILEGES ON stevedb.* TO 'steve'@'localhost';
51
-
GRANT SELECT ON mysql.proc TO 'steve'@'localhost';
52
-
```
53
-
54
-
* For MySQL 8:
55
-
```
56
-
CREATE DATABASE stevedb CHARACTER SET utf8 COLLATE utf8_unicode_ci;
57
-
CREATE USER 'steve'@'localhost' IDENTIFIED BY 'changeme';
58
-
GRANT ALL PRIVILEGES ON stevedb.* TO 'steve'@'localhost';
59
-
GRANT SUPER ON *.* TO 'steve'@'localhost';
60
-
```
61
-
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
62
-
```
63
-
REVOKE SUPER ON *.* FROM 'steve'@'localhost';
64
-
```
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
+
```
65
63
66
64
2. Download and extract tarball:
67
65
68
66
You can download and extract the SteVe releases using the following commands (replace X.X.X with the desired version number):
@@ -80,14 +78,14 @@ SteVe is designed to run standalone, a java servlet container / web server (e.g.
80
78
- You _must_ change [web interface credentials](src/main/resources/config/prod/main.properties#L17-L18)
81
79
- You _can_ access the application via HTTPS, by [enabling it and setting the keystore properties](src/main/resources/config/prod/main.properties#L32-L35)
82
80
83
-
For advanced configuration please see the [Configuration wiki](https://github.com/RWTH-i5-IDSG/steve/wiki/Configuration)
81
+
For advanced configuration please see the [Configuration wiki](https://github.com/steve-community/steve/wiki/Configuration)
84
82
85
83
4. Build SteVe:
86
84
87
85
To compile SteVe simply use Maven. A runnable `jar` file containing the application and configuration will be created in the subdirectory `steve/target`.
88
86
89
87
```
90
-
# mvn package
88
+
# ./mvnw package
91
89
```
92
90
93
91
5. Run SteVe:
@@ -100,13 +98,13 @@ SteVe is designed to run standalone, a java servlet container / web server (e.g.
100
98
101
99
# Docker
102
100
103
-
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`
104
102
105
-
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.
106
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.
107
-
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.
108
106
109
-
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`
110
108
111
109
# Kubernetes
112
110
@@ -126,19 +124,18 @@ To access this publicaly, you'll also have to setup an ingress using something l
126
124
127
125
# Ubuntu
128
126
129
-
You'll find a tutorial how to prepare Ubuntu for SteVe here: https://github.com/RWTH-i5-IDSG/steve/wiki/Prepare-Ubuntu-VM-for-SteVe
127
+
You'll find a tutorial how to prepare Ubuntu for SteVe here: https://github.com/steve-community/steve/wiki/Prepare-Ubuntu-VM-for-SteVe
130
128
131
129
# AWS
132
130
133
-
You'll find a tutorial how to setup SteVe in AWS using Lightsail here: https://github.com/RWTH-i5-IDSG/steve/wiki/Create-SteVe-Instance-in-AWS-Lightsail
131
+
You'll find a tutorial how to setup SteVe in AWS using Lightsail here: https://github.com/steve-community/steve/wiki/Create-SteVe-Instance-in-AWS-Lightsail
134
132
135
133
# First Steps
136
134
137
135
After SteVe has successfully started, you can access the web interface using the configured credentials under:
138
136
139
137
http://<your-server-ip>:<port>/steve/manager
140
138
141
-
The default port number is 8080.
142
139
143
140
### Add a charge point
144
141
@@ -172,7 +169,7 @@ If you are in the EU and offer vehicle charging to other people using SteVe, kee
172
169
173
170
Are you having issues?
174
171
-----
175
-
See the [FAQ](https://github.com/RWTH-i5-IDSG/steve/wiki/FAQ)
172
+
See the [FAQ](https://github.com/steve-community/steve/wiki/FAQ)
0 commit comments