Documented the config.sample.php configuration variables and meaning behind them. Also explains the refresh_key usage.

This commit is contained in:
Ismo Vuorinen
2013-11-22 09:29:04 +02:00
parent e0cda5cfa0
commit b54f5f12c8

View File

@@ -11,6 +11,24 @@
* @license http://www.gnu.org/licenses/agpl.html GNU Affero General Public License
* @link https://github.com/Ekokumppanit/Lentolaskuri
*/
/**
* Configuration variables for Lentolaskuri
*
* Database settings
* - server = database server address
* - db = database name
* - user = database username
* - password = database password
* - table = database table to store airport names and locations
* - create_table = true or false, should running import.php try to create database table
* - refresh_key = semi-secret key to use to trigger import action: import.php?key=[the key]
*
* Please change the refresh_key and use it to import airport data to the database.
* Use the key as an url parameter: http://example.com/lentolaskuri/api/import.php?key=[the key]
*
* @var array
*/
$config = array(
'server' => 'localhost',
'db' => 'database',