Skip to content

Commit 77c36f7

Browse files
author
Sebastian Krätzig
committed
2 parents f268a76 + b642236 commit 77c36f7

File tree

1 file changed

+19
-17
lines changed

1 file changed

+19
-17
lines changed

README.md

Lines changed: 19 additions & 17 deletions
Original file line numberDiff line numberDiff line change
@@ -1,10 +1,12 @@
11
# TS3UpdateScript
22

3-
**TS3UpdateScript** is the most used bash-script by companies to automate and optimaze the TeamSpeak 3 server update process. It is the fastest script you have ever seen for this task.
3+
**TS3UpdateScript** is the most used bash-script by companies to automate and optimize the TeamSpeak 3 server update process. This is the fastest script to run this task.
44

55
[Show TS3UpdateScript Best Practices](docs/TS3US_BEST_PRACTICES.md)
66

7-
It checks, if a newer version for your TeamSpeak 3 server instance is available or not. If yes, you can choose, if the script should update the server or not. You also have some parameters like "delete old logs files" and so on. Well... If you don't want to update your TeamSpeak 3 server manually, you can use this script. This script is doing ALL steps for a correct update process of your TeamSpeak 3 server.
7+
The script checks if a newer version of TeamSpeak 3 server is available. If yes, you can choose if the script updates your server. You also set parameters like "delete old logs files" and so on.
8+
9+
If you don't want to update your TeamSpeak 3 server manually, you can use this script. This script follows all of the steps to properly update your TeamSpeak 3 server.
810

911
## Table of content
1012

@@ -27,9 +29,9 @@ It checks, if a newer version for your TeamSpeak 3 server instance is available
2729
- [Multi usable](#multi-usable)
2830
- [Single usable](#single-usable)
2931
- [Work flow of the script](#work-flow-of-the-script)
30-
- [Used Ressources by the script](#used-ressources-by-the-script)
32+
- [Used Resources by the script](#used-resources-by-the-script)
3133
- [Directory Structure - Where can I find which file?](#directory-structure---where-can-i-find-which-file)
32-
- [Why got this script a high version number?](#why-got-this-script-a-high-version-number)
34+
- [Why does this have a high version number?](#why-does-this-have-a-high-version-number)
3335

3436
![Example Output](https://raw.githubusercontent.com/TS3Tools/TS3UpdateScript/master/img/TS3UpdateScript_Example_Summary.png)
3537

@@ -94,7 +96,7 @@ It checks, if a newer version for your TeamSpeak 3 server instance is available
9496

9597
## Requirements
9698

97-
- Linux (should work on the most distributations; below a list of explicit tested distributations)
99+
- Linux (should work on the most distributions; below a list of explicit tested distributions)
98100
- Debian 7 & 8
99101
- Ubuntu 15
100102
- CentOS 7
@@ -181,7 +183,7 @@ Need Review:
181183

182184
### Help us
183185

184-
We can not translate this script in each language, because we do not speak each language. But you can help us to get more language support by creating an own new language file with your mother language! And if you want to, send your translation to our email address above, that we can add your translation to the next version. As thank you we will name you in this document, if you want to.
186+
We cannot translate this script into each language. But you can help us achieve better language support by creating a new language file with your language! Please send your translation to our email address above, then we can add your translation to the next version. As thank you we will name you in this document, if you would like.
185187

186188
Just grab a copy of your language file, which you understand and translate the content between the two quotation marks. If you think it is ok, you can send us this file via email and we will add it to the TS3UpdateScript. You also can check it in the GitHub Project as new "Issue".
187189

@@ -308,17 +310,17 @@ Parameter | Description
308310

309311
## Work flow of the script
310312

311-
First it will check, if a newer version for the script self is available and afterwards it will check your installed version of each instance against the latest available version from teamspeak.de. It also will detect, if you are using TSDNS, SQLite or MySQL database and so on. If a newer version is available, the script will do following steps:
313+
First it will check if a newer version of the script is available; afterwards it will check your installed version of each instance against the latest available version from teamspeak.de. It also will detect if you are using TSDNS, SQLite or MySQL database, etc. If a newer version is available, the script will do following steps:
312314

313-
1. Download latest and named TeamSpeak 3 server files from 4players.de
315+
1. Download latest named TeamSpeak 3 server files from 4players.de
314316
2. Inform online clients on all virtual servers (if you want to; parameter '--inform-online-clients' needed)
315-
3. Stopp running TSDNS (if used)
317+
3. Stop running TSDNS (if used)
316318
4. Backup temporary virtual server passwords (if any is available)
317-
5. Stopp running server instance gracefully
319+
5. Stop running server instance gracefully
318320
6. Delete old logs (if you want to; parameter '--delete-old-logs' needed)
319321
7. Create backup of currently running TeamSpeak 3 server in '/tmp/TS3Tools/TS3UpdateScript/'
320322
8. Unzip downloaded TeamSpeak 3 server files
321-
9. Import licensekey (if available), database and Query IP Black- and Whitelist from backup
323+
9. Import licensekey (if available), database and Query IP Black and Whitelist from backup
322324
10. Import TSDNS settings file (if used)
323325
11. Delete ts3server.pid, if exists for correct start
324326
12. Delete downloaded TeamSpeak 3 server files
@@ -327,15 +329,15 @@ First it will check, if a newer version for the script self is available and aft
327329
15. Add commandline parameter to new ts3server_startscript.sh if INI-file is used
328330
16. Start updated TS3 server
329331
17. Restore temporary virtual server passwords (if any was backuped)
330-
18. Script waits 15 seconds and checks, if the server is running
332+
18. Script waits 15 seconds and checks if the server is running
331333
19. If the server is not running, the rollback will be executed
332-
20. Clean up system from created and downloaded files for the update process
334+
20. Clean up system from created and downloaded files from the update process
333335

334-
Those steps will the script execute for each installed instance, which will be checked.
336+
Those steps will execute for each installed instance of Teamspeak 3, which will be checked.
335337

336-
The files/ directory will not be touched by the script - also not backuped!
338+
The files/ directories will not be touched by the script - also not backuped!
337339

338-
## Used Ressources by the script
340+
## Used Resources by the script
339341

340342
Protocol | Host/IP | Used for | How often?
341343
:------------- | :------------- | :------------- | :-------------
@@ -354,7 +356,7 @@ Path | Description
354356
./configs/ | Configuration files
355357
./languages/ | Language files
356358

357-
## Why got this script a high version number?
359+
## Why does this have a high version number?
358360

359361
Because of the TeamSpeak 3 Server updates, customer wishes and suggestions to the script, however, constantly extended or optimized, which is the reason why it will never have a "final" version level.
360362

0 commit comments

Comments
 (0)