blob: 62e5e0ef113ae0fc476e6534e961bb75b2dc225c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
|
This document describes the available configuration settings from the `configuration.php` file in more detail.
## Language configuration
This is the core language which will be used. A corresponding language file **must exists** within `core/language/`. Currently are only `en` and `de` supported. If you are a translator, please only use the original `en` language file for your translation and open a pull request on GitHub or send your language file via email to `code@nerdmind.de`!
* `CORE.LANGUAGE`: [string: `'en'`]
## ETag configuration
If this parameter is set to `TRUE`, the system will generate an `ETag` header which includes a hash of the configuration and the timestamps of the last published items and sends them to the client. The client will cache this header and sends them with each further request in the request header to the application. If the hash which the appplication now again creates is not the same as the one from the request header (which means that no new items was published), the application exit and returns the `304 Not Modified` response header.
* `CORE.SEND_304`: [boolean: `TRUE`|`FALSE`]
## Blog informations
Meta informations about your custom blog installation. Note that `BLOGMETA.LANG` is not the system language! It is the language in which **your content** is written and is useful for the `lang` attribute on the `<html>` tag within the template. It depends on the template whether this variable is used or not.
* `BLOGMETA.NAME`: [string: `'My Techblog'`]
* `BLOGMETA.DESC`: [string: `'[a creative description]'`]
* `BLOGMETA.HOME`: [string: `'Welcome'`]
* `BLOGMETA.MAIL`: [string: `'webmaster@example.org'`]
* `BLOGMETA.LANG`: [string: `'en'`]
## Database
Database and hostname with login credentials to authenticate to the MySQL server.
* `DATABASE.HOSTNAME`: [string: `'localhost'`]
* `DATABASE.BASENAME`: [string: `'niceblog'`]
* `DATABASE.USERNAME`: [string: `'john_doe'`]
* `DATABASE.PASSWORD`: [string: `'#passwd#'`]
## Backend
Settings for administration area. A corresponding language file **must exists** within the template directory of the template defined by `ADMIN.TEMPLATE`!
* `ADMIN.TEMPLATE`: [string: `'admin'`]
* `ADMIN.LANGUAGE`: [string: `'en'`]
## Template
Template directory and language (from `template/{template_name}/lang/`) to use.
* `TEMPLATE.NAME`: [string: `'standard'`]
* `TEMPLATE.LANG`: [string: `'en'`]
## Paths
Protocol, hostname and base directory for your installation.
* `PATHINFO.PROT`: [string: `'https'`]
* `PATHINFO.HOST`: [string: `'example.org'`]
* `PATHINFO.BASE`: [string: `'sub/directory/'`]
## List size
Number of items to display per-site on overview sites.
* `PAGE.LIST_SIZE`: [integer: `10`]
* `POST.LIST_SIZE`: [integer: `10`]
* `USER.LIST_SIZE`: [integer: `10`]
## Feed size
Number of items to display within the RSS feed.
* `PAGE.FEED_SIZE`: [integer: `25`]
* `POST.FEED_SIZE`: [integer: `25`]
## Slug URLs
Enable or disable the use of slug URLs for item permalinks. If disabled, the unique primary item ID is used instead.
* `PAGE.SLUG_URLS`: [boolean: `TRUE`|`FALSE`]
* `POST.SLUG_URLS`: [boolean: `TRUE`|`FALSE`]
* `USER.SLUG_URLS`: [boolean: `TRUE`|`FALSE`]
## Directories
Item base directories relative to your base directory where the application is installed.
* `PAGE.DIRECTORY`: [string: `'page/'`]
* `POST.DIRECTORY`: [string: `'post/'`]
* `USER.DIRECTORY`: [string: `'user/'`]
## Emoticons
Enable or disable parsing of emoticons for the body of the item.
* `PAGE.EMOTICONS`: [boolean: `TRUE`|`FALSE`]
* `POST.EMOTICONS`: [boolean: `TRUE`|`FALSE`]
* `USER.EMOTICONS`: [boolean: `TRUE`|`FALSE`]
## `<meta>` description
Number of characters from the items content to display within the `<meta>` description.
* `PAGE.DESCRIPTION_SIZE`: [integer: `200`]
* `POST.DESCRIPTION_SIZE`: [integer: `200`]
* `USER.DESCRIPTION_SIZE`: [integer: `200`]
## List sorting
The `ORDER BY` clause for item sorting on item overview sites. You can use each column from the database table to sort and you also can combine multiple columns together. See the MySQL documentation for `ORDER BY` for more information.
* `PAGE.LIST_SORT`: [string: `'time_insert DESC'`]
* `POST.LIST_SORT`: [string: `'time_insert DESC'`]
* `USER.LIST_SORT`: [string: `'time_insert DESC'`]
## Feed sorting
The `ORDER BY` clause for item sorting within the RSS feed. You can use each column from the database table to sort and you also can combine multiple columns together. See the MySQL documentation for `ORDER BY` for more information.
**Note:** It depends on the RSS reader how the content is sorted. The settings here are only for the sorting of the content in the XML source code, but it is nevertheless a good idea to sort them as they should appear in the RSS reader.
* `PAGE.FEED_SORT`: [string: `'time_insert DESC'`]
* `POST.FEED_SORT`: [string: `'time_insert DESC'`]
## Feed `<guid>` hash
Item attributes (database columns) to use to generate the `<guid>` value for the RSS feed items.
* `PAGE.FEED_GUID`: [array: `['id', 'time_insert']`]
* `POST.FEED_GUID`: [array: `['id', 'time_insert']`]
|
