varakh/ts3web
Archived
1
0
Fork 0
Code Releases 24 Activity Actions

Change links for moving away from GitHub

Browse source
This commit is contained in:
Varakh 2022-07-05 17:46:47 +02:00
parent fb578fd670
commit f327088771
1 changed files with 23 additions and 7 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

30
README.md
View file

@ -5,7 +5,7 @@ ts3web is a free and open-source web interface for TeamSpeak 3 instances.
The minimalistic approach of this application is intentional. The minimalistic approach of this application is intentional.
* Docker images available on [https://hub.docker.com/r/varakh/ts3web](https://hub.docker.com/r/varakh/ts3web) * Docker images available on [https://hub.docker.com/r/varakh/ts3web](https://hub.docker.com/r/varakh/ts3web)
* Sources are hosted on [https://github.com/v4rakh/ts3web](https://github.com/v4rakh/ts3web) * Sources are hosted on [https://git.myservermanager.com/varakh/ts3web](https://git.myservermanager.com/varakh/ts3web)
There are many TeamSpeak 3 web interfaces out. Why should I pick ts3web? Free, simple, stateless, easy to extend, There are many TeamSpeak 3 web interfaces out. Why should I pick ts3web? Free, simple, stateless, easy to extend,
standard bootstrap theme. standard bootstrap theme.
@ -79,12 +79,28 @@ In the `docker-compose.yml` [example](#docker-compose), a setup together with a
**Important. Read before setup!** **Important. Read before setup!**
1. [Setup write permissions if you're using host binds](#i-always-get-no-write-permissions-or-something-similar-when-trying-to-save-snapshots-or-when-a-log-entry-is-created) - [README](#readme)
2. [Ensure that you increase `query commands usage` in your TeamSpeak server](#how-to-overcome-server-query-limit). - [READ BEFORE USING](#read-before-using)
3. [Use a `whitelist.txt` to ensure the web interface will not be query banned](#whitelist-text-file) - [F.A.Q](#faq)
4. Be aware that the web interface will not be able to use `localhost` as TeamSpeak 3 server address because it's not - [How to overcome server query limit?](#how-to-overcome-server-query-limit)
available in a docker container. The public address also has to match the environment variable - [I always get `no write permissions` or something similar when trying to save snapshots or when a log entry is created.](#i-always-get-no-write-permissions-or-something-similar-when-trying-to-save-snapshots-or-when-a-log-entry-is-created)
`teamspeak_host=your-public-address` within the `env` file. - [Configuration](#configuration)
- [Deployment](#deployment)
- [Docker](#docker)
- [docker standalone](#docker-standalone)
- [docker-compose](#docker-compose)
- [whitelist text file](#whitelist-text-file)
- [As native PHP application](#as-native-php-application)
- [Install:](#install)
- [Upgrade:](#upgrade)
- [Reverse proxy](#reverse-proxy)
- [Limitations](#limitations)
- [Development](#development)
- [Release](#release)
- [Prepare next development cycle](#prepare-next-development-cycle)
- [Helpers](#helpers)
- [Translations](#translations)
- [Theme](#theme)
#### docker standalone #### docker standalone