aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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>
2024-03-30Add a way to modify CSP rules within an extension (#6246)Gravatar Alexis Degrugillier
This will allow to change CSP rules to authorize the use of external scripts. We might need to add some safeguard since it will be virtually possible to load any script even malicious one.
2024-03-06Bump the development-dependencies group with 6 updates (#6173)Gravatar dependabot[bot]
* Bump the development-dependencies group with 6 updates Bumps the development-dependencies group with 6 updates: | Package | From | To | | --- | --- | --- | | [eslint](https://github.com/eslint/eslint) | `8.56.0` | `8.57.0` | | [eslint-plugin-n](https://github.com/eslint-community/eslint-plugin-n) | `16.6.1` | `16.6.2` | | [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) | `0.38.0` | `0.39.0` | | [sass](https://github.com/sass/dart-sass) | `1.69.7` | `1.71.1` | | [stylelint](https://github.com/stylelint/stylelint) | `15.11.0` | `16.2.1` | | [stylelint-config-recommended-scss](https://github.com/stylelint-scss/stylelint-config-recommended-scss) | `13.1.0` | `14.0.0` | Updates `eslint` from 8.56.0 to 8.57.0 - [Release notes](https://github.com/eslint/eslint/releases) - [Changelog](https://github.com/eslint/eslint/blob/main/CHANGELOG.md) - [Commits](https://github.com/eslint/eslint/compare/v8.56.0...v8.57.0) Updates `eslint-plugin-n` from 16.6.1 to 16.6.2 - [Release notes](https://github.com/eslint-community/eslint-plugin-n/releases) - [Commits](https://github.com/eslint-community/eslint-plugin-n/compare/16.6.1...16.6.2) Updates `markdownlint-cli` from 0.38.0 to 0.39.0 - [Release notes](https://github.com/igorshubovych/markdownlint-cli/releases) - [Commits](https://github.com/igorshubovych/markdownlint-cli/compare/v0.38.0...v0.39.0) Updates `sass` from 1.69.7 to 1.71.1 - [Release notes](https://github.com/sass/dart-sass/releases) - [Changelog](https://github.com/sass/dart-sass/blob/main/CHANGELOG.md) - [Commits](https://github.com/sass/dart-sass/compare/1.69.7...1.71.1) Updates `stylelint` from 15.11.0 to 16.2.1 - [Release notes](https://github.com/stylelint/stylelint/releases) - [Changelog](https://github.com/stylelint/stylelint/blob/main/CHANGELOG.md) - [Commits](https://github.com/stylelint/stylelint/compare/15.11.0...16.2.1) Updates `stylelint-config-recommended-scss` from 13.1.0 to 14.0.0 - [Release notes](https://github.com/stylelint-scss/stylelint-config-recommended-scss/releases) - [Changelog](https://github.com/stylelint-scss/stylelint-config-recommended-scss/blob/master/CHANGELOG.md) - [Commits](https://github.com/stylelint-scss/stylelint-config-recommended-scss/compare/v13.1.0...v14.0.0) --- updated-dependencies: - dependency-name: eslint dependency-type: direct:development update-type: version-update:semver-minor dependency-group: development-dependencies - dependency-name: eslint-plugin-n dependency-type: direct:development update-type: version-update:semver-patch dependency-group: development-dependencies - dependency-name: markdownlint-cli dependency-type: direct:development update-type: version-update:semver-minor dependency-group: development-dependencies - dependency-name: sass dependency-type: direct:development update-type: version-update:semver-minor dependency-group: development-dependencies - dependency-name: stylelint dependency-type: direct:development update-type: version-update:semver-major dependency-group: development-dependencies - dependency-name: stylelint-config-recommended-scss dependency-type: direct:development update-type: version-update:semver-major dependency-group: development-dependencies ... Signed-off-by: dependabot[bot] <support@github.com> * Fix conflict * Fix Markdown --------- Signed-off-by: dependabot[bot] <support@github.com> Co-authored-by: dependabot[bot] <49699333+dependabot[bot]@users.noreply.github.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-03-05Fix OPML export regression and add token in RSS link (#6160)Gravatar Alexandre Alapetite
* OPML regression due to *shared user queries* (the XPath attributes were not exported anymore) https://github.com/FreshRSS/FreshRSS/pull/6052 * Add master token to HTML Meta RSS link and OPML link https://github.com/FreshRSS/FreshRSS/discussions/6159#discussioncomment-8678399
2024-03-03 docs: Update 02_Prerequisites.md (Apache + PHP version) (#6148)Gravatar maTh
* apache version + php version * format
2024-02-26New feature: shareable user query (#6052)Gravatar Alexandre Alapetite
* New feature: shareable user query Share the output of a user query by RSS / HTML / OPML with other people through unique URLs. Replaces the global admin token, which was the only option (but unsafe) to share RSS outputs with other people. Also add a new HTML output for people without an RSS reader. fix https://github.com/FreshRSS/FreshRSS/issues/3066#issuecomment-648977890 fix https://github.com/FreshRSS/FreshRSS/issues/3178#issuecomment-769435504 * Remove unused method * Fix token saving * Implement HTML view * Update i18n for master token * Revert i18n get_favorite * Fix missing i18n for user queries from before this PR * Remove irrelevant tests * Add link to RSS version * Fix getGet * Fix getState * Fix getSearch * Alternative getSearch * Default getOrder * Explicit default state * Fix test * Add OPML sharing * Remove many redundant SQL queries from original implementation of user queries * Fix article tags * Use default user settings * Prepare public search * Fixes * Allow user search on article tags * Implement user search * Revert filter bug * Revert wrong SQL left outer join change * Implement checkboxes * Safe check of OPML * Fix label * Remove RSS button to favour new sharing method That sharing button was using a global admin token * First version of HTTP 304 * Disallow some recusrivity fix https://github.com/FreshRSS/FreshRSS/issues/6086 * Draft of nav * Minor httpConditional * Add support for offset for pagination * Fix offset pagination * Fix explicit order ASC * Add documentation * Help links i18n * Note about deprecated master token * Typo * Doc about format
2024-01-21Add Read You (#4633)Gravatar th0mcat
* 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-10JSONFeeds, JSON scraping, and POST requests for feeds (#5662)Gravatar eta-orionis
* allow POST requests for feeds * added json dotpath and jsonfeed subscriptions. No translation strings yet * debug and fix jsonfeed parser * bugfix params saved when editing feed * added translations for JSON features * Update docs for web scraping * make fix-all and revert unrelated changes, plus a few manual fixes, but there are still several type errors * Fix some i18n * refactor json parsing for both feed types * cleanup unnecessary comment * refactored generation of SimplePie for XPath and JSON feeds * Fix merge error * Update to newer FreshRSS code * A bit of refactoring * doc, whitespace * JSON Feed is in two words * Add support for array syntax * Whitespace * Add OPML export/import * Work on i18n * Accept application/feed+json * Rework POST * Fix update * OPML for cURL options * Fix types * Fix Typos --------- Co-authored-by: Erion Elmasllari <elmasllari@factorsixty.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2024-01-03Auto-label (#5954)Gravatar Alexandre Alapetite
Add labels automatically to incoming articles fix https://github.com/FreshRSS/FreshRSS/issues/2380 fix https://github.com/FreshRSS/FreshRSS/issues/2420 fix https://github.com/FreshRSS/FreshRSS/issues/3279 fix https://github.com/FreshRSS/FreshRSS/discussions/4947 fix https://github.com/FreshRSS/FreshRSS/issues/5728 fix https://github.com/FreshRSS/FreshRSS/issues/5599
2023-12-30Authentik oAuth setup documentation updates (#5969)Gravatar laxmanpradhan
* Update 16_OpenID-Connect-Authentik.md updated docs * Add files via upload * Update 16_OpenID-Connect-Authentik.md Updated documentation with many clarifications. The most important one is the redirect URL which must include the port or it will not work. To ensure compatibility, I have recommended both URLs be added, with and without the port. Example docker-compose also added with traefik reverse proxy. * Reduce screenshot size * Fixes and improvements * Allow changing auth to HTTP --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-12-29Doc Web git update (#5995)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/discussions/5991
2023-12-23API add unsubscribe example (#5965)Gravatar Alexandre Alapetite
2023-12-03Rework keepmax (#5905)Gravatar Alexandre Alapetite
* Rework keepmax fix https://github.com/FreshRSS/FreshRSS/issues/5702 fix https://github.com/FreshRSS/FreshRSS/issues/5870 * More WIP * Minor progress * Progress * Beta * Improved debug message * Revert noCommit * Fix variable reset * Remove debug syslogs
2023-11-25ChangelogGravatar Alexandre Alapetite
2023-11-14More WebSub doc (#5862)Gravatar Alexandre Alapetite
* More WebSub doc * UI for WebSub + more documentation And spellcheck Frech * Links to WebSub doc from readme * Add link to WebSub doc in admin interface * Fix checkbox * Plural
2023-11-12Docs: How to contribute new theme (#5863)Gravatar maTh
* Update 05_Configuration.md * Update 11_Themes.md * Update contributing.md * Update 02_Design.md * fix --------- Co-authored-by: math-gh <>
2023-11-11Fix trusted cidrs check (#5853)Gravatar Joe Stump
* Fix ignored TRUSTED_PROXY issue * Add a sub-section to the docs no property mappings for Authentik * Typo * Fix typing * A few changes to the doc --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-11-08Update WebSub documentation a bit (#5829)Gravatar Alexandre Alapetite
* Update WebSub documentation a bit * Marien prefers not to promote his hub too much :-)
2023-11-07Add link to Authentik Integrations Documentation (#5828)Gravatar François-Xavier Payet
2023-11-05add multi arch docker build (#5808)Gravatar Benjamin Reich
* Add multi arch container build Co-authored-by: EdJoPaTo <rfc-conform-git-commit-email@funny-long-domain-label-everyone-hates-as-it-is-too-long.edjopato.de> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * using label from github action * dont remove static labels and split docker readme in seperate action * pin 3rd party action to a commit * enable pushing to dockerhub * Update .github/workflows/build-images.yml Co-authored-by: EdJoPaTo <github@edjopato.de> * remove not needed checkout * set github token permissions * Update .github/workflows/push-dockerhub-readme.yml * update docker readme to match new tags * Apply suggestions from code review * fix suffix for alpine image * fix suffix for alpine image * push images only at upstream repo * push images only at upstream repo * push images only at upstream repo * tag latest-alpine as alpine * tag latest-alpine as alpine * remove no needed falvor * keep falvor for build * Clean more things * Rename action To use same default name than https://github.com/actions/starter-workflows/blob/main/ci/docker-publish.yml * Rename readme action To use same default name than https://github.com/peter-evans/dockerhub-description/blob/main/.github/workflows/dockerhub-description.yml * Use default name for dockerhub-description https://github.com/peter-evans/dockerhub-description/blob/main/.github/workflows/dockerhub-description.yml Plus minor wording * Experiment with build-args * Debug * Add checkout back * Revert back to metadata-action * Remove quotes in version * Try to fix variables * Experiment with automatic label values again * Delete last Docker Hub hooks * Use only git SHA for org.opencontainers.image.revision https://specs.opencontainers.org/image-spec/annotations/#pre-defined-annotation-keys * Comment out semver for now Might be enabled later if desired * Enable major semver --------- Co-authored-by: EdJoPaTo <rfc-conform-git-commit-email@funny-long-domain-label-everyone-hates-as-it-is-too-long.edjopato.de> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: EdJoPaTo <github@edjopato.de>
generated by cgit v1.2.3 (git 2.39.1) at 2026-02-10 10:27:59 +0000