mirror of
https://github.com/RSS-Bridge/rss-bridge.git
synced 2025-08-05 02:24:35 +02:00
docs
* refactor * docs
This commit is contained in:
Dag
GitHub
parent
6a24e53d6c
commit
9cabf60144
11 changed files with 64 additions and 196 deletions
|
|
@ -1,10 +1 @@
|
|||
In order to install RSS-Bridge on your own web server* do as follows:
|
||||
|
||||
* Make sure your web server meets all [requirements](../01_General/03_Requirements.md)
|
||||
* Download the ZIP file of the [last stable release](https://github.com/RSS-Bridge/rss-bridge/releases)
|
||||
* Place all files on your web server
|
||||
|
||||
For linux hosts:
|
||||
* Grant read-write-access for `www-data` to the `./cache` directory (`chown -R www-data ./cache`)
|
||||
|
||||
You have successfully installed RSS-Bridge.
|
||||
https://github.com/RSS-Bridge/rss-bridge/blob/master/README.md
|
||||
|
|
|
|||
|
|
@ -1,38 +0,0 @@
|
|||
Updating an existing installation is very simple, depending on your type of installation.
|
||||
|
||||
## Release Build
|
||||
|
||||
* Download latest version
|
||||
* Extract all files
|
||||
* Replace existing files
|
||||
|
||||
This will update all core files to the latest version. Your custom configuration and bridges are left untouched. Keep in mind that changes to any core file of RSS-Bridge will be replaced.
|
||||
|
||||
## Heroku
|
||||
|
||||
### If you didn't fork the repo before
|
||||
|
||||
Fork the repo by clicking the `Fork` button at the top right of this page (must be on desktop site). Then on your Heroku account, go to the application. Click on the `Deploy` tab and connect the repo named `yourusername/rss-bridge`. Do a manual deploy of the `master` branch.
|
||||
|
||||
### If you forked the repo before
|
||||
|
||||
[Click here to create a new pull request to your fork](https://github.com/RSS-Bridge/rss-bridge/pull/new/master). Select `compare across forks`, make the base repository `yourusername/rss-bridge` and ensure the branch is set to master. Put any title you want and create the pull request. On the page that comes after this, merge the pull request.
|
||||
|
||||
You then want to go to your application in Heroku, connect your fork via the `Deploy` tab and deploy the `master` branch.
|
||||
|
||||
You can turn on auto-deploy for the master branch if you don't want to go through the process of logging into Heroku and deploying the branch every time changes to the repo are made in the future.
|
||||
|
||||
## Git
|
||||
|
||||
To get the latest changes from the master branch
|
||||
|
||||
```
|
||||
git pull
|
||||
```
|
||||
|
||||
To use a specific tag
|
||||
|
||||
```
|
||||
git fetch --all
|
||||
git checkout tags/<tag-name>
|
||||
```
|
||||
|
|
@ -1,101 +1,6 @@
|
|||
Depending on your servers abilities you can choose between two types of authentication:
|
||||
|
||||
* [.htaccess](#htaccess)
|
||||
* [RSS-Bridge Authentication](#rss-bridge-authentication)
|
||||
|
||||
**General advice**:
|
||||
|
||||
- Make sure to use a strong password, no matter which solution you choose!
|
||||
- Enable HTTPS on your server to ensure your connection is encrypted and secure!
|
||||
|
||||
## .htaccess
|
||||
|
||||
.htaccess files are commonly used to restrict access to files on a web server. One of the features of .htaccess files is the ability to password protect specific (or all) directories. If setup correctly, a password is required to access the files.
|
||||
|
||||
The usage of .htaccess files requires three basic steps:
|
||||
|
||||
1) [Enable .htaccess](#enable-htaccess)
|
||||
2) [Create a .htpasswd file](#create-a-htpasswd-file)
|
||||
3) [Create a .htaccess file](#create-a-htaccess-file)
|
||||
|
||||
### Enable .htaccess
|
||||
|
||||
This process depends on the server you are using. Some providers may require you to change some settings, or place/change some file. Here are some helpful links for your server (please add your own if missing :sparkling_heart:)
|
||||
|
||||
- Apache: http://ask.xmodulo.com/enable-htaccess-apache.html
|
||||
|
||||
### Create a .htpasswd file
|
||||
|
||||
The `.htpasswd` file contains the user name and password used for login to your web server. Please notice that the password is stored in encrypted form, which requires you to encrypt your password before creating the `.htpasswd` file!
|
||||
|
||||
Here are three ways of creating your own `.htpasswd` file:
|
||||
|
||||
**1) Example file**
|
||||
|
||||
Example `.htpasswd` file (user name: "test", password: "test"):
|
||||
|
||||
```.htpasswd
|
||||
test:$apr1$a52u9ILP$XTNG8qMJiEXSm1zD0lQcR0
|
||||
```
|
||||
|
||||
Just copy and paste the contents to your `.htpasswd` file.
|
||||
|
||||
**2) Online generator (read warning!)**
|
||||
|
||||
You can create your own `.htpasswd` file online using a `.htpasswd` generator like this: https://www.htaccesstools.com/htpasswd-generator/
|
||||
|
||||
**WARNING!**
|
||||
- Never insert real passwords to an online generator!
|
||||
|
||||
**3) Generate your own password**
|
||||
|
||||
Another way to create your own `.htpasswd` file is to run this script on your server (it'll output the data for you, you just have to paste it int a `.htpasswd` file):
|
||||
|
||||
```PHP
|
||||
<?php
|
||||
// Password to be encrypted for a .htpasswd file
|
||||
$clearTextPassword = 'some password';
|
||||
|
||||
// Encrypt password
|
||||
$password = crypt($clearTextPassword, base64_encode($clearTextPassword));
|
||||
|
||||
// Print encrypted password
|
||||
echo $password;
|
||||
?>
|
||||
```
|
||||
|
||||
>source: https://www.htaccesstools.com/articles/create-password-for-htpasswd-file-using-php/
|
||||
|
||||
### Create a .htaccess file
|
||||
|
||||
The `.htaccess` file is used to specify which directories are password protected. For that purpose you should place the file in whatever directory you want to restrict access. If you want to restrict access to RSS-Bridge in general, you should place the file in the root directory (where `index.php` is located).
|
||||
|
||||
Two parameters must be specified in the `.htaccess` file:
|
||||
|
||||
* AuthName
|
||||
* AuthUserFile
|
||||
|
||||
`AuthName` specifies the name of the authentication (i.e. "RSS-Bridge"). `AuthUserFile` defines the **absolute** path to a `.htpasswd` file.
|
||||
|
||||
Here are two ways of creating your own `.htaccess` file:
|
||||
|
||||
**1) Example file**
|
||||
|
||||
```.htaccess
|
||||
AuthType Basic
|
||||
AuthName "My Protected Area"
|
||||
AuthUserFile /path/to/.htpasswd
|
||||
Require valid-user
|
||||
```
|
||||
|
||||
Notice: You must change the `AuthUserFile` location to fit your own server (i.e. `/var/www/html/rss-bridge/.htpasswd`)
|
||||
|
||||
**2) Online generator**
|
||||
|
||||
You can use an online generator to create the file for you and copy-paste it to your `.htaccess` file: https://www.htaccesstools.com/htaccess-authentication/
|
||||
|
||||
## RSS-Bridge Authentication
|
||||
|
||||
RSS-Bridge ships with an authentication module designed for single user environments. You can enable authentication and specify the username & password in the [configuration file](../03_For_Hosts/08_Custom_Configuration.md#authentication).
|
||||
|
||||
Please notice that the password is stored in plain text and thus is readable to anyone who can access the file. Make sure to restrict access to the file, so that it cannot be read remotely!
|
||||
* http basic auth
|
||||
* token
|
||||
* Access control via webserver (see nginx/caddy/apache docs)
|
||||
|
||||
https://github.com/RSS-Bridge/rss-bridge/blob/master/README.md
|
||||
|
|
|
|||
|
|
@ -1,9 +1,14 @@
|
|||
RSS-Bridge ships a few options the host may or may not activate. All options are listed in the [config.default.ini.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/config.default.ini.php) file, see [Custom Configuration](08_Custom_Configuration.md) section for more information.
|
||||
RSS-Bridge ships a few options the host may or may not activate.
|
||||
All options are listed in the [config.default.ini.php](https://github.com/RSS-Bridge/rss-bridge/blob/master/config.default.ini.php) file,
|
||||
see [Custom Configuration](08_Custom_Configuration.md) section for more information.
|
||||
|
||||
## Customizable cache timeout
|
||||
|
||||
Sometimes it is necessary to specify custom timeouts to update contents more frequently than the bridge maintainer intended. In these cases the client may specify a custom cache timeout to prevent loading contents from cache earlier (or later).
|
||||
Sometimes it is necessary to specify custom timeouts to update contents more frequently
|
||||
than the bridge maintainer intended.
|
||||
In these cases the client may specify a custom cache timeout to prevent loading contents
|
||||
from cache earlier (or later).
|
||||
|
||||
This option can be activated by setting the [`cache.custom_timeout`](08_Custom_Configuration.md#custom_timeout) option to `true`. When enabled each bridge receives an additional parameter `Cache timeout in seconds` that can be set to any value between 1 and 86400 (24 hours). If the value is not within the limits the default settings apply (as specified by the bridge maintainer).
|
||||
|
||||
The cache timeout is send to RSS-Bridge using the `_cache_timeout` parameter. RSS-Bridge will return an error message if the parameter is received and the option is disabled.
|
||||
This option can be activated by setting the [`cache.custom_timeout`](08_Custom_Configuration.md#custom_timeout) option to `true`.
|
||||
When enabled each bridge receives an additional parameter `Cache timeout in seconds`
|
||||
that can be set to any value.
|
||||
|
|
|
|||
|
|
@ -1,16 +1,21 @@
|
|||
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!
|
||||
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:
|
||||
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.
|
||||
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`.
|
||||
__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
|
||||
|
||||
|
|
|
|||
|
|
@ -1,8 +1,5 @@
|
|||
This section is directed at **hosts** and **server administrators**.
|
||||
|
||||
To install RSS-Bridge, please follow the [installation instructions](../03_For_Hosts/01_Installation.md).
|
||||
You must have access to a web server with a working PHP environment!
|
||||
|
||||
RSS-Bridge comes with a large amount of bridges.
|
||||
|
||||
Some bridges could be implemented more efficiently by actually using proprietary APIs,
|
||||
|
|
@ -11,4 +8,5 @@ but there are reasons against it:
|
|||
- RSS-Bridge exists in the first place to NOT use APIs.
|
||||
- See [the rant](https://github.com/RSS-Bridge/rss-bridge/blob/master/README.md#Rant)
|
||||
|
||||
- APIs require private keys that could be stored on servers running RSS-Bridge,which is a security concern, involves complex authorizations for inexperienced users and could cause harm (when using paid services for example). In a closed environment (a server only you use for yourself) however you might be interested in using them anyway. So, check [this](https://github.com/RSS-Bridge/rss-bridge/pull/478/files) possible implementation of an anti-captcha solution.
|
||||
- APIs require private keys that could be stored on servers running RSS-Bridge,
|
||||
- which is a security concern, involves complex authorizations for inexperienced users and could cause harm (when using paid services for example). In a closed environment (a server only you use for yourself) however you might be interested in using them anyway. So, check [this](https://github.com/RSS-Bridge/rss-bridge/pull/478/files) possible implementation of an anti-captcha solution.
|
||||
|
|
|
|||
Loading…
Add table
Add a link
Reference in a new issue