aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2020-08-18Docs: Add Fluent Reader to API Clients (#3140)Gravatar No Name Pro
* 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-07-23Update doc about default configuration (#3124)Gravatar LucasVerneyDGE
See https://github.com/FreshRSS/FreshRSS/issues/3066
2020-07-08Add a migration system (#2760)Gravatar Marien Fressinaud
* Add a Minz_Migrator class Until now, we updated the database structure somewhere in the code but it wasn't always consistent and somehow complicated to find. Also, this code was always checked for nothing. The Migrator aims to improve and ease the creation of migrations. It should improve the way we apply the updates, making the update server almost useless. References: - example of migration (before Migrator): https://github.com/FreshRSS/FreshRSS/commit/cc0db9af4f980829faa4bf0960617807b32fb4fa#diff-11a53443fa81512b128c66b065df0679R10 - update server: https://github.com/FreshRSS/update.freshrss.org - PR moving the code of the update server to the core: https://github.com/FreshRSS/FreshRSS/pull/1760 * Automatically apply migrations For now, administrators are used to have nothing to do during an update else than getting the new code. I suggest to keep this behaviour and automatically apply migrations if we detect new ones. Another solution would be to create a CLI command and ask admins to call it after getting the new code. It could hide migrations errors to end users, but admin can forget to apply migrations since there are not used to it. * Add documentation for Minz Migrator * Execute migrations even if next ones are applied * Change mechanism to prevent multiple update at once * Use mkdir to create the lock and to test it exists Reference: https://stackoverflow.com/a/731634 * Append .lock to applied_migrations_path There are no needs to define another file to serve as a lock. * Change migrations naming convention * Apply suggestions from code review Co-Authored-By: Alexandre Alapetite <alexandre@alapetite.fr> * Perform a low-cost migration versions comparaison * Clarify version numbers concerning the migration system Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-07-04Fixed nginx split paths config issue (#3077)Gravatar jakem72360
* Fixed nginx split paths config issue * Improved config comments. * s/fixes/see/ * Added link to nginx issue tracker
2020-06-19Add auto-registration when using http_auth (#3003)Gravatar bpatath
* Add auto-registration when using http_auth * Document HTTP auth auto-registration * Check email variable for HTTP auth auto-registration * Auto-create HTTP users by default * Fix Context init (I will provide in another PR a better fix requiring a bit of global refactoring) * Init language Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-06-10Add support for extensions in Docker environment (#3042)Gravatar Alexis Degrugillier
By default, the container starts without extensions. But if for some reasons, you need to add them without copying or moving some code, you can embed them while starting the container. The syntax is: ``` make start extensions="/full/path/to/extension/1 /full/path/to/extension/2" ```
2020-05-25tec: Add a make lint command in the Makefile (#2996)Gravatar Marien Fressinaud
2020-05-21Add documentation for i18n (#2978)Gravatar Marien Fressinaud
* doc: Write proper doc for internationalization * Apply suggestions from code review Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/internationalization.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2020-05-08documentation utilisateur / user doc (#2948)Gravatar saimyx
* 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-04-17Filter by multiple feed IDs (#2892)Gravatar Alexandre Alapetite
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-11pause automatic updates during upgrade (#2893)Gravatar Troy Engel
2020-04-05[i18n] Update French translations (#2878)Gravatar Damien Leroy
* Add french translate * Fix documentation broken url
2020-04-01Implement negation for searching by date intervals (#2869)Gravatar Alexandre Alapetite
* 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-03-30[doc] Include contributing.md in Jekyll (#2859)Gravatar Frans de Jonge
Fixes <https://github.com/FreshRSS/FreshRSS/issues/2856> (hopefully).
2020-03-29Fix wget in linux update guide (#2858)Gravatar Ths2-9Y-LqJt6
* change link from wget to curl in linux update guid #2857 * change back to wget per feedback #2857
2020-03-21Fix broken doc link (#2832)Gravatar Alexandre Alapetite
#Fix https://github.com/FreshRSS/FreshRSS/issues/2824
2020-02-29[i18n] Add documentation for new hooks (#2815)Gravatar Frans de Jonge
See <https://github.com/FreshRSS/FreshRSS/pull/2704#issuecomment-592950971>.
2020-01-06Add guidance for pull requestsGravatar Marien Fressinaud
The main reason for this checklist is to not forget about documentation, and to encourage us to write more tests. I hope it'll help us to improve both!
2019-12-29tec: Add a test target to Makefile (#2725)Gravatar Marien Fressinaud
* tec: Add a test target to Makefile Minor edit put php7-phar on third line I try to keep on the third line the Alpine-specific PHP extensions (i.e. that are not by default in Ubuntu), and in alphabetic order Co-Authored-By: Alexandre Alapetite <alexandre@alapetite.fr> * Allow to run make test without Docker
2019-12-15Make master the rolling release branch (#2705)Gravatar Marien Fressinaud
* Change default TAG in Makefile We are going to drop the `dev` branch. The Docker tag `dev-*` are based on this branch and so there will be no longer be generated. We must use images based on the `master` branch (i.e. `latest`, `alpine` and `arm`). * Remove references to dev branch in documentation * Synchronize French documentation
2019-12-03Translate docs with po4a (#2590)Gravatar Frans de Jonge
* [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-11-14Fix link to installation instructions on first steps (#2665)Gravatar Ryan Nielson
2019-11-13Replace some http links with https links (#2662)Gravatar rezad
2019-11-08Rename sharing action (#2643)Gravatar Alexis Degrugillier
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-02Correction in the line 38 (#2628)Gravatar MonsieurP0uet
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-14[CI] Run stylelint (#2477)Gravatar Frans de Jonge
* [CI] Run stylelint Perform some basic CSS sanity checking and style enforcement. I removed vendor prefixed linear-gradient and transform because those are from the IE9 era. With IE11 as a minimum and soon obsolete requirement it doesn't make much sense anymore. * Remove as-link override * Don't require newline after comment * Also apply those newline rules to SCSS * refine opening/closing braces, allow for single-line
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
generated by cgit v1.2.3 (git 2.39.1) at 2026-02-10 14:57:54 +0000