diff options
| author | 2021-03-15 00:00:25 +0100 | |
|---|---|---|
| committer | 2021-03-15 00:00:25 +0100 | |
| commit | 1c3159058fd256ec7163a29c9865dbd3dbe05f17 (patch) | |
| tree | 5b3a9df3cc709a4b370f6f03cf79c50483275344 /README.md | |
| parent | 769f34e958b50e748acf6a151805f4a255df2043 (diff) | |
Quick update the doc for master renaming to edge
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 21 |
1 files changed, 16 insertions, 5 deletions
@@ -1,10 +1,11 @@ [![Build Status][travis-badge]][travis-link] [](https://liberapay.com/FreshRSS/donate) -* Read this document on [github.com/FreshRSS/FreshRSS/](https://github.com/FreshRSS/FreshRSS/blob/master/README.md) to get the correct links and pictures. +* Read this document on [github.com/FreshRSS/FreshRSS/](https://github.com/FreshRSS/FreshRSS/blob/edge/README.md) to get the correct links and pictures. * [Version française](README.fr.md) # FreshRSS + FreshRSS is a self-hosted RSS feed aggregator like [Leed](https://github.com/LeedRSS/Leed) or [Kriss Feed](https://tontof.net/kriss/feed/). It is lightweight, easy to work with, powerful, and customizable. @@ -27,17 +28,20 @@ We are a friendly community.  # Disclaimer + FreshRSS comes with absolutely no warranty.  # [Documentation](https://freshrss.github.io/FreshRSS/en/) + * [User documentation](https://freshrss.github.io/FreshRSS/en/users/02_First_steps.html), where you can discover all the possibilities offered by FreshRSS * [Administrator documentation](https://freshrss.github.io/FreshRSS/en/admins/01_Index.html) for detailed installation and maintenance related tasks * [Developer documentation](https://freshrss.github.io/FreshRSS/en/developers/01_First_steps.html) to guide you in the source code of FreshRSS and to help you if you want to contribute * [Contributor guidelines](https://freshrss.github.io/FreshRSS/en/contributing.html) for those who want to help improve FreshRSS # Requirements + * A recent browser like Firefox / IceCat, Internet Explorer 11 / Edge (minus a few details), Chromium / Chrome, Opera, Safari. * Works on mobile (except a few features) * Light server running Linux or Windows @@ -53,18 +57,20 @@ FreshRSS comes with absolutely no warranty. The latest stable release can be found [here](https://github.com/FreshRSS/FreshRSS/releases/latest). New versions are released every two to three months. -If you want a rolling release with the newest features, or want to help testing or developing the next stable version, you can use [the `master` branch](https://github.com/FreshRSS/FreshRSS/tree/master/). +If you want a rolling release with the newest features, or want to help testing or developing the next stable version, you can use [the `edge` branch](https://github.com/FreshRSS/FreshRSS/tree/edge/). # [Installation](https://freshrss.github.io/FreshRSS/en/admins/03_Installation.html) ## Automated install + * [](./Docker/) * [](https://install-app.yunohost.org/?app=freshrss) * [](https://cloudron.io/button.html?app=org.freshrss.cloudronapp) ## Manual install -1. Get FreshRSS with git or [by downloading the archive](https://github.com/FreshRSS/FreshRSS/archive/master.zip) + +1. Get FreshRSS with git or [by downloading the archive](https://github.com/FreshRSS/FreshRSS/archive/latest.zip) 2. Put the application somewhere on your server (expose only the `./p/` folder to the Web) 3. Add write access to the `./data/` folder for the webserver user 4. Access FreshRSS with your browser and follow the installation process @@ -76,6 +82,7 @@ If you want a rolling release with the newest features, or want to help testing More detailed information about installation and server configuration can be found in [our documentation](https://freshrss.github.io/FreshRSS/en/admins/03_Installation.html). ## Advice + * For better security, expose only the `./p/` folder to the Web. * Be aware that the `./data/` folder contains all personal data, so it is a bad idea to expose it. * The `./constants.php` file defines access to the application folder. If you want to customize your installation, look here first. @@ -83,12 +90,14 @@ More detailed information about installation and server configuration can be fou * The special folder `./data/users/_/` contains the part of the logs that are shared by all users. -# F.A.Q.: +# F.A.Q. + * The date and time in the right-hand column is the date declared by the feed, not the time at which the article was received by FreshRSS, and it is not used for sorting. * In particular, when importing a new feed, all of its articles will appear at the top of the feed list regardless of their declared date. # Extensions + FreshRSS supports further customizations by adding extensions on top of its core functionality. See the [repository dedicated to those extensions](https://github.com/FreshRSS/Extensions). @@ -121,6 +130,7 @@ and [Fever API](https://freshrss.github.io/FreshRSS/en/users/06_Fever_API.html) \* Install and enable the [GReader Redate extension](https://github.com/javerous/freshrss-greader-redate) to have the correct publication date for feed articles if you are using Reeder. # Included libraries + * [SimplePie](https://simplepie.org/) * [MINZ](https://github.com/marienfressinaud/MINZ) * [php-http-304](https://alexandre.alapetite.fr/doc-alex/php-http-304/) @@ -130,8 +140,9 @@ and [Fever API](https://freshrss.github.io/FreshRSS/en/users/06_Fever_API.html) * [PHPMailer](https://github.com/PHPMailer/PHPMailer) ## Only for some options or configurations + * [bcrypt.js](https://github.com/dcodeIO/bcrypt.js) * [phpQuery](https://github.com/phpquery/phpquery) -[travis-badge]:https://travis-ci.org/FreshRSS/FreshRSS.svg?branch=master +[travis-badge]:https://travis-ci.org/FreshRSS/FreshRSS.svg?branch=edge [travis-link]:https://travis-ci.org/FreshRSS/FreshRSS |
