aboutsummaryrefslogtreecommitdiff
path: root/docs/en
AgeCommit message (Collapse)Author
2019-10-27Add systemd configuration in documentation (#2605)Gravatar Alexis Degrugillier
See #2561 and #2557
2019-10-23Take advantage of PHP 5.4+ short echo (#2585)Gravatar Alexandre Alapetite
* Take advantage of PHP 5.4+ short echo https://php.net/migration54.new-features thanks to https://github.com/FreshRSS/FreshRSS/pull/2495 Use `<?= ?>` instead of `<?php echo; ?>` 10kB of code saved :-) Done with regular expression: ``` <\?php echo (.+?);? *\?> <?= \1 ?> ``` * Try Travis fix https://github.com/squizlabs/PHP_CodeSniffer/issues/2045#issuecomment-395238272
2019-10-22Docs update (#2164)Gravatar Patrick
* Update Readme.conf Add information in Readme.conf to hopefully stop bug reports about intended behavior. * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update Readme * Update Documentation Section * Add main Documentation link near top of Document * Make Documentation header a link * Fix spelling mistake I didn't catch * Apply suggestions from code review Co-Authored-By: pattems <patrick@crandol.com> * Changes per Frenzie comments * Move non-disclaiming disclaimer * English Admin Documentation Update * Add Backup section * Update wording in Index * Move Footnotes to End * Move Footnote * Add content for todos * Fix typos * Fix a bunch of typos * Remove a duplicated file (forgotten during dev merge) * Improve the documentation a bit
2019-10-19Reeder added native support (#2578)Gravatar Stoinov
* 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-05PostgreSQL 9.5+ (#2554)Gravatar Alexandre Alapetite
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-01Trim whitespace (#2544)Gravatar Alexandre Alapetite
2019-09-28Document Reeder compatibility (#2540)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/2513 https://github.com/FreshRSS/FreshRSS/pull/2526
2019-09-18Remove JSON.php fallback (#2528)Gravatar Alexandre Alapetite
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-17Require PHP 5.6+Gravatar Alexandre Alapetite
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-08-29Provide email address verification feature (#2481)Gravatar Marien Fressinaud
* Add an email field to the profile page I reuse the `mail_login` from the configuration. I'm not sure if it's useful today (I would say it was used when Persona login was available). A good improvement would be to rename `mail_login` into `email` so it would be more intuitive to use. * Add boolean to the conf to force email validation This commit only adds a configuration item. * Add email during registration if email must be validated * Set email token to validate when email changes * Block access to FreshRSS if email is not validated * Send email when address is changed * Allow to resend the validation email * Allow the user to change its email while blocked * Document the email validation feature * fixup! Allow the user to change its email while blocked * tec: Autoload PHPMailer lib * Validate email address format * Add feedback on validation email resend action * Allow to logout when user is blocked * fix: Change default email "from" * Reorganize i18n keys * Complete all the locales with default english * Hide sidebar (profile page) if email is not validated * Check email requirements on registration * Allow admin to specify email when creating users * Don't check email format if value is empty * Remove trailing comma in userController Co-Authored-By: Alexandre Alapetite <alexandre@alapetite.fr> * Set PHPMailer validator to html5 before sending email * fixup! Remove trailing comma in userController
2019-08-29tec: Add Makefile and Docker conf for development (#2492)Gravatar Marien Fressinaud
Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com> Co-Authored-By: Alexandre Alapetite <alexandre@alapetite.fr>
2019-08-20Docker Alpine opcache (#2498)Gravatar Alexandre Alapetite
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-20Require PHP 5.5+ (#2495)Gravatar Alexandre Alapetite
* 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-17Doc MariaDB (#2494)Gravatar Alexandre Alapetite
2019-08-14Add hooks to ExtensionManager (#2482)Gravatar Marien Fressinaud
Hooks allow to: - add items in menus - perform new actions at the end of FreshRSS initialization
2019-07-15Promote FreshRSS-Notify in user documentation (#2445)Gravatar Purexo
* 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-06-23Add FAQ for admin section (#2427)Gravatar Alexis Degrugillier
See #1987 and #2102
2019-06-16Fix line break in table (#2413)Gravatar Sp3r4z
* Fix line return Better with HTML native `<br>` than with `\\` * Fix line break Replace `\\` by native HTML `<br>`
2019-06-16Add Dockerfile links for PHP modules list (#2409)Gravatar Sp3r4z
* Add whole PHP modules Dockerfile link * Add Dockerfile link to whole PHP modules list
2019-05-30Merge pull request #2389 from Fake4d/patch-1Gravatar Alexandre Alapetite
Update 03_Main_view.md
2019-05-30Fix typosGravatar Alexandre Alapetite
2019-05-30Remove /de/ in URLGravatar Alexandre Alapetite
2019-04-29Update 06_Fever_API.mdGravatar Fake4d
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-29Update 03_Main_view.mdGravatar Fake4d
Typo in Param maxFeeds
2019-04-29Update 03_Main_view.mdGravatar Fake4d
Document all the parameters for "feed actualize". the new parameter "maxfeeds" from Pull Request #2388 is already considered.
2019-03-09Add reference to Readably appGravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/1406#issuecomment-469310998
2019-01-02Apache performance (#2202)Gravatar Alexandre Alapetite
* 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
2018-12-16Update naming to WebSub (#2184)Gravatar Alexandre Alapetite
Instead of PubSubHubbub / PuSH
2018-12-16Documentation update (#2095)Gravatar Alwaysin
* 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-16Documentation Vienna (#2126)Gravatar Alexandre Alapetite
* 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-16French readme parity English (#2183)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/pull/2158#issuecomment-444217219
2018-11-18[docs] Add note about specific user for webcron (#2142)Gravatar Frans de Jonge
* [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-11Note stating manually adding custom subscription services removed in FF 63 ↵Gravatar ryliejamesthomas
(#2112) * Note stating manually adding custom subscription services removed in FF 63 * Amended to mention bookmarklet and upcoming issues
2018-11-05[docs] Bookmarklet (#2116)Gravatar Frans de Jonge
2018-10-24doc: update nginx config to reflect debian php7.0 changes (#2076)Gravatar Maltimore
2018-09-25Small docs update (see #1999) and i18n fix (see #1309) (#2026)Gravatar Roland Arendes
* 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-06-09New extension event + Tumblr GDPR (#1924)Gravatar Alexandre Alapetite
* 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-03A bit of API documentation (#1914)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/1754
2018-05-24Add Fever API and user documentation (#1836)Gravatar Kevin Papst
* 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-04-26SeLinux contextGravatar Henry
Prefer apply rights to the whole data instead of individual subdir
2018-04-26Selinux FAQGravatar Henry
Add PubSubHubbub sub directory
2018-03-18TypoGravatar Henry
fix typo + apply command to sub dir
2018-03-18Selinux FAQGravatar Henry
Command to run on SELinux system enabled
2018-03-14Light Boolean search implementation (#1828)Gravatar Alexandre Alapetite
* 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-13Add configuration documentationGravatar Alexis Degrugillier
Writting documentation is really long. Writting good documentation is really hard. I hope the changes I've made are worth it.
2018-02-28Add a section in the FAQ about changing a password (#1798)Gravatar Alexis Degrugillier
See #901
2018-02-25Fix MySQL minimal requirement (#1794)Gravatar Jérémie Bertrand
* Fix MySQL minimal requirement * Fix MySQL minimal requirement on french docs
2018-02-08API /reader/api/0/stream/items/contents (#1774)Gravatar Alexandre Alapetite
* 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
2017-12-22[doc] Editing for better style (#1736)Gravatar Frans de Jonge
* Also removed references to Persona authentication. * Changed code comment about Persona because it's for HTTP auth in general. See https://github.com/FreshRSS/FreshRSS/commit/3d876091e1268e3ccd5036449a4deb5134936206 and https://github.com/FreshRSS/FreshRSS/issues/358#issuecomment-31931484
2017-12-17[docs] Extensions: fix typo (#1735)Gravatar Frans de Jonge
generated by cgit v1.2.3 (git 2.39.1) at 2026-02-10 14:23:56 +0000