mirror/RSS-Bridge.rss-bridge
1
0
Fork 0
mirror of https://github.com/RSS-Bridge/rss-bridge.git synced 2025-08-04 10:04:54 +02:00
Code Issues Projects Releases Packages Wiki Activity Actions 4

[Documentation] Move all wiki pages into the repo and make it pretty (#2494)

Browse source
This commit is contained in:
Bocki 2022-03-22 21:33:29 +01:00 • committed by GitHub
parent 16470e8119
commit 76f5de3d0f
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
53 changed files with 4215 additions and 0 deletions
Download patch file Download diff file Expand all files Collapse all files

36
docs/02_CLI/index.md Normal file
View file

@ -0,0 +1,36 @@
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_BYBRIDGE' has been enabled. This is a Boolean parameter that can be set to '1' (true) or '0' (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.