Guest User

tehsys

a guest
Dec 19th, 2009
357
Never
Not a member of Pastebin yet? Sign Up, it unlocks many cool features!
  1. =================================================
  2. TeamSpeak 3 Server - Pre-Release Quickstart Guide
  3. =================================================
  4.  
  5. Copyright (c) 2009 TeamSpeak Systems GmbH
  6.  
  7. ********************************** IMPORTANT ***********************************
  8. * During the ATHP pre-release program we will provide support *ONLY* by email *
  9. * at "prptechsupport@tritoncia.com". *
  10. * *
  11. * Please do *NOT* post your questions in the forum on www.teamspeak.com during *
  12. * the ATHP pre-release program. There will be no support on the forum. Thank *
  13. * you for your understanding. *
  14. ********************************** IMPORTANT ***********************************
  15.  
  16. -----------------------
  17. (1) System requirements
  18. -----------------------
  19.  
  20. (i) Windows
  21. Windows 2000, XP, 2003, 2008, Vista and 7. Both 32bit and 64bit are natively
  22. supported.
  23.  
  24. (iii) Linux
  25. A reasonably modern Linux environment with libstdc++ 6 is required. Both 32bit
  26. and 64bit are natively supported.
  27.  
  28. (ii) Mac OS X
  29. Mac OS X 10.3.9 or better on Macs with Intel or PowerPC processors.
  30.  
  31. ----------------
  32. (2) Installation
  33. ----------------
  34.  
  35. (i) Windows
  36.  
  37. Download the correct file for your architecture:
  38. - teamspeak3-server_win32.zip for 32-bit Windows
  39. - teamspeak3-server_win64.zip for 64-bit Windows
  40.  
  41. We recommend running the TeamSpeak 3 Server from the command shell. Extract the
  42. archive in a directory of your choice. Open the command shell and change path to
  43. this directory. From here you can start the server executable.
  44.  
  45. Example 32-bit:
  46. $ cd C:\ts3server\teamspeak3-server_win32
  47. $ ts3server_win32.exe
  48.  
  49. Example 64-bit:
  50. $ cd C:\ts3server\teamspeak3-server_win64
  51. $ ts3server_win64.exe
  52.  
  53. (ii) Linux
  54.  
  55. Download the correct file for your architecture:
  56. - teamspeak3-server-linux_x86.tar.gz for 32-bit Linux
  57. - teamspeak3-server-linux_amd64.tar.gz for 64-bit Linux
  58.  
  59. Extract the archive in a directory of your choice and run the TeamSpeak 3 Server
  60. binary.
  61.  
  62. Example 32-bit:
  63. $ tar xzf teamspeak3-server-linux_x86.tar.gz
  64. $ cd teamspeak3-server-linux_x86
  65. $ ./ts3server_linux_x86
  66.  
  67. Example 64-bit:
  68. $ tar xzf teamspeak3-server-linux_amd64.tar.gz
  69. $ cd teamspeak3-server-linux_amd64
  70. $ ./ts3server_linux_amd64
  71.  
  72. (iii) Mac OS X
  73.  
  74. Download the file teamspeak3-server-mac.zip, which includes an universal
  75. binary running on both Intel and PowerPC Macintosh computers. Copy the archive
  76. into a directory of your choice and extract it using Finder or the Terminal
  77. application.
  78.  
  79. $ unzip teamspeak3-server_mac.zip
  80. $ cd teamspeak3-server_mac
  81. $ ./ts3server_mac
  82.  
  83. ----------------
  84. (3) License File
  85. ----------------
  86.  
  87. To run the TeamSpeak 3 Server you require a license file. The license can be
  88. obtained at https://sales.tritoncia.com/.
  89.  
  90. Without a proper license file available the server will refuse to start. Once
  91. the license file is available, copy it into the TeamSpeak 3 Server directory,
  92. where the server executable is located.
  93.  
  94. -----------------------------
  95. (4) Server Output and Logfile
  96. -----------------------------
  97.  
  98. On Linux and Mac OS X the server will print its log output to the console in
  99. which you started it. In addition the log output is written into a file,
  100. located in the logs/ subdirectory.
  101.  
  102. Note: On Windows the server will only write the logfile, there is no console
  103. output.
  104.  
  105. -------------------
  106. (5) Virtual Servers
  107. -------------------
  108.  
  109. Like with TeamSpeak 2, the server process serves as a container for multiple
  110. virtual servers running within the same process. When the server process is
  111. started, one virtual voice server will be automatically created unless the
  112. "create_default_virtualserver=0" commandline parameter is specified.
  113.  
  114. The first virtual server will be running on port 9987 by default. Subsequently
  115. started virtual servers will be running on increasing port numbers. The second
  116. on 9998, the third on 9999 etc. The first default port can be changed by
  117. specifying the "default_voice_port=<port>" commandline parameter.
  118.  
  119. Virtual servers are always unique, marked by an unique identifier. Hence it is
  120. not possible to start the same virtual server within a second server process.
  121.  
  122. Note: Changes to template or serverquery groups require a restart to affect the
  123. other virtual servers within a server process.
  124.  
  125. --------------------------
  126. (6) Commandline Parameters
  127. --------------------------
  128.  
  129. Commandline parameters are passed to the TeamSpeak 3 Server using the form:
  130.  
  131. ts3server_<arch> <parameter1>=<value1> [<parameter2>=<value2>] ...
  132.  
  133. Important: All commandline parameters passed to the server need to be escaped
  134. using the ServerQuery escape patterns (check the ServerQuery manual for details).
  135.  
  136. Example:
  137. $ ./ts3server_linux_x86 clear_database=1 create_default_virtualserver=0
  138.  
  139. Commandline parameters are not saved over sessions, so if you passed paramaters
  140. when starting the server process, you need to pass them again the next time. If
  141. a parameter is not specified, the default value will be used, regardless of
  142. parameters specified during a previous server start.
  143.  
  144. The following commandline parameters are available:
  145.  
  146. * default_voice_port (9987)
  147. UDP port open for clients to connect to. This port is used by the first
  148. virtual server, subsequently started virtual servers will open on increasing
  149. port numbers.
  150. Default: The default voice port is 9987.
  151.  
  152. * voice_ip (0.0.0.0)
  153. IP on which the server instance will listen for incoming voice connections.
  154. Default: The server is bound on any IP address.
  155.  
  156. * create_default_virtualserver (1)
  157. Normally one virtual server is created automatically when the TeamSpeak 3
  158. Server process is started. To disable this behaviour, set this parameter
  159. to "0". In this case you have to start virtual servers manually using the
  160. ServerQuery interface.
  161. Default: If not provided, one virtual server is created.
  162.  
  163. * machine_id (<empty>)
  164. Optional name of this server process to identity a group of servers with
  165. the same ID.
  166. Default: The server instance will not use a machine ID.
  167.  
  168. * filetransfer_port (30033)
  169. TCP Port opened for file transfers. If you specify this parameter, you also
  170. need to specify the "filetransfer_ip" parameter!
  171. Default: The default file tranfer port is 30033.
  172.  
  173. * filetransfer_ip (0.0.0.0)
  174. IP on which the file transfers are bound to. If you specify this parameter,
  175. you also need to specify the "filetransfer_port" parameter!
  176. Default: File transfers are bound on any IP address.
  177.  
  178. * query_port (10011)
  179. TCP Port opened for ServerQuery connections. If you specify this parameter,
  180. need to specify the "query_ip" parameter!
  181. Default: The default ServerQuery port is 10011.
  182.  
  183. * query_ip (0.0.0.0)
  184. IP bound for incoming ServerQuery connections. If you specify this parameter,
  185. you also need to specify the "query_port" parameter!
  186. Default: ServerQuery connections are bound on any IP address.
  187.  
  188. * clear_database (0)
  189. If set to "1", the server database will be cleared before starting up the server.
  190. This is mainly used for testing. Usually this parameter should not be specified,
  191. so all server settings will be restored when the server process is restarted.
  192. Default: Database is not cleared on start.
  193.  
  194. * logpath (logs/)
  195. The physical path where the server will create logfiles.
  196. Default: The server will search for SQL script files in the "logs/" subdirectory.
  197.  
  198. * dbplugin (ts3db_sqlite3)
  199. Name of the database plugin library used by the server instance. For example, if
  200. you want to start the server with MySQL support, simply set this parameter to
  201. "ts3db_mysql" to use the MySQL plugin. Do *NOT* specify the "lib" prefix or the file
  202. extension of the plugin.
  203. Default: The default SQLite3 database plugin will be used.
  204.  
  205. * dbpluginparameter (<empty>)
  206. A custom parameter passed to the database plugin library. For example, the MySQL
  207. database plugin supports a parameter to specify the physical path of the plugins
  208. configuration file.
  209. Default: The database plugin will be used without a parameter.
  210.  
  211. * dbsqlpath (sql/)
  212. The physical path where your SQL script files are located.
  213. Default: The server will search for SQL script files in the "sql/" subdirectory.
  214.  
  215. * dbsqlcreatepath (create_sqlite/)
  216. The physical path where your SQL installation files are located. Note that this
  217. path will be added to the value of the "dbsqlpath" parameter.
  218. Default: The server will search for SQL installation scripts files in the
  219. "<dbsqlpath>/dbsqlcreatepath/" subdirectory.
  220.  
  221. * licensepath (<empty>)
  222. The physical path where your license file is located.
  223. Default: The license file is located in your servers installation directory.
  224.  
  225. * createinifile (0)
  226. If set to "1", the server will create an INI-style config file containing all
  227. commandline parameters with the values you have specified.
  228. Default: The server will not create a config file.
  229.  
  230. * inifile (ts3server.ini)
  231. The physical path where your config file is located. Per default, the config file will
  232. be called "ts3server.ini".
  233. Default: The config file is located in your servers installation directory.
  234.  
  235. ------------------------------------
  236. (7) Using Alternate Database Plugins
  237. ------------------------------------
  238.  
  239. (i) MySQL plugin
  240.  
  241. To make your TeamSpeak 3 Server use a MySQL database you need to make sure that the
  242. "ts3db_mysql" library is located in your servers installation directory. Per default,
  243. the plugin is using the following parameters:
  244.  
  245. * host (127.0.0.1)
  246. The hostname or IP addresss of your MySQL server.
  247.  
  248. * port (3306)
  249. The TCP port of your MySQL server.
  250.  
  251. * username (root)
  252. The username used to authenticate with your MySQL server.
  253.  
  254. * password (<empty>)
  255. The password used to authenticate with your MySQL server.
  256.  
  257. * database (test)
  258. The name of a database on your MySQL server. Note that this database must be created
  259. before the TeamSpeak 3 Server is started.
  260.  
  261. * socket (<empty>)
  262. The name of the Unix socket file to use, for connections made via a named pipe to a
  263. local server.
  264.  
  265. All parameters can be customized by creating a INI-style configuration file called
  266. "ts3db_mysql.ini". For example:
  267.  
  268. [config]
  269. host=localhost
  270. port=3306
  271. username=teamspeak
  272. password=x5gUjs
  273. database=ts3db
  274. socket=
  275.  
  276. The path and filename of the configuration file can be set using the "dbpluginparameter"
  277. commandline parameter.
  278.  
  279. To start the TeamSpeak 3 Server with MySQL support, you need to specify the "dbplugin"
  280. commandline parameter. You may also need to specify the "dbsqlcreatepath" parameter if
  281. you're starting the server instance for the first time since the syntax of the MySQL
  282. installation files differs from SQLite3.
  283.  
  284. Example:
  285. $ ./ts3server_linux_amd64 dbplugin=ts3db_mysql dbsqlcreatepath=create_mysql/
  286.  
  287. -------------------------------
  288. (8) Gaining Adminstrator Access
  289. -------------------------------
  290.  
  291. (i) Regular clients
  292.  
  293. The first time a virtual server is created, a server administrator token will
  294. be automatically created in the server log with the following form:
  295.  
  296. --------------------------------------------------------
  297. ServerAdmin token created, please use the line below
  298. token=ppEa0Wp6hopKBzKhH5RiUtb5Ggve5aI8J7ifu+/P
  299. --------------------------------------------------------
  300.  
  301. This token can be used in the TeamSpeak 3 Client to gain administrator permissions
  302. for the currently logged in client. A token can only be used *ONCE*.
  303.  
  304. The server log is written to a file in the logs subdirectory. On Linux and Mac OS X
  305. it is also printed to the console from which the server was started.
  306.  
  307. (ii) ServerQuery clients
  308.  
  309. To gain global administration permissions for ServerQuery access, the first time
  310. the server instance is started a ServerQuery password is printed to the console
  311. output:
  312.  
  313. ------------------------------------------------------------------
  314. I M P O R T A N T
  315. ------------------------------------------------------------------
  316. Server Query Admin Acccount created
  317. loginname= "serveradmin", password= "BAIPwM8X"
  318. ------------------------------------------------------------------
  319.  
  320. Use the provided login name and password to access the server using the ServerQuery
  321. interface.
  322.  
  323. Note: The ServerQuery password are only shown *ONCE* when the server is started for
  324. the first time, so make sure you save this information for future reference. The only
  325. way to generate a new token and password would be to delete the server database by
  326. starting server with the "clear_database=1" commandline paramater or deleting the file
  327. ts3server.sqlitedb. In this case all server settings and user accounts would be lost.
  328.  
  329. -----------------------------------------------
  330. (8) Understandng the Status of a Virtual Server
  331. -----------------------------------------------
  332.  
  333. The status of a virtual server can be:
  334.  
  335. * online
  336. The virtual server is running and clients can connect
  337.  
  338. * none
  339. The virtual server is not running
  340.  
  341. * virtual
  342. The virtual server is running *isolated* and clients cannot connect
  343.  
  344. Whenever you select a virtual server which is currently stopped, it will be started in
  345. virtual mode which means you are able to change its configuration, create channels or
  346. change permissions, but no regular TeamSpeak 3 Client can connect. As soon as the last
  347. ServerQuery client deselects the virtual server (command: "use 0") or closes connection,
  348. its status will be changed back to "none".
  349.  
  350. Note: Changing a virtual servers status from "virtual" to "none" is an asynchronous operation
  351. so it is possible that a virtual server will still be in the process of shutting down when you
  352. try to start it right after deselcting it.
RAW Paste Data