aboutsummaryrefslogtreecommitdiff
path: root/docs/en/admins
AgeCommit message (Collapse)Author
2026-01-17Update documentation in regards to CSP warnings (#8439)Gravatar Thomas Hufschmidt
* Add a reference to the check where the warning is triggered Note: This is the place where the admin sees the browser pointing to. Adding this information here allows the admin to find the matching documentation entry. * Update Content-Security-Policy section of english ServerConfig documentation Note: This fixes some minor formating/typping issues and adds some clarity to the fact that this warning is also triggered on correctly configured hosts, simply due to the nature of how correctness of CSP rules are checked. * Move CSP infor source-code comment into console.info Note: Improve visibility of why this is happening. * Point towards static website documentation instead of git This URL should also remain more fixed even accross new branches/releases. Co-authored-by: Inverle <inverle@proton.me> * Minor fixes * Remove overwrite part --------- Co-authored-by: Inverle <inverle@proton.me> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2026-01-05Document mounting own CA on FreshRSS container (#8406)Gravatar netsho
closes https://github.com/FreshRSS/FreshRSS/issues/8405 - Add documentation on how to trust own CA that issued self-signed certificate as authentik signing key - Add example in Docker Example How to test the feature manually: 1. Create your own CA 2. Issue a certificate 3. Use the issued certificate as a signing-key in authentik when configuring FreshRSS provider 4. Add created CA on host's CA store by running `update-ca-certificates` 5. Mount the `/etc/ssl/certs/ca-certificates.crt` file on FreshRSS container 6. Start the container 7. Navigate to FreshRSS in the browser 8. Authentik login form should be displayed and work as normal.
2025-11-26Fix MariaDB updateCachedValues (#8255)Gravatar Alexandre Alapetite
Changed syntax for an even wider compatibility. Follow-up of https://github.com/FreshRSS/FreshRSS/pull/8254 Regression from https://github.com/FreshRSS/FreshRSS/pull/6957 MariaDB images on Docker Hub go back to 10.6, so changed documentation to indicate support from that version, as I cannot easily test even older versions.
2025-11-02Implement whitelist for SimplePie sanitizer (#7924)Gravatar Inverle
* Implement whitelist for SimplePie sanitizer ref: https://github.com/FreshRSS/FreshRSS/pull/7770#issuecomment-3140334326 https://github.com/FreshRSS/simplepie/pull/53 https://github.com/simplepie/simplepie/pull/947 * Remove `<plaintext>` from whitelist * Improve order * Remove some tags from whitelist * Revert partially * sync * Display contents of `<noscript>` and `<noembed>` * sync * Allow use of `<track>` * sync again * Sync to SimplePie fork https://github.com/FreshRSS/simplepie/pull/53 * Alphabetic order * Reduce list of stripped attributes * Temporarily strip some attributes --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2025-08-15Should be REMOTE_USER not Remote-User (#7828)Gravatar triatic
For fastcgi, REMOTE_USER is the correct variable.
2025-08-09Show warning when unsafe CSP policy is in use (#7804)Gravatar Inverle
* Show warning when unsafe CSP policy is in use * Fix bare markdown URL * i18n: fr * Minor i18n: fr * Add target="_blank" to i18n strings --------- Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2025-06-18Fix Markdown 78a4256 (#7678)Gravatar Alexandre Alapetite
Fix for https://github.com/FreshRSS/FreshRSS/commit/78a425636228066513bf14c7f74f6255062b2327
2025-06-18Merge commit from forkGravatar ghostvirus
2025-06-03Add API endpoint for extensions (#7576)Gravatar Alexandre Alapetite
* Add API endpoint for extensions Useful for https://github.com/FreshRSS/FreshRSS/issues/7572 * Support PATH_INFO Now also support being invoked like `/api/misc.php/Extension%20Name/` * More documentation
2025-06-01Bump markdownlint-cli from 0.44.0 to 0.45.0 (#7632)Gravatar dependabot[bot]
* Bump markdownlint-cli from 0.44.0 to 0.45.0 Bumps [markdownlint-cli](https://github.com/igorshubovych/markdownlint-cli) from 0.44.0 to 0.45.0. - [Release notes](https://github.com/igorshubovych/markdownlint-cli/releases) - [Commits](https://github.com/igorshubovych/markdownlint-cli/compare/v0.44.0...v0.45.0) --- updated-dependencies: - dependency-name: markdownlint-cli dependency-version: 0.45.0 dependency-type: direct:development update-type: version-update:semver-minor ... Signed-off-by: dependabot[bot] <support@github.com> * 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>
2025-05-07Remove Apache 2.2 (only support Apache 2.4+) (#7561)Gravatar Alexandre Alapetite
Follow-up of https://github.com/FreshRSS/FreshRSS/pull/7552 I cannot find any distribution still supporting Apache 2.2
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-02-23Release 1.26.01.26.0Gravatar Alexandre Alapetite
2025-02-19Docker Compose remove deprecated version (#7309)Gravatar Alexandre Alapetite
Minor doc
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-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-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-09-11Minor doc requirements (#6795)Gravatar Alexandre Alapetite
* Minor doc requirements * Uniformisation
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-07-08Update composer shfmt typos (#6614)Gravatar Alexandre Alapetite
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-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-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-03 docs: Update 02_Prerequisites.md (Apache + PHP version) (#6148)Gravatar maTh
* apache version + php version * format
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-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-07Add link to Authentik Integrations Documentation (#5828)Gravatar François-Xavier Payet
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-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-09-10add oidc callback URL and hints for Authelia to docs (#5646)Gravatar Balazs Keresztury
generated by cgit v1.2.3 (git 2.39.1) at 2026-02-10 13:17:42 +0000