Commit Graph

231 Commits

Author SHA1 Message Date
Alexandre Alapetite
618ce380e7 More WebSub doc (#5862)
* 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-14 23:28:01 +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
Alexandre Alapetite
44a7c54a5a Update WebSub documentation a bit (#5829)
* Update WebSub documentation a bit

* Marien prefers not to promote his hub too much :-)
2023-11-08 20:24:24 +01:00
François-Xavier Payet
e6c5054922 Add link to Authentik Integrations Documentation (#5828) 2023-11-07 15:35:31 +01:00
Benjamin Reich
8f07199777 add multi arch docker build (#5808)
* 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-11-05 22:46:01 +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
cc2878aed8 Release 1.22.1 2023-10-30 19:48:26 +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
Alexandre Alapetite
13a1c412df Minor update dependencies (#5693)
* 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-10-08 20:19:17 +02:00
Balazs Keresztury
f470724c6e add oidc callback URL and hints for Authelia to docs (#5646) 2023-09-10 15:36:14 +02:00
FromTheMoon
6749adc050 Add Hungarian language (#5589)
* Add Hungarian language

* Fixed missing lines in Hungarian translation
2023-08-15 11:18:47 +02:00
Steve Jones
8f188b57ee [docs] Fix typos on the word 'scrape' and its variations (#5567)
* Fix typos on the word 'scrape' and its variations

* Fix spelling of 'Tipps'
2023-08-05 13:54:09 +02:00
Alexandre Alapetite
e7689459f2 Rework trusted proxies (#5549)
* 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-30 12:59:18 +02:00
otaconix
a066be93b0 Add OIDC_X_FORWARDED_HEADERS environment variable (fixes #5516) (#5523)
* 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-16 14:50:42 +02:00
Alexandre Alapetite
1db606bc1b New extension hook entry_auto_read (#5505)
* 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-07-05 11:00:26 +02:00
otaconix
fc579bd2bc Allow choosing the OIDC remote user claim and scopes to request from the 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-30 12:58:20 +02:00
maTh
2f48509678 docs: web scrapping with XPath (#5494)
* added docs

* add correct link

* typo

* A bit of typography

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-06-26 23:28:24 +02:00
maTh
666e951fa3 docs: add deep links (#5493)
* 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-25 00:17:02 +02:00
maTh
fca8ae4207 added: new sharing service: Omnivore (#5477)
* 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-20 09:06:23 +02:00
Alexandre Alapetite
8bf362838e Update dev dependencies (#5478) 2023-06-18 23:05:28 +02:00
Aaron Schif
58b254f9cb Add OpenID Connect (#5351)
* 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-12 10:22:46 +02:00
Alexandre Alapetite
2f5ef39cf2 Remove core extensions Google Groups and Tumblr (#5457)
* 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
2023-06-12 08:22:02 +02:00
maTh
b1d55b8de3 fix: docs: array syntax (#5392) 2023-05-11 23:26:20 +02:00
maTh
2343f0ded1 Docs: delete 04_Changing_source_code.md (#5391)
* delete 04_Changing_source_code.md

* make pot

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-05-11 08:32:19 +02:00
maTh
54c8de86c7 docs: language table added (#5375)
* docs: language table added

* Update 05_Configuration.md

* Update 05_Configuration.md

* french docs

* Unicode quote and a few fixes
(Same search&replace aslo applied to a few other files)

---------

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-05-07 21:35:08 +02:00
maTh
2f53214c15 Flat theme: un-deprecate (#5316)
* Update metadata.json

* Update 05_Configuration.md
2023-04-19 22:40:36 +02:00
maTh
5f33ca921a add Buffer.com as sharing service (#5286)
* add Buffer as sharing service

* docs

* add link the the sharing services list
2023-04-12 00:00:54 +02:00
Alexandre Alapetite
6c01e4e7d6 Use typed access to request parameters (#5267)
* Use typed access to request parameters
This was a big source of mixed datatypes in many places

* Fix notifications

* Fix bookmarkAction
2023-04-07 00:13:49 +02:00
Alexandre Alapetite
4f957dfc4c Doc git latest (#5148)
#fix https://github.com/FreshRSS/FreshRSS/issues/4949
2023-02-28 08:11:27 +01:00
maTh
859c48383a docs: Minz Framwork (#5102)
* done

* Update docs/fr/developers/Minz/index.md

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2023-02-23 22:20:36 +01:00
mincerafter42
60edc28528 Corrected frss:xPathItemTitle definition (#5140) 2023-02-23 20:14:55 +01:00
Alexandre Alapetite
05ae1b0d26 XML+XPath (#5076)
* XML+XPath
#fix https://github.com/FreshRSS/FreshRSS/issues/5075
Implementation allowing to take an XML document as input using an XML parser (instead of an HTML parser for HTML+XPath)

* Remove noise from another PR

* Better MIME for XML

* And add glob *.xml for cache cleaning

* Minor syntax

* Add glob json for clean cache
2023-02-09 13:57:20 +01:00
Alexandre Alapetite
e899e4edd9 More robust application of access permissions (#5062)
* More robust application of access permissions
We were in particular missing directory traversal `+X` in our current recommendations.
Extracted to own shell script so it can easily be invoked.
Update access permissions in Docker to account to be more robust.
#fix https://github.com/FreshRSS/FreshRSS/discussions/5037

* Minor simplification

* Restrict mkdir permissions
Default mkdir permissions are 0777, which is not good for security, so downgrade to 0770.
2023-02-06 15:42:53 +01:00
Alexandre Alapetite
de2077b563 Increase max HTTP timeout (#5074)
* Increase maximum HTTP request timeout from 2 minutes to 15 minutes;
    * Reason: I have some RSS Bridge generating feeds, which can take several minutes.

* Increase default HTTP request timeout from 15 to 20s.
    * Reason: I regularly observe feeds, which are slow to answer.
2023-02-06 14:11:41 +01:00
Alexandre Alapetite
2303b29e68 Document cleaning the logs for passwords (#5050)
Follow up of https://github.com/FreshRSS/FreshRSS/pull/5001
2023-01-28 23:15:28 +01:00
maTh
216e39c3cc Docs: Explain the "Do not automatically refresh more often than" (#5017)
* reordering, config, TOC

* fix markdownlint

* fix
2023-01-17 23:41:49 +01:00
maTh
0ab130eb9c Added: Mark theme as deprecated (#4807)
* i18n + config

* docs

* deprecated marked themes

* fix

* fix markdown

* i18n: fix link params

* i18n: French

* deprecated => no longer supported

* i18n: German

* Docs: deprecated => no longer supported

* Docs: French

* i18n: en-us

* i18n German

* isset() -> !empty()

* i18n: fix German

* i18n: English, delete // TODO
2023-01-17 15:39:55 +01:00
maTh
e67ca8c866 documentation improved: split en/users/03_Main_view.md into 3 parts (#5013)
* documentation

* update the links

* fix
2023-01-17 15:36:43 +01:00
Alexandre Alapetite
1d9d4e3e3c Update dev dependencies (#4993)
Related to https://github.com/FreshRSS/FreshRSS/pull/4991
Required a few changes in code to pass the tests
2023-01-09 12:59:30 +01:00
Alexandre Alapetite
3fb8ab8eb5 Handling of parentheses as special characters in searches (#4989)
#fix https://github.com/FreshRSS/FreshRSS/issues/4987
2023-01-09 12:59:09 +01:00
Sadetdin EYILI
de5f70c684 docs: fix formating (#4968)
Replace apostrophe backtick
2022-12-29 18:48:17 +01:00
Alexandre Alapetite
570503b7f1 Require PHP 7.2+ (#4848)
Drop PHP 7.0- as planned https://github.com/FreshRSS/FreshRSS/discussions/3321#discussioncomment-835704
2022-11-14 15:02:44 +01:00
Alexandre Alapetite
4571b7d68d Fix broken doc fr links (#4846)
Were pointing to `.md` files
2022-11-14 14:04:26 +01:00