aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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>
2023-10-31Update DB recommendations (#5793)Gravatar Alexandre Alapetite
* Update DB recommendations Favour PostgreSQL, based on tests such as: https://github.com/FreshRSS/FreshRSS/pull/5648#issuecomment-1715843198 https://github.com/FreshRSS/FreshRSS/issues/5707 SQLite is generally very fine, although with the challenge that the DB model cannot easily be updated https://www.sqlite.org/lang_altertable.html#why_alter_table_is_such_a_problem_for_sqlite (We should ship a command-line update mechanism) I have verified that FreshRSS still works with `mysql:5.5.62` https://hub.docker.com/layers/library/mysql/5.5.62/images/sha256-d404d78aa797c87c255e5ae2beb5d8d0e4d095f930b1f20dc208eaa957477b74?context=explore * sqlite
2023-10-31Document Apache 2.4+ (#5791)Gravatar Alexandre Alapetite
And avoid crash in Apache 2.2 anyway fix https://github.com/FreshRSS/FreshRSS/issues/5790
2023-10-31Clarify documentation on OIDC_X_FORWARDED_HEADERS (#5789)Gravatar Mark Monteiro
* Clarify documentation on OIDC_X_FORWARDED_HEADERS * Update docs/en/admins/16_OpenID-Connect.md --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-10-30Require PHP 7.4+ (#5720)Gravatar Alexandre Alapetite
* Require PHP 7.4+ https://github.com/FreshRSS/FreshRSS/discussions/5474 * Update Docker oldest Alpine 3.13 with PHP 7.4.26 * Add missing packets to Docker oldest * Update to typed properties https://php.net/migration74.new-features#migration74.new-features.core.typed-properties * More types
2023-10-30Release 1.22.11.22.1Gravatar Alexandre Alapetite
2023-10-27OIDC_SCOPES compatibility colon (#5753)Gravatar Alexandre Alapetite
fix https://github.com/FreshRSS/FreshRSS/issues/5744
2023-10-25Create "Authentik" specific OIDC configuration. (#5746)Gravatar XtremeOwnage
* Create 16_OpenID-Connect-Authentik.md * Local images + text improvements --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-10-25Use RemoteIPInternalProxy directive of remoteip Apache module (#5740)Gravatar Mossroy
* Use RemoteIPInternalProxy directive of remoteip Apache module instead of RemoteIPTrustedProxy directive To allow internal IPs to be trusted: for internal clients, and also for the case of chained internal reverse-proxies Fixes #5726 * One last reference forgotten --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-10-24Note about OpenID Connect only for x64 (#5730)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/5722
2023-10-08Minor update dependencies (#5693)Gravatar Alexandre Alapetite
* Minor update dependencies Follow-up of https://github.com/FreshRSS/FreshRSS/pull/5691 Mostly dev dependencies; nothing that affects our runtime * Update versions for GitHub Actions * Fix newly found typos * Fix exclude path
2023-09-10add oidc callback URL and hints for Authelia to docs (#5646)Gravatar Balazs Keresztury
2023-08-15Add Hungarian language (#5589)Gravatar FromTheMoon
* Add Hungarian language * Fixed missing lines in Hungarian translation
2023-08-05[docs] Fix typos on the word 'scrape' and its variations (#5567)Gravatar Steve Jones
* Fix typos on the word 'scrape' and its variations * Fix spelling of 'Tipps'
2023-07-30Rework trusted proxies (#5549)Gravatar Alexandre Alapetite
* Rework trusted proxies Fix https://github.com/FreshRSS/FreshRSS/issues/5502 Follow-up of https://github.com/FreshRSS/FreshRSS/pull/3226 New environment variable `TRUSTED_PROXY`: set to 0 to disable, or to a list of trusted IP ranges compatible with https://httpd.apache.org/docs/current/mod/mod_remoteip.html#remoteiptrustedproxy New internal environment variable `CONN_REMOTE_ADDR` to remember the true IP address of the connection (e.g. last proxy), even when using mod_remoteip. Current working setups should not observe any significant change. * Minor whitespace * Safer trusted sources during install Rework of https://github.com/FreshRSS/FreshRSS/pull/5358 https://github.com/FreshRSS/FreshRSS/issues/5357 * Minor readme
2023-07-16Add OIDC_X_FORWARDED_HEADERS environment variable (fixes #5516) (#5523)Gravatar otaconix
* Add OIDC_X_FORWARDED_HEADERS environment variable (fixes #5516) The mod_auth_oidc needs an additional directive (`OIDCXForwardedHeaders`) in case FreshRSS is running behind a reverse proxy, so it knows what host, protocol and port were used to access it. This information is then used in the `redirect_uri` when directing the user agent (browser) to the identity provider for authentication. Please note that, if you are running FreshRSS behind a reverse proxy that handles TLS, you may need to update your identity provider's configuration so it accepts `https://...` as a `redirect_uri`. * Add link to mod_auth_openidc's documentation for the OIDCXForwardedHeaders Apache configuration directive * Minor spelling --------- Co-authored-by: Stefan Zwanenburg <stefan@zwanenburg.info> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-07-05New extension hook entry_auto_read (#5505)Gravatar Alexandre Alapetite
* New extension hook entry_auto_read For extensions to be notified of articles being automatically marked as read for various reasons * Documentation + entry_auto_unread
2023-06-30Allow choosing the OIDC remote user claim and scopes to request from the ↵Gravatar otaconix
identity provider (#5481) * Allow choosing the OIDC remote user claim and scopes to request from the identity provider * Added comment to explain how checking whether an environment variable is set is done * Use apostrophe's instead of single quotes for verb contractions in docs * Move variables used for checking presence of environment variables inside IfDefine block
2023-06-26docs: web scrapping with XPath (#5494)Gravatar maTh
* added docs * add correct link * typo * A bit of typography --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-06-25docs: add deep links (#5493)Gravatar maTh
* add deep links * Update docs/en/index.md Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-06-20added: new sharing service: Omnivore (#5477)Gravatar maTh
* add Omnivore * fix i18n * Update app/i18n/en/gen.php Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-06-18Update dev dependencies (#5478)Gravatar Alexandre Alapetite
2023-06-12Add OpenID Connect (#5351)Gravatar Aaron Schif
* Add OIDC * Update documentation. * Update apache conf adding IfModule * Use IfDefine for OIDC in apache conf * Fix non-oidc support * Fix typing * Use IfDefine to enable OIDC * Add OIDC support to all dockerfiles * Re add apache Require option * Fixes and documentation * A few more fixes * A bit more doc * Change type of environment variable * Update readme * Correct apache config for OIDC support. * Fix README formatting * Update oidc control path * Fix oidc endpoint being cached * A bit more review * Simplify ExpiresActive * Add session refresh and improve caching * Allow more different setups * A bit more documentation * A bit more readme --------- Co-authored-by: Aaron Schif <aschif@netdevgroup.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: maTh <math-home@web.de>
2023-06-12Remove core extensions Google Groups and Tumblr (#5457)Gravatar Alexandre Alapetite
* Remove core extensions Google Groups and Tumblr * Google Groups seems to have remove support for RSS/ATOM https://github.com/FreshRSS/FreshRSS/pull/2838 (see e.g. https://www.theregister.com/2021/08/16/google_groups_rss/ ) * Tumblr seems to have fixed their RSS/ATOM post-GDPR https://github.com/FreshRSS/FreshRSS/pull/1924 So for both of thems, the extensions have become irrelevant. * Cleaning
generated by cgit v1.2.3 (git 2.39.1) at 2026-02-10 14:58:19 +0000