mirror of
https://github.com/Thor77/TeamspeakStats.git
synced 2025-03-12 17:44:32 -04:00
ef5894b407
* move documentation-source from /docs/source to /docs/ and build in /docs/_build instead of /docs/build * convert README to rst and remove information also present in documentation and refer to it * regenerate conf.py/Makefile with most recent Sphinx-version * add development.rst with information for contributors
40 lines
4.1 KiB
ReStructuredText
40 lines
4.1 KiB
ReStructuredText
Config
|
|
======
|
|
|
|
The configfile is using the .ini-format.
|
|
Currently all settings are read from the ``[General]``-section.
|
|
|
|
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| Key | Description |
|
|
+=====================+=================================================================================================================================================================================+
|
|
| log | Path to TS3Server-logfile(s) (supports `globbing <https://docs.python.org/3/library/glob.html>`__) |
|
|
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| output | Path to the location, where the generator will put the generated .html-file |
|
|
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| idmap | Path to `IdentMap <https://teamspeakstats.readthedocs.io/en/latest/identmap.html>`__ |
|
|
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| debug | debug mode |
|
|
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| onlinedc | Add timedelta from last-connect until now to onlinetime for connected clients |
|
|
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| template | Path to a custom template file (relative from ``tsstats/`` or absolute) |
|
|
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| datetimeformat | Format of date/time-values used for render-timestamp and last online (using `datetime.strftime <https://docs.python.org/3/library/datetime.html#strftime-strptime-behavior>`__) |
|
|
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
| onlinetimethreshold | Clients with an onlinetime below that threshold (in seconds) are hidden in the onlinetime-section |
|
|
+---------------------+---------------------------------------------------------------------------------------------------------------------------------------------------------------------------------+
|
|
|
|
Example
|
|
-------
|
|
|
|
``config.ini``
|
|
|
|
.. code-block:: ini
|
|
|
|
[General]
|
|
log = /usr/local/bin/teamspeak-server/logs/ts3server*_1.log
|
|
output = /var/www/html/stats.html
|
|
|
|
.. code-block:: console
|
|
|
|
$ tsstats -c config.ini
|