/cfg/chk
| API URL | /cfg/chk |
| Description | Check CMS configuration info RESTFul API |
| Access | Restricted to roles: admin, demo |
| Rquest method | POST |
| Request data type | Request raw data |
| Request data |
{
rc: 'return code', // '0' - success, '1' - error
msg: 'success', // error message
data: {
path: 'path to conf.xml file', // ex. '/home/webroot/sites/kusoftas/cms/data/conf.xml'
mail: 'admin e-mail', // ex. 'info@kusoftas.com'
temp: 'path to temporary files folder', // ex. '/cms/tmp'
files: 'path to files folder', // ex. '/cms/files',
images: 'path to images folder', // ex. '/cms/images'
storage: 'path to digital object storage folder', // ex. '/cms/storage'
users: 'path to users XML file', // ex. '/cms/data/users.xml'
pages: 'path to pages.xml file', // ex. '/cms/data/pages.xml'
data: 'path to CMS data folder', // ex. '/cms/data'
counters: 'path to pages visit counters folder', // ex. '/cms/data/counters'
switch_lang: '1', // 1 - enable switch site language with language URL, 0 - not enable
counter: '1', // 1 - enable pages visit counting, 0 - not enable
lang: 'path to languages xml file', // ex."/cms/data/lang.xml",
plugins: 'path to plugins.xml file', // ex. '/cms/data/plugins.xml'
index: 'path to indexing engine data folder', // ex. '/cms/data/index'
index_auto: '1', // 1 - enable queue to auto index on update, 0 - disable
collection: 'path to collecton data folder', // ex. "/cms/data/collection.xml",
remember: { // remember logged
active: '1', // enable remember option
limit: '0', // disable access control limitation
name: 'kusoftas', // remember cookie name
life: 3600 // remember cookie lifetime (sec)
},
locale: { // site locales
'msg': 'locale message default file name', // ex. 'cms'
'data': 'path to locales folder' // ex. '/cms/srv/locale'
}
list: [ // key pair data XML files
{ // key pair XML file
'id': 'file id', // ex. 'language',
'lang': 'file language id', // ex. 'en',
'data': 'path to file' // ex. '/cms/data/language-en.xml'
}
...
],
class: [ // additional PHP classes
'path to additional class PHP file', // ex. '/cms/api/class/file_name.php'
...
],
site: { // site data
code: 'site code', ex. 'cms_demo'
name: 'site name', // ex. 'KUSoftas CMS'
url: 'site url' // ex. 'www.kusoftas.com'
},
dav:{
path: '\/',
uri: '\/cms\/webdav',
enable: '1',
access: {
acl: {
i: '1',
r: { g: ['admin'], u:[] },
w: { g: ['admin'], u:[] },
e: { g: ['admin'], u:[] },
m: { g: ['admin'], u:[] }
},
acl_inherit:{
root: '0',
r: { g: [], u:[] },
w: { g: [], u:[] },
e: { g: [], u:[] },
m: { g: [], u:[] }
},
inherit: '1',
manage: '1'
}
},
db: { // data base configuration
active: '1', // 1 - DB is using for URL routing, 2 - DB is not using (XML files are using)
auto: '0', // 1 - aut save data to XML files on DB content change, 0 - not auto save
id: 'DB connector ID in use'. // ex. 'sqlite'
type: 'DB connector type', // ex. 'sqlite', 'mysql'
name: 'DB connector name', // ex. 'sqlite'
srv: 'DB server address or file path', // ex. '/cms/data/cms.sqlite'
uid: 'DB user id', // applicable if MySQL
psw: 'DB user password', // applicable if MySQL
sch: 'DB schema', // applicable if MySQL
cnn: { // DB connector list
sqlite: { // connector
name: 'connector name', // ex. 'sqlite'
type: 'connector type', // ex. 'sqlite'
srv: 'connector server address or file path', // ex. '/cms/data/cms.sqlite'
uid: 'connector DB user ID', // applicable if MySQL
psw: 'connector DB user password', // applicable if MySQL
sch: 'connector DB schema', // applicable if MySQL
id: 'connector id' // ex. 'sqlite'
}
...
}
},
cms: { // cms data
preroute: '1', // 1 - load into URL router only prerouted pages
path: 'path to cms software folder', // ex. '/cms/srv'
skin: 'default skin id', // ex. 'default'
access: 'Regular expression in .access file FilesMatch statement'
uid: 'builtin cms administrator ID', // ex. 'admin'
psw: 'builtin cms administrator password', // ex. 'secretpassword'
session_group: 'session-group-id', // ex. 'session'
logged_on_group: 'logged-on-group-id', // ex. 'logon'
logged_off_group: 'logged-off-group-id', // ex. 'logoff'
ip: [ // builtin administrator login filter IP address list
'ip address' // ex. '193.245.55.1'
...
],
route: 'default URL route function', // 'cms_route::def'
route_list: [ // route list
'class::function' // ex. 'cms_route::def'
...
],
method: [ // request methods
'rquest method' // ex. 'GET', 'POST'
...
],
template: 'default template file name', // ex. 'cms-demo-docs.tpl'
css: [ // css include files list
{ // css include file
id: 'file id', // ex. 'superfish'
data: 'file path', // ex. '/cms/srv/lib/superfish-1.7.4/css/superfish.css'
}
...
],
js: [ // js include files list
{
id: 'file id', // ex. 'md5'
data: 'file path' // ex. '/cms/srv/lib/jshash-2.2/md5-min.js'
}
...
],
include: { // includes to be included in every page
css: [ // css includes
['file id', 'filter token', 'language code'],
...
],
js: [ // js includes
['file id', 'filter token', 'language code'],
...
]
}
},
skins: [ // site skin list
{ // site skin
id: 'skin id', // ex. 'default'
name: 'skin name', // ex. 'Default Skin'
dir: 'path to skin folder', // ex. '/cms/skins/default'
template_dir: 'path to skin templates folder', // ex. '/cms/skins/default/templates'
locale_msg: 'locale message file name', // ex. 'cms'
locale: 'locale code', // ex. 'en_EN.utf8'
active: '1' // 1 - active skin, 0 - inactive skin
css: [ // css include files list
{ // css include file
id: 'file id', // ex. 'superfish'
data: 'file path', // ex. '/cms/srv/lib/superfish-1.7.4/css/superfish.css'
}
...
],
js: [ // js include files list
{
id: 'file id', // ex. 'md5'
data: 'file path' // ex. '/cms/srv/lib/jshash-2.2/md5-min.js'
}
...
],
include: { // includes to be included in every page
css: [ // css includes
['file id', 'filter token', 'language code'],
...
],
js: [ // js includes
['file id', 'filter token', 'language code'],
...
]
}
}
...
],
smarty: { // Smarty template system configuration
plugin_dir: [ // smarty plugin folders list
'path to plugin folder' // ex. '/cms/srv/lib/smarty/plugins'
...
],
template_dir: [ // smarty template folders list
'path to template folder' // ex. '/cms/srv/lib/smarty'
...
],
compile_dir: 'path to smarty compile folder', // ex. /cms/templates_c'
cache_dir: 'path to smarty cache folder', // ex. '/cms/templates_cache'
caching: 'smarty caching option', // 0 - off, 1 - caching current, 2 - caching lifetime
cache_lifetime: 'smarty caching lifetime', // '0' - unlimites, '-1' - nocache, 'n' - n seconds
compile_check: '1', // 0 - no template updates check, 1 - check template updates check and recompile
force_compile: '1' // 1 - force recompile template every call, 0 - recompile only on template updates
},
mailsrv:{ // CMS mail server configuration
sender: 'smtp', // value of: ['smtp' - SMTP mail server | 'mail' - PHP's mail | 'sendmail' | 'qmail']
host: 'mail server host address',
port: '587', // mail server port number
smtpauth: '1', // 1 - SMTP authhorization enabled
username: 'autorization user ID',
password: 'authorization user password',
authtype: 'PLAIN', // value of: ['LOGIN' | 'PLAIN' | 'NTLM' | 'CRAM-MD5']
smtpsecure: 'tls', // value of: ['' | 'ssl' | 'tls']
ishtml: '1', // 1 - content is HTML enabled
charset: 'UTF-8',
encoding: '8bit',c// value of: ['8bit' | '7bit' | 'binary' | 'base64' | 'quoted-printable']
from: 'default-from-mail',
fromname: 'default-from-name',
subject: 'default-mail-subject'
}
logger: 'path to logger configuration file' // ex. '/cms/data/log4php.xml'
}
}
|
| Response type | JSON |
| Response data |
{
rc: 'return code', // '0' - success, '1' - error
msg: 'return message' // error message
data: { // errors in configuration; empty if there are no errors
'error-type': 'error message' // ex. 'cms-config-data': 'Configuration data folder (general): Does not exist'
...
}
}
Error types:
|