mirror of
https://github.com/RSS-Bridge/rss-bridge.git
synced 2024-12-19 17:55:33 +03:00
5b5f3b4254
* docs: Do not use constant names when referring to config options The options are customizable using a config file and no longer hardcoded in index.php since8ac8e08abf* Do not use constants for configuration Since <8ac8e08abf>, they are just set to the configuration object values.
36 lines
No EOL
1.6 KiB
Markdown
36 lines
No EOL
1.6 KiB
Markdown
RSS-Bridge supports calls via CLI. You can use the same parameters as you would normally use via the URI. Example:
|
|
|
|
`php index.php action=display bridge=DansTonChat format=Json`
|
|
|
|
## Required parameters
|
|
|
|
RSS-Bridge requires a few parameters that must be specified on every call. Omitting these parameters will result in error messages:
|
|
|
|
### action
|
|
|
|
Defines how RSS-Bridge responds to the request.
|
|
|
|
Value | Description
|
|
----- | -----------
|
|
`action=list` | Returns a JSON formatted list of bridges. Other parameters are ignored.
|
|
`action=display` | Returns (displays) a feed.
|
|
|
|
### bridge
|
|
|
|
This parameter specifies the name of the bridge RSS-Bridge should return feeds from. The name of the bridge equals the class name of the bridges in the ./bridges/ folder without the 'Bridge' prefix. For example: DansTonChatBridge => DansTonChat.
|
|
|
|
### format
|
|
|
|
This parameter specifies the format in which RSS-Bridge returns the contents. RSS-Bridge currently supports five formats: `Atom`, `Html`, `Json`, `Mrss`and `Plaintext`.
|
|
|
|
## Optional parameters
|
|
|
|
RSS-Bridge supports optional parameters. These parameters are only valid if the options have been enabled in the index.php script.
|
|
|
|
### \_noproxy
|
|
|
|
This parameter is only available if a proxy server has been specified via `proxy.url` and `proxy.by_bridge` has been enabled. This is a Boolean parameter that can be set to `true` or `false`.
|
|
|
|
## Bridge parameters
|
|
|
|
Each bridge can specify its own set of parameters. As in the example above, some bridges don't specify any parameters or only optional parameters that can be neglected. For more details read the `PARAMETERS` definition for your bridge. |