Kafkatorio/docs/kafkatorio-platform/example.env
Lazzexus 1f4786c1bd Rewrite the README and setup guide, and fix the example Compose setup
The README describes what Kafkatorio does now (the live map, production
and research pages), that this is a Factorio 2.0 fork, and how the
services fit together.

The guide is rewritten as numbered steps, from building the images to a
public website: configuration, creating the server's token locally
(instead of typing the secret into jwt.io), connecting the Factorio
server's log, sending the existing map, exporting icons and names, and
the reverse proxy. Also: the Unraid setup, updating, and troubleshooting.

It warns that the mod portal's kafkatorio-events is the original, for
Factorio 1.1, with overlapping version numbers, so players must install
the mod zip by hand.

The example docker-compose.yml lost all data when containers were
recreated (e.g. on every update), and exposed Kafka, which has no
authentication, on all interfaces. It's now based on the Unraid setup:
Kafka data, map tiles, state and icons are kept next to it, only the
website is exposed, and the optional Factorio server (--profile factorio)
starts after the syslog server.

Co-Authored-By: Claude Opus 5.5 <noreply@anthropic.com>
2026-11-22 10:36:01 +01:00

12 lines
575 B
Bash

# Docker Compose settings - copy to `.env`
# the version of the Kafkatorio images you built (the `version` in build.gradle.kts)
KAFKATORIO_VERSION=0.10.1
# images are built locally, and tagged `localhost/dev.adamko.kafkatorio/...`
REGISTRY_HOST=localhost
# Only needed for the optional Factorio server (`docker compose --profile factorio up -d`)
# A factoriotools/factorio tag: https://hub.docker.com/r/factoriotools/factorio
FACTORIO_VERSION=stable
# The Factorio server's token - see "Create a token for the Factorio server" in docs/guide.md
KAFKATORIO_TOKEN=<jwt token>