mirror of
https://github.com/luzifer-docker/teamspeak3.git
synced 2024-12-20 14:41:17 +00:00
Adjust README to newest changes with v3.1.0
Signed-off-by: Knut Ahlers <knut@ahlers.me>
This commit is contained in:
parent
3c4c71c65c
commit
19f5e25f18
1 changed files with 28 additions and 26 deletions
54
README.md
54
README.md
|
@ -7,28 +7,22 @@ This image contains a Teamspeak 3 server based on Debian Linux.
|
||||||
- Debian
|
- Debian
|
||||||
- Teamspeak 3 Server
|
- Teamspeak 3 Server
|
||||||
- Some files can be injected to host:
|
- Some files can be injected to host:
|
||||||
- `query_ip_whitelist.txt`
|
|
||||||
- `query_ip_blacklist.txt`
|
|
||||||
- `logs`
|
|
||||||
- `files`
|
- `files`
|
||||||
- `ts3server.sqlitedb`
|
- `licensekey.dat` (Maybe, don't have one)
|
||||||
- `licence` (Maybe, don't have one)
|
- `logs`
|
||||||
|
- `query_ip_blacklist.txt`
|
||||||
|
- `query_ip_whitelist.txt`
|
||||||
- `ts3server.ini`
|
- `ts3server.ini`
|
||||||
|
- `.ts3server_license_accepted` (Accept license - see "Create container" below)
|
||||||
|
- `ts3server.sqlitedb`
|
||||||
|
|
||||||
## Usage
|
## Usage
|
||||||
|
|
||||||
### Infos
|
### Infos
|
||||||
|
|
||||||
The script does look for an sqlite db in the linked host-folder.
|
The script does look for an sqlite db in the linked host-folder. If its found, a symlink is created to the ts3-folder inside the container. This means the server should use your old ts3 db if present. If not present it will create a new one, right now this will NOT be created under the linked host-folder! The problem here is i cant tell the TS3 server to create the db in specific folder. Creating a empty file and then linking this did not work either since TS3 is then complaining its no sqlite db.
|
||||||
If its found, a symlink is created to the ts3-folder inside the container.
|
|
||||||
This means the server should use your old ts3 db if present.
|
|
||||||
If not present it will create a new one, right now this will NOT be created under the linked host-folder!
|
|
||||||
The problem here is i cant tell the TS3 server to create the db in specific folder.
|
|
||||||
Creating a empty file and then linking this did not work either since TS3 is then complaining its no sqlite db.
|
|
||||||
|
|
||||||
Script will also look for ts3server.ini in linked host-folder. This file will also be created if its not
|
Script will also look for ts3server.ini in linked host-folder. This file will also be created if its not found since TS3-server has a paramater for that. If you use your own ini-file you may want to link logs and other data to /teamspeak3. This way you can mount the directory and backup/persist the data even when upgrading.
|
||||||
found since TS3-server has a paramater for that. If you use your own ini-file you may want to link logs and other data to /teamspeak3.
|
|
||||||
This way you can mount the directory and backup/persist the data even when upgrading.
|
|
||||||
|
|
||||||
The files-directory is also currently not persisted in the linked host-folder.
|
The files-directory is also currently not persisted in the linked host-folder.
|
||||||
|
|
||||||
|
@ -36,32 +30,40 @@ The files-directory is also currently not persisted in the linked host-folder.
|
||||||
|
|
||||||
Just in case you dont wanna use the index.
|
Just in case you dont wanna use the index.
|
||||||
|
|
||||||
```
|
```bash
|
||||||
$ docker build https://github.com/luzifer-docker/docker-teamspeak3.git
|
$ docker build https://github.com/luzifer-docker/teamspeak3.git
|
||||||
```
|
```
|
||||||
|
|
||||||
### Create container
|
### Create container
|
||||||
|
|
||||||
This creates and starts a docker container in the
|
This creates and starts a docker container in the background (`-d`) with direct mapping of the TS3 port (`-p 9987:9987/udp`) and sets the name to TS3. `{FOLDER}` is an absolute path on the host to be mapped by the containers /teamspeak3 folder. Injected files are used from this location, see Summary above.
|
||||||
background (-d) with
|
|
||||||
direct mapping of the TS3 port (-p 9987:9987/udp)
|
|
||||||
and sets the name to TS3.
|
|
||||||
{FOLDER} is an absolute path on the host to be mapped by the containers /teamspeak3 folder.
|
|
||||||
Injected files are used from this location, see Summary above.
|
|
||||||
|
|
||||||
|
Starting in version 3.1.0 Teamspeak needs you to accept the license included with the server. To accept the license pass `-e TS3SERVER_LICENSE=accept` to the command or create a `.ts3server_license_accepted` file in your `{FOLDER}`.
|
||||||
|
|
||||||
|
To review the license execute this command:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
$ docker run --rm --entrypoint /bin/cat luzifer/teamspeak3 /opt/teamspeak3-server_linux_amd64/LICENSE | less
|
||||||
```
|
```
|
||||||
$ docker run --name TS3 -d -p 9987:9987/udp -v {FOLDER}:/teamspeak3 luzifer/teamspeak3
|
|
||||||
|
Putting everything together this is how you will start your server:
|
||||||
|
|
||||||
|
```bash
|
||||||
|
# Optionally create license accept file
|
||||||
|
$ touch {FOLDER}/.ts3server_license_accepted
|
||||||
|
|
||||||
|
# Start container
|
||||||
|
$ docker run --name TS3 -d -e TS3SERVER_LICENSE=accept -p 9987:9987/udp -v {FOLDER}:/teamspeak3 luzifer/teamspeak3
|
||||||
```
|
```
|
||||||
|
|
||||||
### Admin Secret
|
### Admin Secret
|
||||||
|
|
||||||
After starting the container you probably want to get the Admin secret with:
|
After starting the container you probably want to get the Admin secret with:
|
||||||
|
|
||||||
```
|
```bash
|
||||||
$ docker logs TS3
|
$ docker logs TS3
|
||||||
```
|
```
|
||||||
|
|
||||||
### Upgrading
|
### Upgrading
|
||||||
|
|
||||||
Just stop and remove the old container, then start again at "Creating container". You may have to pull the image again if its not updating.
|
Just stop and remove the old container, then start again at "Creating container". You may have to pull the image again if its not updating. CAUTION: Didnt test if all files are really persisted or if the TS3 process overwrites some files. So make sure you have a backup.
|
||||||
CAUTION: Didnt test if all files are really persisted or if the TS3 process overwrites some files. So make sure you have a backup.
|
|
||||||
|
|
Loading…
Reference in a new issue