Commit Graph

110 Commits

Author SHA1 Message Date
Thomas Hufschmidt
2cbb5f8db1 Update documentation in regards to CSP warnings (#8439)
* 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-17 22:28:56 +01:00
netsho
b8656e1df1 Document mounting own CA on FreshRSS container (#8406)
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.
2026-01-05 22:06:09 +01:00
Alexandre Alapetite
5e0093aa00 Fix MariaDB updateCachedValues (#8255)
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-26 23:47:29 +01:00
Inverle
500d05f3c5 Implement whitelist for SimplePie sanitizer (#7924)
* 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-11-02 00:28:35 +01:00
triatic
56df7f826a Should be REMOTE_USER not Remote-User (#7828)
For fastcgi, REMOTE_USER is the correct variable.
2025-08-15 12:15:54 +02:00
Inverle
2b85a50ed7 Show warning when unsafe CSP policy is in use (#7804)
* 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-08-09 21:47:39 +02:00
Alexandre Alapetite
aa45bcbe5a Fix Markdown 78a4256 (#7678)
Fix for 78a4256362
2025-06-18 22:15:54 +02:00
ghostvirus
78a4256362 Merge commit from fork 2025-06-18 21:11:41 +02:00
Alexandre Alapetite
cc35094bb2 Add API endpoint for extensions (#7576)
* 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-03 00:16:17 +02:00
dependabot[bot]
7d86cbe804 Bump markdownlint-cli from 0.44.0 to 0.45.0 (#7632)
* 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-06-01 22:50:58 +02:00
Alexandre Alapetite
f2a7af03e8 Remove Apache 2.2 (only support Apache 2.4+) (#7561)
Follow-up of https://github.com/FreshRSS/FreshRSS/pull/7552
I cannot find any distribution still supporting Apache 2.2
2025-05-07 14:45:43 +02:00
docxml
2567f76950 Update 02_Prerequisites.md (#7448)
* Update 02_Prerequisites.md

Line numbers have varied over time

* Same for fr

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2025-03-22 23:16:20 +01:00
Alexandre Alapetite
df82c23943 Release 1.26.0 2025-02-23 16:15:36 +01:00
Alexandre Alapetite
6c6695b835 Docker Compose remove deprecated version (#7309)
Minor doc
2025-02-19 11:26:07 +01:00
Logan
7e90dfd048 Add documentation for adding Pocket ID as OIDC provider (#7291)
* 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-02-02 21:42:36 +01:00
Alexandre Alapetite
bb7236e263 Better authorization label for OIDC (#7264)
* 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-28 15:33:17 +01:00
Roan-V
700eef13ed Add instructions for serving FreshRSS on a subdomain with Caddy (#7197)
* Add instructions for serving FreshRSS on a subdomain with Caddy

* Fix failing test
2025-01-08 14:45:47 +01:00
Roan-V
fa701b39f3 Simplify the Caddy configuraton (#7194)
* Simplify Caddyfile configuraton

* Fix missing bracket :)

* Fix failing test
2025-01-08 08:40:50 +01:00
ShaddyDC
7d3490a079 doc(openid-connect): Add initial setup instructions (#7174)
* 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>
2025-01-06 10:30:42 +01:00
aftix
84f75e487c doc(openid-connect): clarify that OIDC is only supported for the Apache web 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-23 22:16:07 +01:00
davralin
5900f8e198 doc(docker-cron): duplicate documentation from README to the official docs (#7127) 2024-12-21 23:53:39 +01:00
Luc SANCHEZ
15745d42b7 Upgrade code to php 8.1 (#6748)
* 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-28 17:11:04 +01:00
Alexandre Alapetite
e5320759eb Minor doc requirements (#6795)
* Minor doc requirements

* Uniformisation
2024-09-11 17:15:27 +02:00
Alexandre Alapetite
1a552bd60e Regex search (#6706)
* 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-06 09:35:58 +02:00
Alexandre Alapetite
a81656c3ed Upgrade to PHP 8.1 (#6711)
* 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-06 09:06:46 +02:00
Alexandre Alapetite
2cd9130726 PostgreSQL suggestion of index improvement (#6705)
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-09-06 08:50:31 +02:00
Alexandre Alapetite
8ca70040b9 OIDC changelog + minor whitespace
+fix minor whitespace from https://github.com/FreshRSS/FreshRSS/pull/6730
2024-08-26 09:49:11 +02:00
pando85
82593f5968 Fix OIDC session params definition (#6730)
* 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-25 19:57:30 +02:00
Alexandre Alapetite
d56d791baf Update composer shfmt typos (#6614) 2024-07-08 12:00:58 +02:00
Shane Redman
8e3bfa1a47 Docs: fix minor typo in 09_AccessControl.md (#6465) (#6466)
chose -> choose
2024-05-15 21:38:39 +02:00
Alexandre Alapetite
2ed91026fc Correct casing for GitHub (#6460) 2024-05-15 08:58:10 +02:00
maTh
cd66ca54ca Docs: hidden configs (#6402)
* 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-05-01 14:01:40 +02:00
Alexandre Alapetite
329fd4bcf6 CLI database backup and restore (#6387)
* 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-30 08:31:13 +02:00
Frans de Jonge
e19b8a4e0a Add some error prevention to Debian/Ubuntu installation docs (#6290)
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-12 23:19:23 +02:00
Soniya Prasad
9d48121e05 Update documentation for Caddy reverse proxy with subfolder (#6219)
* 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-30 19:35:00 +01:00
maTh
da43fff437 docs: Update 02_Prerequisites.md (Apache + PHP version) (#6148)
* apache version + php version

* format
2024-03-03 22:34:28 +01:00
laxmanpradhan
77108ea19e Authentik oAuth setup documentation updates (#5969)
* 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-30 23:45:31 +01:00
Alexandre Alapetite
386c982443 Doc Web git update (#5995)
https://github.com/FreshRSS/FreshRSS/discussions/5991
2023-12-29 13:36:43 +01:00
maTh
2b8b80a5a9 Docs: How to contribute new theme (#5863)
* Update 05_Configuration.md

* Update 11_Themes.md

* Update contributing.md

* Update 02_Design.md

* fix

---------

Co-authored-by: math-gh <>
2023-11-12 21:56:14 +01:00
Joe Stump
641b891972 Fix trusted cidrs check (#5853)
* 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-11 08:40:51 +01:00
François-Xavier Payet
e6c5054922 Add link to Authentik Integrations Documentation (#5828) 2023-11-07 15:35:31 +01:00
Alexandre Alapetite
5a383c1054 Update DB recommendations (#5793)
* 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-31 23:37:16 +01:00
Alexandre Alapetite
0234f4e40b Document Apache 2.4+ (#5791)
And avoid crash in Apache 2.2 anyway
fix https://github.com/FreshRSS/FreshRSS/issues/5790
2023-10-31 12:27:32 +01:00
Mark Monteiro
6fd1195f95 Clarify documentation on OIDC_X_FORWARDED_HEADERS (#5789)
* 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-31 11:13:53 +01:00
Alexandre Alapetite
06d0099504 Require PHP 7.4+ (#5720)
* 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-30 20:47:27 +01:00
Alexandre Alapetite
ce6ba583be OIDC_SCOPES compatibility colon (#5753)
fix https://github.com/FreshRSS/FreshRSS/issues/5744
2023-10-27 15:26:39 +02:00
XtremeOwnage
a9a7643e71 Create "Authentik" specific OIDC configuration. (#5746)
* Create 16_OpenID-Connect-Authentik.md

* Local images + text improvements

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-10-25 22:30:14 +02:00
Mossroy
5374df384a Use RemoteIPInternalProxy directive of remoteip Apache module (#5740)
* 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-25 16:23:03 +02:00
Alexandre Alapetite
bfdf7b05ca Note about OpenID Connect only for x64 (#5730)
https://github.com/FreshRSS/FreshRSS/issues/5722
2023-10-24 11:54:37 +02:00
Balazs Keresztury
f470724c6e add oidc callback URL and hints for Authelia to docs (#5646) 2023-09-10 15:36:14 +02:00