[CI SKIP] improved README with basic how-tos

Dieser Commit ist enthalten in:
Nick Slowinski 2021-10-17 09:44:58 +02:00
Ursprung 3534dc9ec1
Commit b5a948dade
Signiert von: nickslowinski
GPG-Schlüssel-ID: F7F36D4749228BAC
2 geänderte Dateien mit 115 neuen und 3 gelöschten Zeilen

Datei anzeigen

@ -35,6 +35,63 @@ You can run the image as any other image, it automatically exposes the required
| documents | `/JTS3ServerMod/documents` | Documentation files of the bot + original _changelog.txt_ and _readme.txt_ (+german variant) | | documents | `/JTS3ServerMod/documents` | Documentation files of the bot + original _changelog.txt_ and _readme.txt_ (+german variant) |
| plugins | `/JTS3ServerMod/plugins` | Additional plugins can be uploaded in this directory - please follow the original docs of the JTS3ServerMod | | plugins | `/JTS3ServerMod/plugins` | Additional plugins can be uploaded in this directory - please follow the original docs of the JTS3ServerMod |
### Examples
#### A container with named volumes and a given name
```
docker run --name jts3servermod-dockerized -v jts3_config:/JTS3ServerMod/config -v jts3_documents:/JTS3ServerMod/documents -v jts3_plugins:/JTS3ServerMod/plugins nickslowinski/jts3servermod-dockerized:dev
```
#### A container with mounted volumes and a given name
```
docker run --name jts3servermod-dockerized -v /some/path/on/host/jts3_config:/JTS3ServerMod/config -v /some/path/on/host/jts3_documents:/JTS3ServerMod/documents -v /some/path/on/host/jts3_plugins:/JTS3ServerMod/plugins nickslowinski/jts3servermod-dockerized:dev
```
## Common issues
### The container stops immediately after starting
If the log looks something like the following, **then this does not mean that the image is defective!** You have to configure the bot and restart it, as long as you have not made any errors in the configuration, the bot will start successfully.
```
JTS3ServerMod 6.5.7 (31.01.2020) Instance Manager started...
Operating System : Linux (version: 5.14.10-200.fc34.x86_64 / arch: amd64)
Used Java Version: 1.8.0_282 (path: /usr/lib/jvm/java-1.8-openjdk/jre)
Current directory: /JTS3ServerMod
Writing InstanceManager log file to: /JTS3ServerMod/JTS3ServerMod_InstanceManager.log
Loading InstanceManager config file from: /JTS3ServerMod/config/JTS3ServerMod_InstanceManager.cfg
bot1: Writing bot log file to: /JTS3ServerMod/JTS3ServerMod_server1.log
bot1: Virtual bot instance "bot1" starts now (build 6508)
bot1:
bot1: **********************************************************************************
bot1: It seems you never touched the config, check file config/server1/JTS3ServerMod_server.cfg
bot1: **********************************************************************************
bot1:
bot1: Unable to connect to Teamspeak 3 server at ts3.server.net!
bot1: java.net.UnknownHostException: ts3.server.net
bot1: Virtual bot instance "bot1" stopped
Stopping all bots, please wait...
```
### Error loading JTS3ServerMod InstanceManager configuration file
Example log:
```
JTS3ServerMod 6.5.7 (31.01.2020) Instance Manager started...
Operating System : Linux (version: 5.10.17-v8+ / arch: aarch64)
Used Java Version: 1.8.0_282 (path: /usr/lib/jvm/java-1.8-openjdk/jre)
Current directory: /JTS3ServerMod
Writing InstanceManager log file to: /JTS3ServerMod/JTS3ServerMod_InstanceManager.log
JTS3ServerMod InstanceManager configuration file does not exists, check file path:
/JTS3ServerMod/config/JTS3ServerMod_InstanceManager.cfg
Error while loading the JTS3ServerMod InstanceManager config file, read error messages above to know more. Quitting now...
```
So far, this error could always be traced back to outdated software versions. To fix this error, you only need to update the system, including Docker and its dependencies. If the error still occurs after a successful update and a subsequent system restart, please [create a ticket](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues/new).
## Getting Help ## Getting Help
Please use the [issue tracker](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues) to search for your problem (and use different phrases). If you ensure your problem is unique, [create a ticket](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues/new) and provide helpful information like logs, what you have done, useful parts of your config, etc. Please use the [issue tracker](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues) to search for your problem (and use different phrases). If you ensure your problem is unique, [create a ticket](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues/new) and provide helpful information like logs, what you have done, useful parts of your config, etc.
@ -49,7 +106,6 @@ A full contributors guide will be published at a later time.
- [Maintainers](MAINTAINERS) - [Maintainers](MAINTAINERS)
- [Contributors](CONTRIBUTORS) - [Contributors](CONTRIBUTORS)
- [Translators](TRANSLATORS)
## License ## License

