diff --git a/Installation-Guide.md b/Installation-Guide.md index 37a5971..ab60f50 100644 --- a/Installation-Guide.md +++ b/Installation-Guide.md @@ -41,7 +41,8 @@ The script creates triggers so either give the user SUPER [privileges](https://m ### General -File source:configs/AppConfig.inc +File: [configs/AppConfig.inc](https://github.com/coderkun/questlab/blob/master/configs/AppConfig.inc) +
public static $app = array(
'name' => 'Questlab',
@@ -56,26 +57,19 @@ File source:configs/AppConfig.inc
)
);
-* name
-Displayable name of application
-* genericname
-Generic name used internally (_do not change this!_)
-* namespace
-Namespace of this application (_do not change this!_)
-* timeZone
-Timezone of application
-* mailsender
-Sender used for FROM-header in e‑mail notifications
-* mailcontact
-Displayable e‑mail address for contact
-* registration_host
-limit user registration to this host
-* languages
-supported languages (_do not change this!_)
+* `name`: Displayable name of application
+* `genericname`: Generic name used internally (_do not change this!_)
+* `namespace`: Namespace of this application (_do not change this!_)
+* `timeZone`: Timezone of application
+* `mailsender`: Sender used for FROM-header in e‑mail notifications
+* `mailcontact`: Displayable e‑mail address for contact
+* `registration_host`: Limit user registration to this host
+* `languages`: Supported languages (_do not change this!_)
### Database
-File source:configs/AppConfig.inc
+File: [configs/AppConfig.inc](https://github.com/coderkun/questlab/blob/master/configs/AppConfig.inc)
+
public static $database = array(
'user' => 'questlab',
@@ -84,18 +78,15 @@ File source:configs/AppConfig.inc
'db' => 'questlab'
);
-* user
-name of database user
-* host
-name of database host
-* password
-password for database user
-* db
-name of database to use
+* `user`: Name of database user
+* `host`: Name of database host
+* `password`: Password for database user
+* `db`: Name of database to use
### E‑Mail notifications
-File source:configs/AppConfig.inc
+File: [configs/AppConfig.inc](https://github.com/coderkun/questlab/blob/master/configs/AppConfig.inc)
+
public static $app = array(
[…]
@@ -103,8 +94,8 @@ File source:configs/AppConfig.inc
[…]
);
-* mailsender
-Sender used for FROM-header in e‑mail notifications
+
+* `mailsender`: Sender used for FROM-header in e‑mail notifications
public static $mail = array(
'host' => '',
@@ -115,15 +106,9 @@ Sender used for FROM-header in e‑mail notifications
'charset' => 'UTF-8'
);
-* host
-SMTP host to send mails via
-* port
-SMTP port to use
-* username
-name of SMTP user
-* password
-password for SMTP user
-* secure
-transport security to use (e. g. “ssl”)
-* charset
-charset to use for mails
\ No newline at end of file
+* `host`: SMTP host to send mails via
+* `port`: SMTP port to use
+* `username`: Name of SMTP user
+* `password`: Password for SMTP user
+* `secure`: Transport security to use (e. g. “ssl”)
+* `charset`: Charset to use for mails
\ No newline at end of file