Просмотр исходного кода

Updated documentation and telemetry

dosse91 9 лет назад
Родитель
Сommit
929a7221eb
2 измененных файлов с 10 добавлено и 8 удалено
  1. 9 7
      doc.md
  2. 1 1
      telemetry.php

+ 9 - 7
doc.md

@@ -1,7 +1,7 @@
 # HTML5 Speedtest
 
 > by Federico Dossena  
-> Version 4.3.1, August 25 2017  
+> Version 4.3.2, September 5 2017
 > [https://github.com/adolfintel/speedtest/](https://github.com/adolfintel/speedtest/)
 
 
@@ -249,21 +249,23 @@ You need to start the test with your replacements like this:
 w.postMessage('start {"url_dl": "newGarbageURL", "url_ul": "newEmptyURL", "url_ping": "newEmptyURL", "url_getIp": "newIpURL"}')
 ```
 ## Telemetry
-Telemetry currently requires PHP and MySQL.  
+Telemetry currently requires PHP and either MySQL or SQLite.  
 To set up the telemetry, we need to do 4 things:
 * copy `telemetry.php`
-* edit `telemetry.php` to add your database access credentials
+* edit `telemetry.php` to add your database settings
 * create the database
 * enable telemetry
 
 ### Creating the database
-At the moment, only MySQL is supported.  
+This step is only for MySQL. Skip this if you want to use SQLite.
 Log into your database using phpMyAdmin or a similar software and import `telemetry.sql` into an empty database.  
 If you see a table called `speedtest_users`, empty, you did it right.
 
 ### Configuring `telemetry.php`
-Open telemetry.php with notepad or a similar text editor, and insert your database access credentials
-```
+Open telemetry.php with notepad or a similar text editor.  
+Set your preferred database, ``$db_type="mysql";`` or ``$db_type="sqlite";``  
+If you choose to use MySQL, you must also add your database credentials:
+```php
 $MySql_username="USERNAME"; //your database username
 $MySql_password="PASSWORD"; //your database password
 $MySql_hostname="DB_HOSTNAME"; //database address, usually localhost\
@@ -278,7 +280,7 @@ There are 3 levels:
 * `full`: same as above, but also collects a log (10-150 Kb each, not recommended)
 
 Example:
-```
+```js
 w.postMessage('start {"telemetry_level":"basic"}')
 ```
 

+ 1 - 1
telemetry.php

@@ -1,5 +1,5 @@
 <?php
-$db_type="sqlite"; //Type db mysql or sqlite
+$db_type="mysql"; //Type db mysql or sqlite
 
 $ip=($_SERVER['REMOTE_ADDR']);
 $ua=($_SERVER['HTTP_USER_AGENT']);