blob: 6e22f7ee6076d3ae73e61c47ff1653166a2ee223 (
plain) (
blame)
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
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
|
RSS-Bridge supports custom configurations for common parameters on the server side!
A default configuration file (`config.default.ini.php`) is shipped with RSS-Bridge.
Please do not edit this file, as it gets replaced when upgrading RSS-Bridge!
You should, however, use this file as template to create your own configuration
(or leave it as is, to keep the default settings).
In order to create your own configuration perform following actions:
* Create the file `config.ini.php` in the RSS-Bridge root folder (next to `config.default.ini.php`)
* Copy the contents from `config.default.ini.php` to your configuration file
* Change the parameters to satisfy your requirements
RSS-Bridge will automatically detect the `config.ini.php` and use it.
If the file doesn't exist it will default to `config.default.ini.php` automatically.
__Notice__: If a parameter is not specified in your `config.ini.php` RSS-Bridge will
automatically use the default settings from `config.default.ini.php`.
# Available parameters
The configuration file is split into sections:
* [system](#system)
* [http client](#http-client)
* [cache](#cache)
* [proxy](#proxy)
* [authentication](#authentication)
* [admin](#admin)
* [error](#error)
_System_: This section specifies system specific parameters
_Http client_: This section has http client options
_Cache_: This section is all about the caching behavior of RSS-Bridge
_Proxy_: This section can be used to specify a proxy server for RSS-Bridge to utilize for fetching contents
_Authentication_: This section defines parameters to require authentication to use RSS-Bridge
_Admin_: This section specifies parameters related to the administrator of your instance of RSS-Bridge
## System
This section provides following parameters:
- [timezone](#timezone)
### Timezone
Defines the timezone used by RSS-Bridge. This parameter can be set to any value of the values defined at https://www.php.net/manual/en/timezones.php
The default value is `UTC`.
## Cache
This section provides following parameters:
- [type](#type)
- [custom_timeout](#custom_timeout)
### type
Defines the cache type used by RSS-Bridge.
| Type | Description
| ------- | -----------
|`file` | File based (default)
|`sqlite` | SQLite database
|`memcached` | Memcached service
### custom_timeout
Allow users to specify custom timeout for specific requests.
`true` = enabled
`false` = disabled (default)
## Proxy
This section provides following parameters:
- [url](#url)
- [name](#name)
- [by_bridge](#by_bridge)
### url
Sets the proxy url (i.e. "tcp://192.168.0.0:32")
`""` = Proxy disabled (default)
### name
Sets the proxy name that is shown on the bridge instead of the proxy url.
`""` = Show proxy url (default: "Hidden proxy name")
### by_bridge
Allow users to disable proxy usage for specific requests.
`true` = enabled
`false` = disabled (default)
## Http client
This section provides the following parameters:
- timeout
- useragent
### timeout
Default network timeout.
### useragent
Default user agent.
## Authentication
This section provides following parameters:
- [enable](#enable)
- [username](#username)
- [password](#password)
### enable
Enables authentication for RSS-Bridge.
_Notice_: Login is required for all requests when enabled! Make sure to update feed subscriptions accordingly.
`true` = enabled
`false` = disabled (default)
### username
Defines the user name used for login.
### password
Defines the password used for login. Use a strong password to prevent others from guessing your login!
## Admin
This section provides following parameters:
- [email](#email)
### email
Advertises an email address where people can reach the administrator.
*Notice*: This address is displayed on the main page, visible to everyone!
`""` = Disabled (default)
Example: `email = "admin@instance.rss-bridge.com"`
## error
This section provides following parameters:
- [output](#output)
- [report_limit](#report_limit)
### output
Defines how error messages are returned by RSS-Bridge
`feed`: As part of the feed (default)
`http`: As HTTP error message
`none`: No errors are reported
### report_limit
Defines how often an error must occur before it is reported to the user
`report_limit`: 1 (default)
|
