aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
2025-04-07Secure serving of user files from extensions (#7495)Gravatar Alexandre Alapetite
* Secure serving of user files from extensions fix https://github.com/FreshRSS/FreshRSS/issues/4930 * More fixes * Typo
2025-04-01Update 10_filter.md to provide detailed explanations of the time syntax. (#7464)Gravatar 22cs
* Update 10_filter.md to provide detailed explanations of the time syntax. * Update 03_Main_view.md to provide detailed explanations of the time syntax. * Reworded --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2025-03-25JavaScript: new event to detect context loaded (#7452)Gravatar hkcomori
* Add JavaScript event: freshrss:globalContextLoaded * Update docs * Update docs: fix typo
2025-03-22Update 02_Prerequisites.md (#7448)Gravatar docxml
* Update 02_Prerequisites.md Line numbers have varied over time * Same for fr --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2025-03-13Implement JSON string concatenation with & operator (#7414)Gravatar Alexandre Alapetite
Inspired by [JSONata syntax](https://docs.jsonata.org/expressions). fix https://github.com/FreshRSS/FreshRSS/issues/6565
2025-03-13Changelog + creditsGravatar Alexandre Alapetite
2025-03-04docs: add link to freshrss_python_api (#7401)Gravatar Olicorne
as suggested here: https://github.com/FreshRSS/FreshRSS/discussions/7395 Signed-off-by: thiswillbeyourgithub <26625900+thiswillbeyourgithub@users.noreply.github.com>
2025-02-24Update Reader Link Documentation (#7362)Gravatar Elanna Grossman
* docs(docs): update Reeder link to point to Reeder Classic * docs(CREDITS): add name to credits
2025-02-23Release 1.26.01.26.0Gravatar Alexandre Alapetite
2025-02-21Replace opml generateing nline tool with working link (#7346)Gravatar kleintux
* Update 04_Subscriptions.md * Update 04_Subscriptions.md
2025-02-19Docker Compose remove deprecated version (#7309)Gravatar Alexandre Alapetite
Minor doc
2025-02-06API documentation link to more tips (#7305)Gravatar Alexandre Alapetite
https://github.com/jocmp/capyreader/discussions/533#discussioncomment-11341808 While waiting for https://github.com/FreshRSS/FreshRSS/issues/7304 We should then consolidate the API synchronisation recommendations in our documentation
2025-02-02Add documentation for adding Pocket ID as OIDC provider (#7291)Gravatar Logan
* Add documentation for OIDC login via Pocket IT * Images for the Pocket ID OIDC docs * Update 16_OpenID-Connect.md * Recompress images (too big) * Fix typo and reduce long lines * Remove advise on changing username Which only work to some extent with SQLite (breaking a few minor things such as WebSub, API) and not at all with other databases --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2025-01-28Better authorization label for OIDC (#7264)Gravatar Alexandre Alapetite
* Better authorization label for OIDC Reword description of HTTP login method to include OIDC fix https://github.com/FreshRSS/FreshRSS/issues/7254#issuecomment-2615838151 And remove several duplicated i18n entries. And add to documentation https://www.authelia.com/integration/openid-connect/freshrss/ * Update app/i18n/it/admin.php Co-authored-by: UserRoot-Luca <55756898+UserRoot-Luca@users.noreply.github.com> * Update app/i18n/nl/admin.php Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> --------- Co-authored-by: UserRoot-Luca <55756898+UserRoot-Luca@users.noreply.github.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2025-01-25Add search operator intext: (#7228)Gravatar Alexandre Alapetite
* Add search operator intext: fix https://github.com/FreshRSS/FreshRSS/issues/6188 https://github.com/FreshRSS/FreshRSS/discussions/7220 * Add example to doc
2025-01-08Add instructions for serving FreshRSS on a subdomain with Caddy (#7197)Gravatar Roan-V
* Add instructions for serving FreshRSS on a subdomain with Caddy * Fix failing test
2025-01-08Simplify the Caddy configuraton (#7194)Gravatar Roan-V
* Simplify Caddyfile configuraton * Fix missing bracket :) * Fix failing test
2025-01-06doc(openid-connect): Add initial setup instructions (#7174)Gravatar ShaddyDC
* doc(openid-connect): Add initial setup instructions See discussion for reference: https://github.com/FreshRSS/FreshRSS/discussions/5684#discussioncomment-11707635 * style(openid-connect): Change lists to dash style * Minimize changes * Typography --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-12-23doc(openid-connect): clarify that OIDC is only supported for the Apache web ↵Gravatar aftix
server (#7135) * doc(openid-connect): clarify that OIDC is only supported for the Apache web server Fixes: https://github.com/FreshRSS/FreshRSS/issues/7134 * Update docs/en/admins/16_OpenID-Connect.md --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-12-21doc(docker-cron): duplicate documentation from README to the official docs ↵Gravatar davralin
(#7127)
2024-12-10OPML export/import for cssFullContentConditions (#7082)Gravatar Alexandre Alapetite
Follow-up of https://github.com/FreshRSS/FreshRSS/commit/33fd07f6f26310d4806077cc87bcdf9b8b940e35, which should have been a PR.
2024-12-08docs: headlines added (#7075)Gravatar maTh
* Update contributing.md * Update 02_First_steps.md * Update docs/en/contributing.md --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-12-05Parentheses in quoted search (#7055)Gravatar Alexandre Alapetite
* Parentheses in quoted search Allow parentheses in quoted search like `author:"Bob (Team1)"` Related to https://github.com/FreshRSS/FreshRSS/pull/7054 * Doc
2024-12-04improve api management (#7048)Gravatar maTh
* ... 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-11-28Upgrade code to php 8.1 (#6748)Gravatar Luc SANCHEZ
* revert Fix code indentation Fix code Upgrade code to php 8.1 * fix remarques * code review * code review * code review * Apply suggestions from code review * code review * Fixes * Many remainging updates of array syntax * Lost case 'reading-list' * Uneeded PHPDoc --------- Co-authored-by: Luc Sanchez <l.sanchez-prestataire@alptis.fr> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-11-21Add extension hook simplepie_after_init (#7007)Gravatar Alexandre Alapetite
* Add extension hook simplepie_after_init fix https://github.com/FreshRSS/FreshRSS/issues/7006 * Add documentation note * fix doc get_headers * Syntax void * Forgotten code
2024-10-14Add hook entries_favorite (#6880)Gravatar Alexandre Alapetite
Called when entries are starred or unstarred
2024-10-13New feed mode: HTML + XPath + JSON dot notation (JSON in HTML) (#6888)Gravatar Alexandre Alapetite
* New feed mode: HTML + XPath + JSON dot notation (JSON in HTML) Same as `JSON+DotNotation` but first extracting the JSON string from an HTML document thanks to an XPath expression. Example: `//script[@type='application/json']` fix https://github.com/FreshRSS/FreshRSS/discussions/6876 * JavaScript UI to show/hide new field * Casing xPathToJson * Slight renaming
2024-10-11Apache protect more non-public folders and files (#6881)Gravatar Alexandre Alapetite
* Apache protect more non-public folders * Also protect root * Do the same for /p/ * Simplify Require all denied In case of Apache 2.2, it will just make an error 500 instead of 403 * .htaccess.dist * Simplify * Better comment
2024-09-29Added: Share via telegram app (#6838)Gravatar maTh
* add telegram as sharing service * Update 08_sharing_services.md
2024-09-11Minor doc requirements (#6795)Gravatar Alexandre Alapetite
* Minor doc requirements * Uniformisation
2024-09-07Improved doc search (#6785)Gravatar Alexandre Alapetite
* Improved doc search * <&">
2024-09-06Regex search (#6706)Gravatar Alexandre Alapetite
* Regex search fix https://github.com/FreshRSS/FreshRSS/issues/3549 * Fix PHPStan * Fix escape * Fix ungreedy * Initial support for regex search in PostgreSQL and MySQL * Improvements, support MySQL * Fix multiline * Add support for SQLite * A few tests * Added author: and inurl: support, documentation * author example * Remove \b for now * Disable regex sanitization for now * Fix getInurlRegex * getNotInurlRegex * Quotes for inurl: * Fix test * Fix quoted tags + regex for tags https://github.com/FreshRSS/FreshRSS/issues/6761 * Fix wrong regex detection * Add MariaDB * Fix logic * Increase requirements for MySQL and MariaDB Check support for multiline mode in MySQL * Remove sanitizeRegexes() * Allow searching HTML code Allow searching for instance `/<pre>/` Fix https://github.com/FreshRSS/FreshRSS/issues/6775#issuecomment-2331769883 * Doc regex search HTML * Fix Doctype
2024-09-06Upgrade to PHP 8.1 (#6711)Gravatar Alexandre Alapetite
* Upgrade to PHP 8.1 As discussed in https://github.com/FreshRSS/FreshRSS/discussions/5474 https://www.php.net/releases/8.0/en.php https://www.php.net/releases/8.1/en.php Upgrade to available native type declarations https://php.net/language.types.declarations Upgrade to https://phpunit.de/announcements/phpunit-10.html which requires PHP 8.1+ (good timing, as version 9 was not maintained anymore) Upgrade `:oldest` Docker dev image to oldest Alpine version supporting PHP 8.1: Alpine 3.16, which includes PHP 8.1.22. * Include 6736 https://github.com/FreshRSS/FreshRSS/pull/6736
2024-09-06PostgreSQL suggestion of index improvement (#6705)Gravatar Alexandre Alapetite
https://www.postgresql.org/docs/current/sql-createstatistics.html https://www.postgresql.org/docs/current/sql-analyze.html Requires PostgreSQL 10+ (which is already EOL - shipped with Ubuntu 18.04, Debian 10 Buster -, so update doc at the same time even when not using it) https://www.postgresql.org/docs/release/10.0/
2024-08-26OIDC changelog + minor whitespaceGravatar Alexandre Alapetite
+fix minor whitespace from https://github.com/FreshRSS/FreshRSS/pull/6730
2024-08-25Fix OIDC session params definition (#6730)Gravatar pando85
* Fix OIDC session params definition - standardize environment variable names - group all in the same configuration file - use mod_auth_openidc default values - fix `OIDCSessionMaxDuration` because it was not set with the previous code - add documentation * Add double quoting to prevent globbing and word splitting * Revert line deleted by mistake
2024-08-14Update about running tests (#6709)Gravatar Alexandre Alapetite
2024-07-08Update composer shfmt typos (#6614)Gravatar Alexandre Alapetite
2024-06-10fix broken sharing services (part 2): delete Blogotext (#6225)Gravatar maTh
2024-06-05Fix code for Czech language (#6514)Gravatar Alexandre Alapetite
Use the correct ISO 639-1 code: `cs` and not `cz` (which is the country) https://www.loc.gov/standards/iso639-2/php/langcodes_name.php?iso_639_1=cs
2024-06-05Add core extensions: UserCSS, UserJS (#6267)Gravatar hkcomori
* Copy CustomCSS and CustomJS Original: FreshRSS/Extensions@9f21984 * Rename CustomCSS -> UserCSS * Rename CustomJS -> UserJS * Change metadata The name is used for the directory where the configuration is stored and should not contain spaces. Since the name was changed, I reset the version number and changed to semantic versioning. * Change data directory Changed the location of the configuration file to the user data directory, because it is not `static`. That way, the user's configurations are gathered in the user directory, which makes it easier to backup them. * Edit documentations Remove procedures to install the extension because it is no longer necessary. * Fix wrong variables in the configuration page Remove permission error indication because the storage location is now in the user data directory managed by the application. * Remove the `xExtension-` prefix for core extensions * Set version to 1.0.0 for UserCSS, UserJS * Refactoring * Remove unused variables * Remove version 0.0.1 in Changelog Version 0.0.1 will not be merged, so only version 1.0.0 will remain. * public getFileUrl * Revert more protected * Use entrypoint for extension user path instead of name * Add space to extension name * Add `#[\Override]` * Add explains of User CSS and User JS to docs * Remove README of User CSS and User JS * Add migration code for extension user path --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-05-15Docs: fix minor typo in 09_AccessControl.md (#6465) (#6466)Gravatar Shane Redman
chose -> choose
2024-05-15Correct casing for GitHub (#6460)Gravatar Alexandre Alapetite
2024-05-01Docs: hidden configs (#6402)Gravatar maTh
* Create 17_configs_not_ui.md * reorganize admin overview page. Added the link to the new doc * Update 17_configs_not_ui.md * Update 17_configs_not_ui.md * Update 17_configs_not_ui.md * fix typo
2024-04-30CLI database backup and restore (#6387)Gravatar Alexandre Alapetite
* CLI database backup and restore Can also be used to migrate from one database to another (e.g. MySQL to PostgreSQL) or to ease upgrade to a major PostgreSQL version (e.g. 15 to 16). * +x * Fix some cases * Update to docker-compose-v2 * More documentation
2024-04-25Refactoring: Rename dotpath into dotnotation (#6369)Gravatar maTh
* KIND_JSON_DOTPATH -> KIND_JSON_DOTNOTATION * TYPE_JSON_DOTPATH => TYPE_JSON_DOTNOTATION * json_dotpath => json_dotnotation * dotPathsForStandardJsonFeed => dotNotationForStandardJsonFeed * TYPE_JSON_DOTNOTATION = 'JSON+DotPath' => 'JSON+DotNotation' * documentation: OPML.md * convertJsonToRss() * $dotpaths => $dotnotations * FreshRSS_Feed_Exception * comment * Compatibility TYPE_JSON_DOTPATH --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-04-12Add some error prevention to Debian/Ubuntu installation docs (#6290)Gravatar Frans de Jonge
Reverts a minor part of <https://github.com/FreshRSS/FreshRSS/pull/2164>. People who want to use the root can easily figure out how to do that themselves. Fixes #4955.
2024-04-10PHP 8.3 #[\Override] (#6273)Gravatar Alexandre Alapetite
* PHP 8.3 #[\Override] https://php.watch/versions/8.3/override-attr With PHPStan `checkMissingOverrideMethodAttribute` https://phpstan.org/config-reference#checkmissingoverridemethodattribute And modified the call to phpstan-next on the model of https://github.com/FreshRSS/Extensions/pull/228 (more robust than the find method, which gave some strange errors) * Update extension example accordingly
2024-03-30Update documentation for Caddy reverse proxy with subfolder (#6219)Gravatar Soniya Prasad
* Create 06_Reverse_Proxy_Setup.md Update documentation for Caddy reverse proxy with subfolder * Create 06_Reverse_Proxy_Setup.md in docs/en/developers/03_Backend * fixed markdown syntax * markdown syntax fix * Update docs/en/developers/03_Backend/06_Reverse_Proxy_Setup.md Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * implemented suggested changes * Add link and re-organise --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>