This Docker container allows you to host multiple instances of OpenTTD dedicated servers in a single container, providing an efficient and convenient environment for hosting these servers.
This documentation expect a basic knowledge of docker (expose ports and volumes).
The current state of this Project is BETA. Hosting works and every function was tested but as you now a developer should not test his own software. Please create an issue if something needs to be fixed.
It provides the following features:
- Login protected admin gui
- Managing multiple dedicated OpenTTD server instance. You just need to expose the needed ports on container startup.
- Upload/Download of save games and configuration files
- Password protection for dedicated servers
- Auto save of running servers
- Auto pause and unpause on inactive servers. If no player is playing the server is running but paused. Server unpauses if a player joins a company.
- Simple terminal to send commands directly to the dedicated server
The following table shows which docker image contains which OpenTTD version. For now, I will only support final versions (no beta).
| Container | OpenTTD |
|---|---|
| hauschi86/openttd-server:latest | 14.0 |
| hauschi86/openttd-server:v14.0.0 | 14.0 |
| hauschi86/openttd-server:v13.4.0 | 13.4 |
| hauschi86/openttd-server:v13.0.0 | 13.0 |
| hauschi86/openttd-server:v12.2.2 | 12.2 |
By default, docker does not expose the containers on your network. This must be done manually with -p parameter (see here for more details on -p).
For the container to work you need to expose at least 2 ports. The port 8080 for the web application and the port for your openttd dedicated server (default: 3979)
All data and uploads within the container are saved in the /home/openttd/server directory.
Opentdd is installed on /home/openttd/openttd-<version> directory.
When you start the Docker container for the OpenTTD server for the first time, it will log the password for the admin login. See fragment below. You can use the admin user to log in to the web app, which runs on http://localhost:8080 by default. Once logged in, you can access the web app's settings to change the admin password.
First startup log fragment with password
...
###########################################################################
### No initial password was set. A password for 'admin' will be generated.
### Copy it NOW, because it will never be shown again.
### Password: W!318Y-yBb
###########################################################################
...
Info: If you have a specific version of the container that you prefer to use, you can replace the example version with your chosen version. This will ensure that you are using the version of the container that best meets your needs and preferences.
Run OpenTTD Server with 1 exposed port. In this case you can host only 1 server.
docker run -d -p 8080:8080 -p 3979:3979/tcp -p 3979:3979/udp hauschi86/openttd-server:latest
Run OpenTTD Server with 20 exposed port. In this case you can host 20 server.
docker run -d -p 8080:8080 -p 3979-3999:3979-3999/tcp -p 3979-3999:3979-3999/udp hauschi86/openttd-server:latest
The container uses a simple file storage to store data. If you want to have persistent storage you should create a volume and bind it.
docker run -d -v openttd-server-volumne:/home/openttd/server -p 8080:8080 -p 3979-3999:3979-3999/tcp -p 3979-3999:3979-3999/udp hauschi86/openttd-server:latest
- Open a terminal in the
rootdirectory docker build -f src/main/docker/Dockerfile.dev . --progress=plain -t openttd-serverdocker run -i --rm -p 8080:8080 -p 5005:5005 -p 3979:3979/tcp -p 3979:3979/udp -e QUARKUS_LAUNCH_DEVMODE=true openttd-serveropenttd -D -b 8bpp-optimizedRun with possibility to do screenshots (https://www.tt-forums.net/viewtopic.php?t=88943)- https://quarkus.io/guides/maven-tooling#remote-development-mode
- https://blog.sebastian-daschner.com/entries/quarkus-remote-dev-in-containers-update
- Add properties to
application.properties
quarkus.package.type=mutable-jar
quarkus.live-reload.password=Password_1
quarkus.live-reload.url=http://localhost:8080
- Add env values to dockerfile expose debug port and add remote debug to startup:
EXPOSE 5005
ENV QUARKUS_LAUNCH_DEVMODE=true
ENV JAVA_ENABLE_DEBUG=true
CMD ["java","-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=0.0.0.0:5005", "-jar", "/deployments/quarkus-run.jar"]
- Start dev environment in remote debug mode (but disable local debug):
mvn quarkus:remote-dev -Ddebug=false -Dquarkus.live-reload.url=http://localhost:8080
| Description | Command |
|---|---|
| Create Module with routing | npx ng g m HomeIndex --flat --routing |
| Create Component and add to module | npx ng g m LoginIndex --flat && npx ng g c LoginIndex --flat -m .\login-index.module.ts |