aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2021-03-10FocusReader (#3514)Gravatar Alexandre Alapetite
2021-02-17Add user maintenance hooks (#3440)Gravatar Alexis Degrugillier
The new hook allows to add maintenance extensions at the user level. See #3398
2021-02-06Theme Documentation (#3415)Gravatar Lukas Vacula
* adding self CREDITS.md * add "theme" to link for easier navigation * add documentation about themes and the files that go in them * add admin documentation for themes * fix markdown styling * fix CSSJanus usage
2021-02-02Add comprehensive user configuration in extensions (#3397)Gravatar Alexis Degrugillier
Before, the extension configuration was handled by its author. There was discrepancies between extensions on how the configuration was stored. Now, we could rely on a single way of storing configuration. This won't invalidate how the extensions are storing their configuration but will allow authors to focus on what is important.
2021-01-13Update extension documentation (#3352)Gravatar Alexis Degrugillier
Before the extension documentation was not very clear about the methods in the extension and how to use them. I hope that now it makes more sense.
2021-01-10Update and add to documentation (#3348)Gravatar ldv8434
* remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * remove outdated mailing list information * add information about normal view * add information about global and reader view * fix import section header * reorder documentation to reflect menu's order * clarify setting as default in normal view * add info about reading section for config * fix heading levels, add info about archive + profile sections * unfix heading levels * move section on feed-specific settings to the subscription management page * update information about adding feeds, add information about feed management * fix link to security page in installation * fix broken links * fix broken link to install page * add lighttpd from project readme * add php modules to step 4, add horizontal line to better separate steps from footnotes visually * fix broken link * add index page for easier access of other pages * move first steps document * make dedicated bug reporting page * make index page for linking to other pages * moved fever API to relevant location, linked to index * re-fix link * remove mention of defunct mailing list * grammar fix * replace stream with feed * add optional items, replace stream with feed * replace stream with feed * fix word choice Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * fix word choice better reflect age of project Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * grammar fixes Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * remove double headings Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * change single quote to double quote for consistency * add subreddit link * change php module list to Dockerfile link * fix link to developer index, change html links to md for consistency * update css selector terms Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-01-09Add class autoload for extension (#3350)Gravatar Alexis Degrugillier
When an extension defines an `autoload` method, it will be registered automatically before enabling the extension. For the extension creator, it's easier because there is no need to register it manually.
2021-01-09Document the SQLite utilities usage (#3344)Gravatar Alexis Degrugillier
There is a CLI command to export from any database to a SQLite database and also a CLI command to import a SQLite database to any database than need to be documented. See #961
2021-01-07Update user query feature (#3338)Gravatar Alexis Degrugillier
* Change user query wording There was some misunderstanding in the use of the user query feature, probably because of the wording. I've change it to make it more obvious. * Fix feedback when a query is bookmarked Before, the displayed query name was not the one intended. Now, the name is the one of the current bookmark * Document user queries I've added a few words on how to use the user queries because it seems there was some misunderstanding. See #3219
2021-01-07two new hooks (#3342)Gravatar Clemens Neubauer
* add two new hooks I develop a new extension and i need 2 new hooks for it * update EN documentation * Correct typing errors * Update app/views/helpers/javascript_vars.phtml Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-01-03Adding info about combining css classes (#3329)Gravatar rom-1
* Adding info about combining css classes Adding info about combining css classes using comma separation * Update 05_Configuration.md * Apply suggestions from code review Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-01-02Add section for text import (#3304)Gravatar Alexis Degrugillier
See #663
2020-12-31Update 03_Main_view.md (#3307)Gravatar rom-1
adding to documentation: filtering a tag with whitespace
2020-12-29Add a file for each PDO class (#3301)Gravatar Alexis Degrugillier
Before, we had 5 classes in the ModelPdo file. It was bad for 2 reasons. The first reason is that it is considered bad practice to have multiple class in one file. This is especially true when using autoloading. On top of that it is less readable considering the size of the file. The second reason is that so far we were lucky. Everytime we needed to access the database, it was through the ModelPdo class which loads all the other classes. If we want to access directly the connection, it wont be loaded. On top of that, the system is configured to work on a single database, but as we have every connection definition in a single file, all classes were loaded at the same time. Thus using memory and processing time for nothing. Now, we have a file for each class. To work with autoloading, classes were slightly renamed to match autoloading rules.
2020-12-28Revert "Add a file for each PDO class (#3297)"Gravatar Alexandre Alapetite
This reverts commit e1ee58816ba76734e4115fc12898b13de665b220.
2020-12-28Add a file for each PDO class (#3297)Gravatar Alexis Degrugillier
Before, we had 5 classes in the ModelPdo file. It was bad for 2 reasons. The first reason is that it is considered bad practice to have multiple class in one file. This is especially true when using autoloading. On top of that it is less readable considering the size of the file. The second reason is that so far we were lucky. Everytime we needed to access the database, it was through the ModelPdo class which loads all the other classes. If we want to access directly the connection, it wont be loaded. On top of that, the system is configured to work on a single database, but as we have every connection definition in a single file, all classes were loaded at the same time. Thus using memory and processing time for nothing. Now, we have a file for each class. To work with autoloading, classes were slightly renamed to match autoloading rules.
2020-11-12Update link to News+ Google Reader extension (#3252)Gravatar Alwaysin
* 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-10-15Update FAQ with firewall issues. (#3225)Gravatar tonitonae
* 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-03Optimize images (#3184)Gravatar Andrew Rabert
Used `oxipng --zopfli --opt max --strip all`
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
generated by cgit v1.2.3 (git 2.39.1) at 2026-02-11 09:22:10 +0000