- Docker
- Docker Compose
- Java 11
Kafkatorio uses Gradle to build the project, and Docker Compose to create images.
./gradlew build
- build and test the project./gradlew runKafkatorio
- run locally (if Docker is running, a Kafka instance will start)./gradlew dockerComposeBuild
- build, test, and create Kafkatorio Docker images
See ./kafkatorio-platform/docker-compose.yml for a complete example
-
Copy the kafkatorio-platform directory to your computer
-
Rename
example.secret.kafkatorio-config.yml
to.secret.kafkatorio-config.yml
In it, define both
- a JWT secret password (a long alphanumeric string is best, you won't need to type this password manually)
- a Factorio server, with a short-ID and a description.
-
Rename
example.env
to.env
-
Create a JWT for your Factorio server, by going to https://jwt.io/
- In 'PAYLOAD: DATA', set
sub
to your Factorio server's short ID.({ "sub": "<your server short ID>", "iat": ... }
iat
, 'issued-at-time', should update automatically to be the current time.) - Replace
your-256-bit-secret
with your JWT secret password
Copy the 'Encoded' token (it should start with
ey
).In the
.env
file, setKAFKATORIO_TOKEN
to equal the token. - In 'PAYLOAD: DATA', set
-
In
kafkatorio-platform
, start the docker containersdocker-compose up -d; docker-compose logs -f