aboutsummaryrefslogtreecommitdiff
path: root/docs/en/admins
AgeCommit message (Collapse)Author
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
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-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-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
2023-05-07docs: language table added (#5375)Gravatar maTh
* 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-02-28Doc git latest (#5148)Gravatar Alexandre Alapetite
#fix https://github.com/FreshRSS/FreshRSS/issues/4949
2023-02-06More robust application of access permissions (#5062)Gravatar Alexandre Alapetite
* 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-01-28Document cleaning the logs for passwords (#5050)Gravatar Alexandre Alapetite
Follow up of https://github.com/FreshRSS/FreshRSS/pull/5001
2023-01-17documentation improved: split en/users/03_Main_view.md into 3 parts (#5013)Gravatar maTh
* documentation * update the links * fix
2023-01-09Update dev dependencies (#4993)Gravatar Alexandre Alapetite
Related to https://github.com/FreshRSS/FreshRSS/pull/4991 Required a few changes in code to pass the tests
2022-11-14Require PHP 7.2+ (#4848)Gravatar Alexandre Alapetite
Drop PHP 7.0- as planned https://github.com/FreshRSS/FreshRSS/discussions/3321#discussioncomment-835704
2022-08-29doc: Add recommendations for manual updates (#4557)Gravatar berumuron
2022-08-29Improve documentation: example code to configure SMTP (#4555)Gravatar maTh
* add example code * just a changed line break * fix * Fix Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-08-21Improved: error page (#4465)Gravatar maTh
* error page: true HTML page * error page: http500 erorr * error page: add CSP header * 'log.txt' replaced by LOG_FILENAME * use ADMIN_LOG * log.txt => LOG_FILENAME * error message: add <title> * Docs created * delete: documentation on error message page * line break added * added: new line at the end * typo fixed * Update lib/lib_rss.php Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Update lib/lib_rss.php Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Minz HTTP 500 Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-08-18Easier full-text search possibility (#4505)Gravatar Alexandre Alapetite
* Easier full-text search possibility Contributes to https://github.com/FreshRSS/FreshRSS/issues/1331 Avoid concats in searches to make text indexes easier to build * Fix tests * Documentation
2022-08-05Add link to CHATONS list of FreshRSS instances (#4483)Gravatar Alexandre Alapetite
2022-05-23Custom logo HTML (#4369)Gravatar Alexandre Alapetite
* Custom logo HTML Add option for custom HTML logo/title in the main Web UI view. Can potentially be different per user. #fix https://github.com/FreshRSS/FreshRSS/pull/3830/files#r850472247 * logo_html in main config With new `./data/config.custom.php` to provide custom values before install * Docker documentation * whitespace * Auto relax CSP to allow images for HTML logo * Documentation
2022-04-11Docs: improve backup section (#4290)Gravatar maTh
* Update 05_Backup.md * Update 05_Backup.md * Update docs/en/admins/05_Backup.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/admins/05_Backup.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/admins/05_Backup.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/admins/05_Backup.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2022-04-02Add HTTP_REMOTE_USER header for auth (#4063)Gravatar drosoCode
* add HTTP_REMOTE_USER header for auth * add ip whitelist for HTTP_REMOTE_USER header * add IPv6 support for header auth * fix formatting * A few fixes * Add some default trusted sources * Fix IPv6 doc * More standard header names Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-03-22Docs: information about extensions (#4281)Gravatar maTh
* first draft * Update docs/en/admins/15_extensions.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/admins/15_extensions.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/admins/15_extensions.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/admins/15_extensions.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update 15_extensions.md * Update docs/en/admins/15_extensions.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/admins/15_extensions.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/admins/15_extensions.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update 15_extensions.md * Update 15_extensions.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2022-03-02Cloud Providers page (#4247)Gravatar Nicolas Ferrari
2022-01-08Use typographic quotes (#4133)Gravatar Alexandre Alapetite
* Use typographic quotes * A few fixes * Fix * Fix not saved * Implement feedback * Detail * Revert spoken English fixes Left for a future dedicated discussion * More reverts * Final reverts * Final minor
2022-01-08Fix various typos and spelling errors in documentation, comments and code. ↵Gravatar Thomas Renes
(#4134)
2021-12-26Improved manual: User Management/User registration (#4083)Gravatar maTh
* Draft 1 of Default User page * Draft1 of User Management page * Update 01_Index.md * Update 12_User_management.md * fix failing pipeline * Apply suggestions from code review Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-12-23Correct cron example (#4079)Gravatar 4xfu
The old example was inaccurate. crontab on Debian does not support a user name, but files in /etc/cron.d and /etc/crontab do (see https://manpages.debian.org/bullseye/cron/crontab.5.en.html) According to https://manpages.debian.org/bullseye/cron/cron.8.en.html : In general, the system administrator should not use /etc/cron.d/, but use the standard system crontab /etc/crontab so I propose to append the line to this file
2021-10-25Add a reminder for NGINX installations (#3741) (#3934)Gravatar Kaibin Yang
Update docs/en/admins/03_Installation.md
2021-10-23Improved markdownlint (#3918)Gravatar Alexandre Alapetite
* Improved markdownlint * Relaxed rules slighlty * `npm run markdownlint` for automatic tests * `npm run markdownlint_fix` for automatic syntax fixing * Applied the fixes on all our Markdown files
generated by cgit v1.2.3 (git 2.39.1) at 2026-03-11 22:18:38 +0000