aboutsummaryrefslogtreecommitdiff
path: root/docs
AgeCommit message (Collapse)Author
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-05-19Fix doc anchor (#4376)Gravatar Alexandre Alapetite
* Fix doc anchor The "search an article" link lead to a dead anchor https://freshrss.github.io/FreshRSS/en/users/02_First_steps.html * Fix wording
2022-05-12Refactor OPML export categories (#4356)Gravatar Alexandre Alapetite
* Refactor OPML export categories Simplify code to comply with types hints. And renamed a property to plural. * Link to OPML namespace
2022-05-12OPML export/import of some proprietary FreshRSS attributes (#4342)Gravatar Alexandre Alapetite
* OPML export/import of some proprietary FreshRSS attributes #fix https://github.com/FreshRSS/FreshRSS/issues/4077 And one of the TODOs of https://github.com/FreshRSS/FreshRSS/pull/4220 XPath options, CSS Selector, and action filters * Bump library patch version * OPML namespace + documentation * Add example
2022-05-09Better documentation online cron (#4355)Gravatar Alexandre Alapetite
* Better documentation online cron #fix https://github.com/FreshRSS/FreshRSS/pull/3637#issuecomment-849073249 #fix https://github.com/FreshRSS/FreshRSS/issues/1676 * Forgotten line * Simplify examples * Rework structure slightly * More clarifications
2022-04-24Update 06_Mobile_access.md (#4325)Gravatar maTh
* Update 06_Mobile_access.md * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
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-15Improved: Sharing/Integration configuration (#4269)Gravatar maTh
* stick plus button to select list * HTML improved very much * drag and drop improved * add URL button * fix remove button behavior * prepare for PR#4238 * improve length of inputs * First draft of documentation of the sharing services * new config option: depricated * i18n for depricated text * Doc: Blogotext depricated to 2023 * dropdown menu with config link and depricated sign * Update entry_bottom.phtml * Update 08_sharing_services.md * Update template.rtl.css * Typo Deprecated/Depricated * typo * updated the documentation comment * Update shares.php * Update app/i18n/fr/conf.php Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Update p/scripts/draggable.js Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Update p/scripts/draggable.js Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> * Documentation: services from #4270 Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-03-08Documentation: added information about code checks (#4266)Gravatar maTh
* Update 02_First_steps.md * Update 02_First_steps.md * Update 02_First_steps.md * Update 02_First_steps.md * Update 02_First_steps.md
2022-03-06News+ use GitHub links (#4262)Gravatar Alexandre Alapetite
Google Play links do not work anymore
2022-03-02Cloud Providers page (#4247)Gravatar Nicolas Ferrari
2022-02-28Update markdownlint-cli dev dependency (#4241)Gravatar Alexandre Alapetite
* Update markdownlint-cli dev dependency And fix https://github.com/advisories/GHSA-6vfc-qv3f-vr6c * npm ci
2022-02-27Documentation improved: mobile access (#4235)Gravatar maTh
* Update 06_Mobile_access.md * Readme: Windows + MacOS * fix markdown * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * MacOS -> macOS * Update 06_Mobile_access.md * Update docs/en/users/06_Mobile_access.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2022-02-04Update dev dependencies stylelint SASS (#4173)Gravatar Alexandre Alapetite
* Update dev dependencies stylelint SASS Major update for stylelint with breaking changes https://stylelint.io/migration-guide/to-14/ Applied automatic SASS migration to current syntax https://sass-lang.com/documentation/cli/migrator#migrations And a few manual fixes such as: https://github.com/stylelint-scss/stylelint-scss/blob/master/src/rules/dollar-variable-no-missing-interpolation/README.md Other dev dependencies are minor updates. * RTLCSS * Fix color-hex-length bug * Implement make bin/composer * Update git hash
2022-01-21Fixup #3991 (#3992)Gravatar xnaas
* fixup #3991 * add xnaas to CREDITS.md * Update docs/en/users/03_Main_view.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * fix typo * Update docs/en/users/03_Main_view.md The lines were combined into one line and `'` was replaced with `’` for contracted words. Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr> Co-authored-by: maTh <math-home@web.de> Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
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)
2022-01-08Change i18n process (#4131)Gravatar Alexis Degrugillier
Before, the ignore info were stored in a different file which was a bit cumbersome for new comers. Now, this info is stored directly in the translation file as a comment. Before, there was no way of telling translators that a previously translated string was in need of a new translation. Now, the dirty information is there to convey that info.
2022-01-04PHPStan level 5 (#4110)Gravatar Alexandre Alapetite
* Fix most PHPDocs errors Contributes to https://github.com/FreshRSS/FreshRSS/issues/4103 https://phpstan.org/writing-php-code/phpdoc-types * Avoid func_get_args Use variadic syntax instead https://php.net/manual/functions.arguments#functions.variable-arg-list And avoid dynamic functions names when possible to more easily identify calls and unused functions. Contributes to https://github.com/FreshRSS/FreshRSS/issues/4103 * PHPStan level 3 * PHPStand level 4 * Update default to PHPStan level 4 * Towards level 5 * Fix level 4 regression * Towards level 5 * Pass PHPStan level 5 * Towards level 6 * Remove erronenous regression from changelog https://github.com/FreshRSS/FreshRSS/pull/4116
2021-12-31Search on article IDs (#4058)Gravatar Alexandre Alapetite
* Search on article IDs Partial implementation of https://github.com/FreshRSS/FreshRSS/issues/4053
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-12-20Improved: Manual: username+pw for demo login (#4072)Gravatar maTh
* added: username+pw for demo login * fix white spaces
2021-12-10Update 02_First_steps.md (#4049)Gravatar happymacarts
spelling correction of "available"
2021-11-24Fix typo of 'envelope' and reference De Morgan's laws (#3991)Gravatar xnaas
2021-11-02Remove remains of Travis (#3941)Gravatar Alexandre Alapetite
* Remove remains of Travis Follow-up of https://github.com/FreshRSS/FreshRSS/pull/3920 * Update docs/en/developers/03_Running_tests.md Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> * Apply suggestions from code review Co-authored-by: Frans de Jonge <fransdejonge@gmail.com> Co-authored-by: Alexis Degrugillier <aledeg@users.noreply.github.com>
2021-10-25Add a reminder for NGINX installations (#3741) (#3934)Gravatar Kaibin Yang
Update docs/en/admins/03_Installation.md
2021-10-24Hot fix broken links documentationGravatar Alexandre Alapetite
Bug from https://github.com/FreshRSS/FreshRSS/pull/3905
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
2021-10-23Split fever & greader into two separate pages. (#3905)Gravatar Felix Bühler
* [docs] add newsflash to fever-clients * [docs] split fever&greader-apis into two pages and make the more consistent
2021-10-23Update Korean Translation with language code fix (#3914)Gravatar OctopusET
* Update Korean Translation * Fix Korean language code following IETF BCP 47 * Fix Korean language code in i18n/*/gen.php * Fix Korean language code in cli/i18n/* * Fix Korean language code in docs Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-08-30Fix documentation typo (#3810)Gravatar Alexis Degrugillier
See #3809
2021-08-20docs (#3784)Gravatar maTh
2021-08-14Fix docs link to dev themes (#3746)Gravatar maTh
* link fixed * fix2
2021-07-24Search labels (#3709)Gravatar Alexandre Alapetite
* Search labels #fix https://github.com/FreshRSS/FreshRSS/issues/3704 * Documentation * Allow list without quotes * Allow boolean AND searches * Allow searching any label * fix labels alias
2021-07-11Add system configuration for extension (#3626)Gravatar Alexis Degrugillier
Before, only the user configuration was supported by extensions. But it was limiting if one has to create a system extension with configuration. Now, both user and system configuration are supported.
2021-06-29[docs] Fix typo in server requirements (#3681)Gravatar Frans de Jonge
2021-06-07Drop PHP5 and IE11 (#3666)Gravatar Alexandre Alapetite
* Drop PHP5 and IE11 https://github.com/FreshRSS/FreshRSS/discussions/3321 Our Docker :oldest is now based on Alpine 3.5 (2016-12-22) * More uniform * More changelog
2021-06-06Update 08_FeedUpdates.md (#3635)Gravatar marcohald
* Update 08_FeedUpdates.md Added hint to https://freshrss.github.io/FreshRSS/en/users/03_Main_view.html#online-cron * Update docs/en/admins/08_FeedUpdates.md * Update docs/en/admins/08_FeedUpdates.md Co-authored-by: marcohald <marcohald@users.noreply.github.com> Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-05-04Update README.md (#3601)Gravatar Strubbl
* Update README.md Readably is not available anymore * More lines to remove Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-04-08Newsboat support (#3574)Gravatar Petra Lamborn
* Newsboat support Newsboat is a feed reader for the unix-derived terminal, and is the successor to Newsbeuter. FreshRSS support has been merged into master <https://github.com/newsboat/newsboat/commit/f18145fc98700178429cbd137e0309f89ec89d5b> but there has not yet been a release since then. In the meantime I've created this pull request that can be merged whenever it becomes strictly accurate. I've filled out the table to the best of my ability, but I'm not completely clear on what "Fast sync" and "Fetch more in individual views" mean. * Does not work offline with freshrss * More doc Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2021-03-26tec: Remove data/do-install.txt (#3555)Gravatar berumuron
* Remove file data/do-install.txt This file was painful during update because we had to remember to delete it each time. It added a security issue by allowing an attacker to reinstall FreshRSS during the update process. The (more powerful) file data/applied_migrations.txt has been introduced in 8619cf6fa to replace do-install.txt. We had to wait for at least one release in order to make sure existing instances of FreshRSS created the migration file. It should be ok now. * Replace i18n install.not_deleted key * Update documentation to update FreshRSS
2021-03-15Quick update the doc for master renaming to edgeGravatar Alexandre Alapetite
2021-03-10FocusReader (#3514)Gravatar Alexandre Alapetite
2021-02-17Add user maintenance hooks (#3440)Gravatar Alexis Degrugillier
The new hook allows to add maintenance extensions at the user level. See #3398
2021-02-06Theme Documentation (#3415)Gravatar Lukas Vacula
* adding self CREDITS.md * add "theme" to link for easier navigation * add documentation about themes and the files that go in them * add admin documentation for themes * fix markdown styling * fix CSSJanus usage
2021-02-02Add comprehensive user configuration in extensions (#3397)Gravatar Alexis Degrugillier
Before, the extension configuration was handled by its author. There was discrepancies between extensions on how the configuration was stored. Now, we could rely on a single way of storing configuration. This won't invalidate how the extensions are storing their configuration but will allow authors to focus on what is important.
2021-01-13Update extension documentation (#3352)Gravatar Alexis Degrugillier
Before the extension documentation was not very clear about the methods in the extension and how to use them. I hope that now it makes more sense.