Commit Graph

44 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
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
jakem72360
4593594544 Fixed nginx split paths config issue (#3077)
* Fixed nginx split paths config issue

* Improved config comments.

* s/fixes/see/

* Added link to nginx issue tracker
2020-07-04 11:16:09 +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
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
rezad
8bdf7b09f2 Replace some http links with https links (#2662) 2019-11-13 20:52:52 +01:00
Alexandre Alapetite
61724c651b PostgreSQL 9.5+ (#2554)
Needed for `CREATE  INDEX IF NOT EXISTS` syntax.
Supported as back as Ubuntu 16.04 LTS.
Similar version checks than for the PHP version bump
https://github.com/FreshRSS/FreshRSS/pull/2495
https://www.postgresql.org/docs/9.5/sql-createindex.html
https://www.postgresql.org/docs/9.5/release-9-5.html
2019-10-05 15:48:25 +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
e761202f8a Remove JSON.php fallback (#2528)
After moving to PHP 5.6+ https://github.com/FreshRSS/FreshRSS/pull/2527
it should not be necessary to have the JSON.php fallback anymore, which
was mainly there due to an obscure licensing issue 6 years ago in Debian
https://wiki.debian.org/qa.debian.org/jsonevil , which broke Ubuntu
13.10 https://github.com/FreshRSS/FreshRSS/issues/306
2019-09-18 17:18:36 +02:00
Alexandre Alapetite
38117df976 Require PHP 5.6+
Discussion
https://github.com/FreshRSS/FreshRSS/pull/2495#issuecomment-531911473
Needed for constant arrays
https://www.php.net/manual/en/migration56.new-features.php which will be
used in https://github.com/FreshRSS/FreshRSS/pull/2522
2019-09-17 20:28:07 +02:00
Alexandre Alapetite
d09826c145 Docker Alpine opcache (#2498)
https://github.com/FreshRSS/FreshRSS/pull/2495#discussion_r315662184
https://php.net/ref.opcache
We need to retest the performances
https://github.com/FreshRSS/FreshRSS/pull/2205
2019-08-20 15:48:54 +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
Sp3r4z
1a14860040 Fix line break in table (#2413)
* Fix line return 

Better with HTML native `<br>` than with `\\`

* Fix line break

Replace `\\` by native HTML `<br>`
2019-06-16 20:12:51 +02:00
Sp3r4z
f9d0f20dbc Add Dockerfile links for PHP modules list (#2409)
* Add whole PHP modules Dockerfile link

* Add Dockerfile link to whole PHP modules list
2019-06-16 17:16:21 +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
Frans de Jonge
55992d4548 [docs] Bookmarklet (#2116) 2018-11-05 18:14:35 +01:00
Maltimore
3eae8bd3b7 doc: update nginx config to reflect debian php7.0 changes (#2076) 2018-10-24 18:15:24 +02: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
Julkikod
70bb228e1d Update 06_Mobile_access.md (#1925)
* Update 06_Mobile_access.md

Mise à jour de l'aide sur l'accès via mobile

* Update 06_Mobile_access.md

* Minor text

* Minor edits
2018-06-08 16:12:04 +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
6bac71b2e8 Fix typo
Missing quotes at the end of file
2018-03-18 11:24:50 +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
ab2aeae8d4 Add a section in the FAQ about changing a password (#1798)
See #901
2018-02-28 09:39:33 +01:00
Jérémie Bertrand
cd5bfcd791 Fix MySQL minimal requirement (#1794)
* Fix MySQL minimal requirement

* Fix MySQL minimal requirement on french docs
2018-02-25 17:32:24 +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
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