- improved config.ini comments and fixed some misleading explanations for 'CACHE' and 'SESSION_CACHE' value

This commit is contained in:
Mark Friedrich
2018-12-01 13:13:51 +01:00
parent 1a1fabf361
commit dca86146a1
2 changed files with 101 additions and 52 deletions

View File

@@ -1,74 +1,123 @@
; Global Framework Config
[SERVER]
SERVER_NAME = PATHFINDER
SERVER_NAME = PATHFINDER
[globals]
; Default Verbosity level of the stack trace.
; Assign values between 0 to 3 for increasing verbosity levels. Check (environment.ini) config for overwriting
; (default: 0)
DEBUG = 0
; Verbosity level of error stack trace for errors
; This affects error logging and stack traces returned to clients on error.
; DEBUG level can be overwritten in environment.ini
; Syntax: 0 | 1 | 2 | 3
; Default: 0
DEBUG = 0
; If TRUE, the framework, after having logged stack trace and errors, stops execution
; -> (die without any status) when a non-fatal error is detected. (default: FALSE)
HALT = FALSE
; How to behave on 'non-fatal' errors
; If TRUE, the framework, after having logged stack trace and errors, stops execution
; (die without any status) when a non-fatal error is detected.
; Tip: You should not change this.
; Syntax: TRUE | FALSE
; Default: FALSE
HALT = FALSE
; Timezone to use. Sync program with eve server time. (default: UTC)
TZ = UTC
; Timezone to use
; Sync Pathfinder with EVE server time.
; Tip: You should not change this.
; Default: UTC
TZ = UTC
; Cache key prefix. Same for all cache values for this installation
; CLI (cronjob) scripts use it for cache manipulation
SEED = {{ md5(@SERVER.SERVER_NAME) }}
; Default language
; Overwrites HTTP Accept-Language request header.
; Used by setlocale() and affects number formatting.
; Syntax: String
; Default: en-US
LANGUAGE = en-US
; Cache backend. Can handle Redis, Memcache module, APC, WinCache, XCache and a filesystem-based cache.
; (default: folder=tmp/cache/)
CACHE = folder=tmp/cache/
;CACHE = redis=localhost:6379
; Cache key prefix
; Same for all cache values for this installation.
; CLI (cronjob) scripts use it for cache manipulation.
; Tip: You should not change this.
; Syntax String
; Default: {{ md5(@SERVER.SERVER_NAME) }}
SEED = {{ md5(@SERVER.SERVER_NAME) }}
; Cache backend used by Session handler.
; default
; -If CACHE is enabled (see above), the same location is used for Session data (e.g. fileCache, RedisDB)
; mysql
; - Session data get stored in your 'PathfinderDB' table 'sessions' (faster)
SESSION_CACHE = mysql
; Cache backend
; Can handle Redis, Memcache module, APC, WinCache, XCache and a filesystem-based cache.
; Tip: Redis is recommended and gives the best performance.
; Syntax: folder=[DIR] | redis=[SERVER]
; Default: folder=tmp/cache/
; Value: folder=[DIR]
; - Cache data is stored on disc
; redis=[SERVER]
; - Cache data is stored in Redis (e.g. redis=localhost:6379)
CACHE = folder=tmp/cache/
; Cache backend used by PHPs Session handler.
; Tip1: Best performance and recommended configuration for Pathfinder is to configured Redis as PHPs default Session handler
; in your php.ini and set 'default' value here in order to use Redis (fastest)
; Tip2: If Redis is not available for you, leave this at 'mysql' (faster than PHPs default files bases Sessions)
; Syntax: mysql | default
; Default: mysql
; Value: mysql
; - Session data get stored in 'pathfinder'.'sessions' table (environment.ini → DB_PF_NAME).
; Table `sessions` is auto created if not exist.
; default
; - Session data get stored in PHPs default Session handler (php.ini → session.save_handler and session.save_path)
; PHPs default session.save_handler is `files` and each Session is written to disc (slowest)
SESSION_CACHE = mysql
; Callback functions ==============================================================================
ONERROR = Controller\Controller->showError
UNLOAD = Controller\Controller->unload
ONERROR = Controller\Controller->showError
UNLOAD = Controller\Controller->unload
; Path configurations =============================================================================
; relative to "BASE" dir
; All path configurations are relative to BASE dir and should NOT be changed
; Temporary folder for cache, filesystem locks, compiled F3 templates, etc. (default: tmp/)
TEMP = tmp/
; Temporary folder for cache
; Used for compiled templates.
; Syntax: [DIR]
; Default: tmp/
TEMP = tmp/
; Log file folder. (default: logs/)
LOGS = logs/
; Log file folder
; Syntax: [DIR]
; Default: logs/
LOGS = logs/
; UI/template folder. (default: public/)
UI = public/
; UI folder
; Where all the public assets (templates, images, styles, scripts) are located.
; Syntax: [DIR]
; Default: public/
UI = public/
; Autoloader for user-defined PHP classes that the framework will attempt to autoload at runtime. (default: app/main/)
AUTOLOAD = app/main/
; Autoload folder
; Where PHP attempts to autoload PHP classes at runtime.
; Syntax: [DIR]
; Default: app/main/
AUTOLOAD = app/main/
; Favicons. (default: favicon/)
FAVICON = favicon/
; Favicon folder
; Syntax: [DIR]
; Default: favicon/
FAVICON = favicon/
; Export folder (e.g. static table data). (default: export/)
EXPORT = export/
; Export folder
; Where DB dump files are located/created at.
; Syntax: [DIR]
; Default: export/
EXPORT = export/
; Default language (overwrites HTTP Accept-Language request header) used for "setlocale()" affects number formatting. (default: en-US)
LANGUAGE = en-US
; Custom *.ini file folder
; Can be used to overwrite default *.ini files and settings
; See: https://github.com/exodus4d/pathfinder/wiki/Configuration#custom-confpathfinderini
; Syntax: [DIR]
CONF.CUSTOM = conf/
CONF.DEFAULT = app/
; custom *.ini file folder, can be used to overwrite default *.ini files
CONF.CUSTOM = conf/
CONF.DEFAULT = app/
; load additional config files
; DO NOT load environment.ini, it is loaded automatically
; Load additional config files
; DO NOT load environment.ini, it is loaded automatically
[configs]
{{@CONF.DEFAULT}}routes.ini = true
{{@CONF.DEFAULT}}pathfinder.ini = true
{{@CONF.CUSTOM}}pathfinder.ini = true
{{@CONF.DEFAULT}}requirements.ini = true
{{@CONF.DEFAULT}}cron.ini = true
{{@CONF.DEFAULT}}routes.ini = true
{{@CONF.DEFAULT}}pathfinder.ini = true
{{@CONF.CUSTOM}}pathfinder.ini = true
{{@CONF.DEFAULT}}requirements.ini = true
{{@CONF.DEFAULT}}cron.ini = true

View File

@@ -84,5 +84,5 @@ NPM = 3.10.0
[REQUIREMENTS.DATA]
STRUCTURES = 33
SHIPS = 490
SHIPS = 491
NEIGHBOURS = 5201