Datei anzeigen

@ -35,6 +35,63 @@ Sie können das Image wie jeden anderen Container ausführen, es stellt automati
| documents | `/JTS3ServerMod/documents` | Dokumentationsdateien des Bots + Original _changelog.txt_ und _readme.txt_ (+deutsche Variante) | | documents | `/JTS3ServerMod/documents` | Dokumentationsdateien des Bots + Original _changelog.txt_ und _readme.txt_ (+deutsche Variante) |
| plugins | `/JTS3ServerMod/plugins` | In diesem Verzeichnis können zusätzliche Plugins hochgeladen werden - bitte folgen Sie der Dokumentation des JTS3ServerMod | | plugins | `/JTS3ServerMod/plugins` | In diesem Verzeichnis können zusätzliche Plugins hochgeladen werden - bitte folgen Sie der Dokumentation des JTS3ServerMod |
### Beispiele
#### Ein Container mit benannten Volumes und festgelegten Namen
```
docker run --name jts3servermod-dockerized -v jts3_config:/JTS3ServerMod/config -v jts3_documents:/JTS3ServerMod/documents -v jts3_plugins:/JTS3ServerMod/plugins nickslowinski/jts3servermod-dockerized:dev
```
#### Ein Container mit gemounteten Volumes und festgelegten Namen
```
docker run --name jts3servermod-dockerized -v /ein/pfad/auf/dem/host/jts3_config:/JTS3ServerMod/config -v /ein/pfad/auf/dem/host/jts3_documents:/JTS3ServerMod/documents -v /ein/pfad/auf/dem/host/jts3_plugins:/JTS3ServerMod/plugins nickslowinski/jts3servermod-dockerized:dev
```
## Häufige Probleme
### Der Container stoppt sofort nach dem Start
Falls der Log-Auszug in etwa so aussieht wie der nachfolgende, **dann bedeutet dies nicht, dass das Image defekt ist!** Ihr müsst den Bot konfigurieren und erneut starten, solange Ihr keine Fehler in der Konfiguration begangen habt, startet der Bot erfolgreich.
```
JTS3ServerMod 6.5.7 (31.01.2020) Instance Manager started...
Operating System : Linux (version: 5.14.10-200.fc34.x86_64 / arch: amd64)
Used Java Version: 1.8.0_282 (path: /usr/lib/jvm/java-1.8-openjdk/jre)
Current directory: /JTS3ServerMod
Writing InstanceManager log file to: /JTS3ServerMod/JTS3ServerMod_InstanceManager.log
Loading InstanceManager config file from: /JTS3ServerMod/config/JTS3ServerMod_InstanceManager.cfg
bot1: Writing bot log file to: /JTS3ServerMod/JTS3ServerMod_server1.log
bot1: Virtual bot instance "bot1" starts now (build 6508)
bot1:
bot1: **********************************************************************************
bot1: It seems you never touched the config, check file config/server1/JTS3ServerMod_server.cfg
bot1: **********************************************************************************
bot1:
bot1: Unable to connect to Teamspeak 3 server at ts3.server.net!
bot1: java.net.UnknownHostException: ts3.server.net
bot1: Virtual bot instance "bot1" stopped
Stopping all bots, please wait...
```
### Fehler beim Laden der JTS3ServerMod InstanceManager Konfigurationsdatei
Beispiel Log-Auszug:
```
JTS3ServerMod 6.5.7 (31.01.2020) Instance Manager started...
Operating System : Linux (version: 5.10.17-v8+ / arch: aarch64)
Used Java Version: 1.8.0_282 (path: /usr/lib/jvm/java-1.8-openjdk/jre)
Current directory: /JTS3ServerMod
Writing InstanceManager log file to: /JTS3ServerMod/JTS3ServerMod_InstanceManager.log
JTS3ServerMod InstanceManager configuration file does not exists, check file path:
/JTS3ServerMod/config/JTS3ServerMod_InstanceManager.cfg
Error while loading the JTS3ServerMod InstanceManager config file, read error messages above to know more. Quitting now...
```
Dieser Fehler konnte bisher immer nachweislich auf veraltete Softwareversionen zurückgeführt werden. Um diesen Fehler zu beheben, muss nur das System, unter anderem auch Docker und dessen Abhängigkeiten, aktualisiert werden. Sollte der Fehler nach erfolgreicher Aktualisierung und einem anschließenden Systemneustart immer noch auftreten, so [eröffnet bitte ein Ticket](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues/new).
## Hilfe bekommen ## Hilfe bekommen
Bitte verwenden Sie den [Issue Tracker](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues), um nach Ihrem Problem zu suchen (und verwenden Sie unterschiedliche Schlagwörter). Wenn Sie sichergestellt haben, dass Ihr Problem eindeutig ist, [erstellen Sie ein Ticket](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues/new) und geben Sie hilfreiche Informationen wie Protokolle, was Sie getan haben, nützliche Teile deiner Konfiguration usw. an. Bitte verwenden Sie den [Issue Tracker](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues), um nach Ihrem Problem zu suchen (und verwenden Sie unterschiedliche Schlagwörter). Wenn Sie sichergestellt haben, dass Ihr Problem eindeutig ist, [erstellen Sie ein Ticket](https://git.nick-slowinski.de/NickSlowinski/JTS3ServerMod-dockerized/issues/new) und geben Sie hilfreiche Informationen wie Protokolle, was Sie getan haben, nützliche Teile deiner Konfiguration usw. an.
@ -49,7 +106,6 @@ Ein vollständiger Leitfaden für Mitwirkende wird zu einem späteren Zeitpunkt
- [Maintainer](MAINTAINERS) - [Maintainer](MAINTAINERS)
- [Mitwirkende](CONTRIBUTORS) - [Mitwirkende](CONTRIBUTORS)
- [Übersetzer](TRANSLATORS)
## Lizenz ## Lizenz
@ -65,6 +121,6 @@ Vorerst nicht, aber wenn jemand eine andere Architektur anfordert (über den Iss
Ich möchte das Image so klein wie möglich halten, daher wurde OpenJDK 8 über 11 gewählt. Solange OpenJDK 8 unterstützt wird und für dieses Projekt ausreichend ist, wird es verwendet. Ich möchte das Image so klein wie möglich halten, daher wurde OpenJDK 8 über 11 gewählt. Solange OpenJDK 8 unterstützt wird und für dieses Projekt ausreichend ist, wird es verwendet.
### Wird die JTS3ServerMod Hosting Edition unterstützt? ### Wird die JTS3ServerMod Hosting Edition unterstützt?
Nicht im Moment. Ich kann ein Image dafür erstellen (Stefan1200 stellt die Downloads dafür bereit), aber es gibt keine Möglichkeit, es zu testen, da ich keinen Lizenzschlüssel dafür habe. Nicht im Moment. Ich kann ein Image dafür erstellen (Stefan1200 stellt die Downloads dafür bereit), aber es gibt keine Möglichkeit, es zu testen, da ich keinen Lizenzschlüssel dafür habe.