added sitemap and docs
This commit is contained in:
52
docs/ConfigurationFile.md
Normal file
52
docs/ConfigurationFile.md
Normal file
@@ -0,0 +1,52 @@
|
||||
# Configuration File
|
||||
|
||||
## App/config.php
|
||||
|
||||
The configuration file holds a php multi dimentional array for configuration.
|
||||
|
||||
#### database
|
||||
|
||||
This is the connection setting for mariadb.
|
||||
|
||||
```
|
||||
'database' => [
|
||||
'host' => 'ny-db',
|
||||
'name' => 'nydb',
|
||||
'user' => 'nydbu',
|
||||
'pass' => 'as7!d5fLKJ2DLKJS5',
|
||||
'port' => 3306
|
||||
],
|
||||
```
|
||||
|
||||
#### base_url
|
||||
|
||||
Defines the url to use
|
||||
```
|
||||
'base_url' => 'https://www.nickyeoman.com',
|
||||
```
|
||||
|
||||
#### secure_key
|
||||
|
||||
The security key is used to verify admin account and salt encrpytion functions.
|
||||
You can generate a key with ```pwgen -cnsB1v 64```
|
||||
but if you don't set one, novaconium will generate one for you to use (you have to explicily set it though).
|
||||
|
||||
```
|
||||
'secure_key' => '',
|
||||
```
|
||||
|
||||
#### logfile
|
||||
|
||||
sets the path of the log file.
|
||||
|
||||
```
|
||||
'logfile' => '/logs/novaconium.log',
|
||||
```
|
||||
|
||||
#### loglevel
|
||||
|
||||
Sets the logging level for the app.
|
||||
|
||||
```
|
||||
'loglevel' => 'ERROR' // 'DEBUG', 'INFO', 'WARNING', 'ERROR', 'NONE'
|
||||
```
|
||||
@@ -3,7 +3,7 @@
|
||||
You can use the logging class to output to a file.
|
||||
|
||||
|
||||
use ```$log->info(The Message');```1
|
||||
use ```$log->info(The Message');```
|
||||
|
||||
Logging levels are:
|
||||
```
|
||||
@@ -16,4 +16,4 @@ Logging levels are:
|
||||
|
||||
It's recommended that production is set to ERROR.
|
||||
You set the log level in /App/config.php under 'loglevel' => 'ERROR'
|
||||
If you are using CORXN a health check is run every 30 seconds which would fill the log file with info.
|
||||
|
||||
|
||||
Reference in New Issue
Block a user