Commit Graph

25 Commits

Author SHA1 Message Date
Elanna Grossman
60b5459cac Update Reader Link Documentation (#7362)
* docs(docs): update Reeder link to point to Reeder Classic

* docs(CREDITS): add name to credits
2025-02-24 12:35:00 +01:00
maTh
79651b942d improve api management (#7048)
* ... and sharing user queries by link (not all languages)

* Profile page: API mgm: better headline, better help text

* i18n

* i18n: " and sharing user queries"

* i18n: link to documentation + apps list

* Update app/i18n/it/conf.php

* Update app/i18n/it/conf.php

* Update app/i18n/it/conf.php

* Update app/i18n/it/conf.php

* Update app/i18n/it/conf.php

* Update app/i18n/it/conf.php

* Update app/i18n/it/conf.php

* Update app/i18n/it/admin.php

Co-authored-by: UserRoot-Luca <55756898+UserRoot-Luca@users.noreply.github.com>

* Update app/i18n/it/conf.php

* Update app/i18n/fr/admin.php

* i18n

* French doc cf. English

* Update app/i18n/it/conf.php

Co-authored-by: UserRoot-Luca <55756898+UserRoot-Luca@users.noreply.github.com>

* Update conf.php

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
Co-authored-by: UserRoot-Luca <55756898+UserRoot-Luca@users.noreply.github.com>
2024-12-04 22:41:08 +01:00
th0mcat
79bf7d4967 Add Read You (#4633)
* Add Read You

* Update README.fr.md

* Add Read You

* Add Read You

* Add Read You

* Add Read You

* Beta version ready
https://github.com/Ashinch/ReadYou/pull/536
https://github.com/Ashinch/ReadYou/discussions/478
https://github.com/Ashinch/ReadYou/discussions/542

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-01-21 13:56:08 +01:00
Alexandre Alapetite
ac5980231b API add unsubscribe example (#5965) 2023-12-23 11:07:14 +01:00
Alexandre Alapetite
eb850b7a01 Add Fluent Reader Lite (#4595)
#fix https://github.com/FreshRSS/FreshRSS/issues/3418
2022-09-10 15:17:49 +02:00
Matt Sephton
23bf530639 lire app (#4523)
* Update README.md

Add lire, sort alphabetically

* Mix conflict

* English

* GReader

* Duplicate line Reeder

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-08-22 23:18:50 +02:00
Alexandre Alapetite
d27cf13248 News+ use GitHub links (#4262)
Google Play links do not work anymore
2022-03-06 21:32:00 +01:00
maTh
639f8eea84 Documentation improved: mobile access (#4235)
* Update 06_Mobile_access.md

* Readme: Windows + MacOS

* fix markdown

* Update docs/en/users/06_Mobile_access.md

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

* Update docs/en/users/06_Mobile_access.md

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

* MacOS -> macOS

* Update 06_Mobile_access.md

* Update docs/en/users/06_Mobile_access.md

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

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2022-02-27 21:50:28 +01:00
Alexandre Alapetite
1acd3ab09b Use typographic quotes (#4133)
* Use typographic quotes

* A few fixes

* Fix

* Fix not saved

* Implement feedback

* Detail

* Revert spoken English fixes
Left for a future dedicated discussion

* More reverts

* Final reverts

* Final minor
2022-01-08 21:58:55 +01:00
Alexandre Alapetite
acbba9adb2 Improved markdownlint (#3918)
* Improved markdownlint
* Relaxed rules slighlty
* `npm run markdownlint` for automatic tests
* `npm run markdownlint_fix` for automatic syntax fixing
* Applied the fixes on all our Markdown files
2021-10-23 13:43:24 +02:00
Petra Lamborn
90ea2156f6 Newsboat support (#3574)
* Newsboat support

Newsboat is a feed reader for the unix-derived terminal, and is the successor to Newsbeuter. FreshRSS support has been merged into master <f18145fc98> but there has not yet been a release since then. In the meantime I've created this pull request that can be merged whenever it becomes strictly accurate.

I've filled out the table to the best of my ability, but I'm not completely clear on what "Fast sync" and "Fetch more in individual views" mean.

* Does not work offline with freshrss

* More doc

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-04-08 18:32:27 +02:00
Alexandre Alapetite
b455b29c8c FocusReader (#3514) 2021-03-10 20:28:58 +01:00
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
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
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
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
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
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
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
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
Marien Fressinaud
afc38e43ec Provide documentation under ./docs 2017-04-24 23:08:43 +02:00