Commit Graph

49 Commits

Author SHA1 Message Date
Alwaysin
fdf40c95b9 Update link to News+ Google Reader extension (#3252)
* Remove News+ (Google Reader extension does not exist anymore)

* Remove News+ (Google Reader extension does not exist anymore)

* Update link to News+ Google Reader extension

* Update link to News+ Google Reader extension

* A few more links

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-11-12 11:52:52 +01:00
tonitonae
fdfe6e7038 Update FAQ with firewall issues. (#3225)
* Update FAQ with firewall issues.

* Update docs/en/users/07_Frequently_Asked_Questions.md

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>

Co-authored-by: tonitonae <tonitonae@zetmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-10-15 10:27:43 +02:00
No Name Pro
162f31f82e Docs: Add Fluent Reader to API Clients (#3140)
* Docs: Add Fluent Reader to API Clients

Fluent Reader is a desktop RSS reader built with Electron, React, and Fluent UI supporting Fever API.

See more: https://github.com/yang991178/fluent-reader

* RSS client list: Add section for cross plattform

Adds in the RSS Client List a Section for Cross-Plattform Desktop Clients (Windows, Linux and MacOS)

* Docs: API Clients: Table instead of List

* Docs: API Clients: Change `Free Software` to `License`

* Add me (No Name Pro) to Credits-File :)

* Docs (FR): API Client List as table + Fluent Reader
2020-08-18 15:01:14 +02:00
saimyx
a76caf78e7 documentation utilisateur / user doc (#2948)
* Update 04_Subscriptions.md

- ajouter un flux
- import/export

* Update 04_Subscriptions.md

* Update 04_Subscriptions.md

* Update 04_Subscriptions.md

Translated in english from https://github.com/Saimyx/FreshRSS/edit/master/docs/fr/users/04_Subscriptions.md

* Update 04_Subscriptions.md

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/fr/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update 04_Subscriptions.md

* Update docs/en/users/04_Subscriptions.md

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Update docs/en/users/04_Subscriptions.md

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* Language improvements

* Language improvements

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-05-08 16:04:22 +02:00
Alexandre Alapetite
ae70374b03 Filter by multiple feed IDs (#2892)
Add the possibility to filter by feed ID like `f:123 more-search`
or multiple feed IDs, like `f:123,234,345 more-search` or an exclusion
like `!f:456,789 more-search`
2020-04-17 10:57:35 +02:00
Alexandre Alapetite
61c8026ac9 Implement negation for searching by date intervals (#2869)
* Implement negation for searching by date intervals

#fix https://github.com/FreshRSS/FreshRSS/issues/2866
Allow searching for e.g. `!date:P1W` to exlude all articles newer than
one week.
More generally, allows exclusion on some date intervals.

* Fix OR
2020-04-01 17:26:19 +02:00
Alexandre Alapetite
4fa6e27397 Fix broken doc link (#2832)
#Fix https://github.com/FreshRSS/FreshRSS/issues/2824
2020-03-21 21:56:36 +01:00
Frans de Jonge
705318aa39 Translate docs with po4a (#2590)
* [i18n] Add docs po4a script

* Add proof of concept

* Add a few more translations

* Hush ShellCheck and shfmt

* Make that list po4a-friendly

* drat, this document could've probably been auto-generated

* Definitive proof that it's translated from French ;-)

* Add some brand spanking new French translation

* More translation

* Mostly finish that config page

* Fix up FAQ

* More contributing

* Dev first steps

* Let's ignore that admin stuff at the very least for now

* Translate release new version, make French the source first and copy all translations

Then replace French with English in the source.

Much quicker than any alternative route.

* And add the English translation

* Minor stylistic leftover from French

* Most of first steps

* Forgot the extensions

* Use po4a 0.56 to get rid of way too many newlines

* Fix up those newlines

* No point linking to Firefox integration anymore from the new user guide

* Start on main view

* A bunch of main view stuff

* More main view

* And some subscriptions before going to bed

* First steps for devs

* More dev first steps

* Incomplete French → English dev/GH translation

Because I need to ask about that mailing list thing

* Fix typo in docs/en/developers/02_Github.md

* Translate & complete devs/github to English

* Fix up most of extensions

* Is that supposed to be a non-breaking space? Let's see

* Match up some users/mobile access

* More users/mobile access

* Add fresh French translation to Fever API

* Fix typo

* Match frontend todo thingies

* Fix a typo

* Some extensions strings

* Remove Fx subscription service from the docs

Cf. https://github.com/FreshRSS/FreshRSS/pull/2606

* Add translation for https://github.com/FreshRSS/FreshRSS/pull/2643

* fix typo as per https://github.com/FreshRSS/FreshRSS/pull/2643#discussion_r345433009

* Add some more French translations

* Update French translation as per @aledeg comment https://github.com/FreshRSS/FreshRSS/pull/2590#discussion_r345465909

* Translate some of the meaningless stuff

* Translate the rest of contributing.md to French

* Fix conflicts

* Translate Docker first steps to French

* Update with change from #2665

* Add @aledeg corrections

* Overlooked a couple @aledeg corrections thanks to GitHub autohide

* Latest @aledeg suggestions
2019-12-03 22:37:40 +01:00
Ryan Nielson
b2c77d1cb4 Fix link to installation instructions on first steps (#2665) 2019-11-14 15:22:48 +01:00
rezad
8bdf7b09f2 Replace some http links with https links (#2662) 2019-11-13 20:52:52 +01:00
Alexis Degrugillier
59f284d229 Rename sharing action (#2643)
Before, some ad-blocker rules were preventing to display the sharing page
because of its name. I've renamed that page to integration but kept every
thing else identical. So it's still called sharing through out the
application.
If needed, this can be addressed as well.

See #2509 and #2419
2019-11-08 23:49:43 +01:00
Stoinov
6d330206af Reeder added native support (#2578)
* Reeder aded native support
Added Reeder as supported in Reader page
Clarified how to use the Fever API with Reeder
Fixed some typos on both pages
2019-10-19 12:03:06 +02:00
Alexandre Alapetite
37b52b7361 Trim whitespace (#2544) 2019-10-01 18:12:21 +02:00
Alexandre Alapetite
823f581523 Document Reeder compatibility (#2540)
https://github.com/FreshRSS/FreshRSS/issues/2513
https://github.com/FreshRSS/FreshRSS/pull/2526
2019-09-28 23:16:21 +02:00
Alexandre Alapetite
fd33d92d41 Require PHP 5.5+ (#2495)
* Require PHP 5.5+

https://github.com/FreshRSS/FreshRSS/issues/2469#issuecomment-522255093
I think it would be reasonable to require PHP 5.5+ for the core of
FreshRSS after all.

As Frenzie said, WordPress currently requires PHP 5.6.20+, and it is the
most popular PHP application.

We would loose about 20% of the PHP servers according to
https://w3techs.com/technologies/details/pl-php/5/all but I expect this
number to drop fast after the release of CentOS 8 (CentOS accounts for
17% of Linux servers
https://w3techs.com/technologies/details/os-linux/all/all ).

Distributions:
* no impact on Ubuntu, Fedora, Alpine, OpenWRT, FreeBSD, OpenSuze,
Mageia, as all active versions have PHP > 7
* no impact on OpenSuze, Synology, as all active versions have PHP > 5.5
* we drop Debian 8 Jessie (-2020) - we keep supporting Debian 9 Stretch
(2017-06) - current is Debian 10 Buster
* we drop Red Hat 7 (-2024) - we keep supporting RHEL 8 (2019-05)
* we drop CentOS 7 (-2024) - we will support CentOS 8 (to be released
soonish)

When dropping older versions, I can better like when it is for a good
reason, and there is actually one with PHP 5.5, namely generators
(yield) https://php.net/language.generators.overview which I consider
using.

* Version note for JSON.php

* hex2bin

* Update .travis.yml

Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com>
2019-08-20 14:55:43 +02:00
Purexo
e09cf3fc71 Promote FreshRSS-Notify in user documentation (#2445)
* Add FreshRSS-Notify in Clients compatibles section

* Add FreshRSS-Notify in Compatible clients section

* Use language-neutral link

https://addons.mozilla.org/firefox/addon/freshrss-notify-webextension/
2019-07-15 15:44:50 +02:00
Alexandre Alapetite
b2d5ef4842 Merge pull request #2389 from Fake4d/patch-1
Update 03_Main_view.md
2019-05-30 12:34:10 +02:00
Alexandre Alapetite
5ccbd662c5 Fix typos 2019-05-30 12:33:27 +02:00
Alexandre Alapetite
05420ef40e Remove /de/ in URL 2019-05-30 12:30:35 +02:00
Fake4d
8df7caa0cf Update 06_Fever_API.md
Reeder-4 is new - Reeder-3 is the old version

BUT: 3 is free ;-)
And you have to pay for the new version.. So I dont know whether this should be linked here..
2019-04-29 11:03:01 +02:00
Fake4d
0cd992df37 Update 03_Main_view.md
Typo in Param maxFeeds
2019-04-29 10:40:54 +02:00
Fake4d
097d771869 Update 03_Main_view.md
Document all the parameters for "feed actualize".

the new parameter "maxfeeds" from Pull Request #2388 is already considered.
2019-04-29 10:35:28 +02:00
Alexandre Alapetite
b5e83abfc9 Add reference to Readably app
https://github.com/FreshRSS/FreshRSS/issues/1406#issuecomment-469310998
2019-03-09 12:50:03 +01:00
Alexandre Alapetite
a6623b7b2f Apache performance (#2202)
* Apache performance
API: Use SetEnvIf if available and fallback to RewriteRule
Docker: Disable unused modules.
Docker: Hard-include .htaccess to avoid having to scan for changes in
that file.
Docker: Disable security check of symlinks, which we do not use ayway.

* Apache readme

* Docker/Apache tuning
Run cron job with correct www-data user instead of root
Remove PHP GMP module uneeded for 64-bit Docker image
Add option to mount custom .htaccess for HTTP authentication
Re-add Apache module for HTTP authentication
Move Alpine-specific instructions to Docker file (instead of Apache
conf) to make it easier to have other base images than Alpine
2019-01-02 21:36:33 +01:00
Alexandre Alapetite
512d047f02 Update naming to WebSub (#2184)
Instead of PubSubHubbub / PuSH
2018-12-16 17:02:03 +01:00
Alwaysin
49869882e6 Documentation update (#2095)
* Add Phoronix CSS retrieve rule

* Update 05_Configuration.md

Mise à jour paragraphe des langues
Ajout règle CSS Phoronix

* Ajout outils externes pour récupérer contenu complet article

* Adding external tools to retrieve full-content

* Messed up for Phoronix, added back

* Update 05_Configuration.md

* Update 05_Configuration.md
2018-12-16 14:45:26 +01:00
Alexandre Alapetite
75a0b12c72 Documentation Vienna (#2126)
* Documentation Vienna / Open Reader

https://github.com/FreshRSS/FreshRSS/issues/2091
https://github.com/FreshRSS/FreshRSS/pull/2093
https://github.com/ViennaRSS/vienna-rss/issues/1197

* Remove references to Open Reader API for now
2018-12-16 14:43:32 +01:00
Frans de Jonge
e2cb8b929b [docs] Add note about specific user for webcron (#2142)
* [docs] Add note about specific user for webcron

Cf. https://github.com/FreshRSS/FreshRSS/issues/613#issuecomment-353585547

* Small changes

* Use one of the RFC addresses for examples
2018-11-18 21:08:41 +01:00
ryliejamesthomas
4dcddff532 Note stating manually adding custom subscription services removed in FF 63 (#2112)
* Note stating manually adding custom subscription services removed in FF 63

* Amended to mention bookmarklet and upcoming issues
2018-11-11 17:32:32 +01:00
Frans de Jonge
55992d4548 [docs] Bookmarklet (#2116) 2018-11-05 18:14:35 +01:00
Roland Arendes
de0e935105 Small docs update (see #1999) and i18n fix (see #1309) (#2026)
* Update conf.php

Small i18n fix for german translation

* Update README.md

Added Reeder-3 as an supported client via Fever API

* Update README.md

Adding Reeder-3/iOS as an supported client

* Update README.fr.md

Adding Reeder-3/iOS as an supported client

* Update 06_Fever_API.md

Adding Reeder-3/iOS as an supported client

* Update 06_Fever_API.md

Adding Reeder-3/iOS as an supported client

* Adding myself

As requested, adding myself to the list of contributors
2018-09-25 23:05:51 +02:00
Alexandre Alapetite
6a56894e94 New extension event + Tumblr GDPR (#1924)
* New extension event + Tumblr GDPR

https://github.com/FreshRSS/FreshRSS/issues/1894
simplepie_before_init event

* Refactor extension enabling + Tumblr GDPR enabled by default

Add possibility for extensions to be enabled by default, and disabled
back by users.

* Minor whitespace
2018-06-09 15:58:18 +02:00
Alexandre Alapetite
4b9f0710eb A bit of API documentation (#1914)
https://github.com/FreshRSS/FreshRSS/issues/1754
2018-06-03 13:14:42 +02:00
Kevin Papst
8f1bad60d0 Add Fever API and user documentation (#1836)
* added fever api and documentation

* spaces to tabs

* fixed code format

* added links

* added utf8 to header

* removed XML support

* removed before check, as we have to convert it afterwards

* added sandboxed setting (currently disabled)
added support for extensions using entry_before_display

* listFeedsOrderUpdate LIMIT

https://github.com/FreshRSS/FreshRSS/pull/1836/files#r175287881

* removed custom sql by using FreshRSS_FeedDAO::listFeedsOrderUpdate()

* fixed mark all as read

* replaced custom sql for getUnread() and getStarred() with dao functions

* removed sanitization functions

* Rework fever login

* Fix config bug

Plus documentation

* Fix array syntax

For compatibility with PHP 5.3

* Disable cookies and session for API

* Fix currentUser

* added response header and error log

* adjusted phpdoc to match new authentication

* Mechanism to delete old keys

* replace PHP_INT_MAX with zero to disable limit

* replace method_exists with check for explicit methods

* removed Press support and smaller refactoring + updated docu

* Rewrite bindParamArray

Avoid one of the SQL injection risks

* Docs and readme

* Fix API link

* Simplify reverse key check

Using userConfig
2018-05-24 21:53:47 +02:00
Henry
28403cd6aa SeLinux context
Prefer apply rights to the whole data instead of individual subdir
2018-04-26 08:32:07 +02:00
Henry
f62d69e1f4 Selinux FAQ
Add PubSubHubbub sub directory
2018-04-26 07:46:15 +02:00
Henry
67c608d44f Typo
fix typo + apply command to sub dir
2018-03-18 12:46:55 +01:00
Henry
a0a5ec8daf Selinux FAQ
Command to run on SELinux system enabled
2018-03-18 10:06:02 +01:00
Alexandre Alapetite
84d891f8cf Light Boolean search implementation (#1828)
* Light Boolean search implementation

"Hello intitle:World OR date:P1D example"
https://github.com/FreshRSS/FreshRSS/issues/879

* Doc Boolean search

* Doc typos
2018-03-14 17:20:41 +01:00
Alexis Degrugillier
51a08cfb1a Add configuration documentation
Writting documentation is really long. Writting good documentation is really hard.
I hope the changes I've made are worth it.
2018-03-13 19:24:58 +01:00
Alexis Degrugillier
ab2aeae8d4 Add a section in the FAQ about changing a password (#1798)
See #901
2018-02-28 09:39:33 +01:00
Alexandre Alapetite
79f8b440d1 API /reader/api/0/stream/items/contents (#1774)
* API /reader/api/0/stream/items/contents

For FeedMe

* Fix continuation

* Continuation in stream/items/ids

* Fix multiple continuations

* Allow empty POST tokens

For FeedMe.
This token is not used by e.g. The Old Reader API.
There is the Authorization header anyway.
TODO: Check security consequences

* API compatibility FeedMe: add/remove feed

FeedMe uses GET for some parameters typically given by POST

* A bit of sanitization

* Links to FeedMe

* API favicons more robust when base_url is not set

* Changelog FeedMe
2018-02-08 20:11:05 +01:00
Frans de Jonge
469d601bcb [doc] Editing for better style (#1736)
* Also removed references to Persona authentication.
* Changed code comment about Persona because it's for HTTP auth
  in general. See 3d876091e1
  and https://github.com/FreshRSS/FreshRSS/issues/358#issuecomment-31931484
2017-12-22 12:02:06 +01:00
Kevin Papst
b562639155 Documentation updates (#1697)
* added documentation about updating FreshRSS
moved Installation to admin directory
linked some already existing documentation files
2017-12-02 13:43:28 +01:00
Frans de Jonge
bf32835db3 [docs] Configuration: some stylistic improvements (#1693)
The main purpose is to fix the `imapcted` typo that was exposed by https://github.com/FreshRSS/FreshRSS/issues/1259#issuecomment-345034276
2017-11-16 20:58:46 +01:00
Alexandre Alapetite
32e9d3a5a1 A bit of documentation for the API (#1689)
https://github.com/FreshRSS/FreshRSS/issues/1687
https://github.com/FreshRSS/FreshRSS/issues/443#issuecomment-36666133
2017-11-12 15:51:43 +01:00
Alexandre Alapetite
920f886c55 A bit of Apache documentation (#1670)
https://github.com/FreshRSS/FreshRSS/issues/1666
https://github.com/FreshRSS/FreshRSS/issues/1669
https://github.com/FreshRSS/FreshRSS/issues/908
2017-10-14 14:16:59 +02:00
Alexandre Alapetite
a72ad940df Increase minimal support to PHP 5.3.8+
https://github.com/FreshRSS/FreshRSS/issues/1604
2017-08-21 12:29:12 +02:00
Marien Fressinaud
afc38e43ec Provide documentation under ./docs 2017-04-24 23:08:43 +02:00