config doc

misc/config.php.sample

@@ -1,9 +1,38 @@
 <?php
+/*
+The MYSQL host (usally localhost).
+*/
 $database_host = "localhost";
+/*
+The MYSQL host port (usally 3306).
+*/
 $database_port = 3306;
+/*
+The database name to use (eg: vdm_storage).
+*/
 $database_name = "";
+/*
+The database user to connect as.
+Only needs SELECT and INSERT privilege on database.
+No global privilege are required.
+*/
 $database_user = "";
+/*
+The above user password.
+*/
 $database_pass = "";
+/*
+The folder to store uploaded images (eg: ./medias/).
+The variable MUST ends with a trailling slash (/).
+The web server only need write permission.
+*/
 $media_path = "";
+/*
+The public URL to access uploaded images (eg: /medias/).
+The variable MUST ends with a trailling slash (/).
+Note that it can also be on a different host:
+media_path = /var/images.api.vdm/ (can be a local folder or a mounted one)
+media_url = http://images.api.vdm.tld/
+*/
 $media_url = "";
 ?>