aboutsummaryrefslogtreecommitdiff
path: root/README.md
AgeCommit message (Collapse)Author
2020-05-15Table overview of compatible clients (Help welcome) (#2942)Gravatar Alexandre Alapetite
* Table overview of compatible clients I found it difficult - especially for newcomers - to find and pick a client, and I believe a table would help. Help welcome to fill-in the blancs. * Use ➖ Instead of ❌ * A bit more info on Unread * FeedMe 3.15 FeedMe 3.15 beta added support for Podcasts in FreshRSS :-) * A bit of re-ordering * FeedMe partial support of labels * A bit for Reeder * Reeder, Augier * French version
2020-02-13Add Readrops app in README (#2798)Gravatar Corentin Garcia
2019-12-15Make master the rolling release branch (#2705)Gravatar Marien Fressinaud
* Change default TAG in Makefile We are going to drop the `dev` branch. The Docker tag `dev-*` are based on this branch and so there will be no longer be generated. We must use images based on the `master` branch (i.e. `latest`, `alpine` and `arm`). * Remove references to dev branch in documentation * Synchronize French documentation
2019-12-03Fix doc links (#2685)Gravatar Alexandre Alapetite
Many broken links. Related to https://github.com/FreshRSS/FreshRSS/pull/2614
2019-10-29Update link in the README (#2614)Gravatar Alexis Degrugillier
Website seems dead. Changed by repository URL. See #2613
2019-10-26Reeder client for MacOs and iOS (#2594)Gravatar Yamakuni
* Update README.md - Adding "Reeder" clients for MacOS (Feever et Google-Reader API) - Modify Reeder version (and link) for iOS * Update README.fr.md Ajout du client "Reeder 4" pour MacOs (Feever et Google-Reader API) Modification de la version (et du lien) pour "Reeder" sur iOS * Apple links * Reverts * Reverts
2019-10-22Docs update (#2164)Gravatar Patrick
* Update Readme.conf Add information in Readme.conf to hopefully stop bug reports about intended behavior. * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update Readme * Update Documentation Section * Add main Documentation link near top of Document * Make Documentation header a link * Fix spelling mistake I didn't catch * Apply suggestions from code review Co-Authored-By: pattems <patrick@crandol.com> * Changes per Frenzie comments * Move non-disclaiming disclaimer * English Admin Documentation Update * Add Backup section * Update wording in Index * Move Footnotes to End * Move Footnote * Add content for todos * Fix typos * Fix a bunch of typos * Remove a duplicated file (forgotten during dev merge) * Improve the documentation a bit
2019-10-05PostgreSQL 9.5+ (#2554)Gravatar Alexandre Alapetite
Needed for `CREATE INDEX IF NOT EXISTS` syntax. Supported as back as Ubuntu 16.04 LTS. Similar version checks than for the PHP version bump https://github.com/FreshRSS/FreshRSS/pull/2495 https://www.postgresql.org/docs/9.5/sql-createindex.html https://www.postgresql.org/docs/9.5/release-9-5.html
2019-09-28Document Reeder compatibility (#2540)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/2513 https://github.com/FreshRSS/FreshRSS/pull/2526
2019-09-18Remove JSON.php fallback (#2528)Gravatar Alexandre Alapetite
After moving to PHP 5.6+ https://github.com/FreshRSS/FreshRSS/pull/2527 it should not be necessary to have the JSON.php fallback anymore, which was mainly there due to an obscure licensing issue 6 years ago in Debian https://wiki.debian.org/qa.debian.org/jsonevil , which broke Ubuntu 13.10 https://github.com/FreshRSS/FreshRSS/issues/306
2019-09-17Require PHP 5.6+Gravatar Alexandre Alapetite
Discussion https://github.com/FreshRSS/FreshRSS/pull/2495#issuecomment-531911473 Needed for constant arrays https://www.php.net/manual/en/migration56.new-features.php which will be used in https://github.com/FreshRSS/FreshRSS/pull/2522
2019-08-20Require PHP 5.5+ (#2495)Gravatar Alexandre Alapetite
* Require PHP 5.5+ https://github.com/FreshRSS/FreshRSS/issues/2469#issuecomment-522255093 I think it would be reasonable to require PHP 5.5+ for the core of FreshRSS after all. As Frenzie said, WordPress currently requires PHP 5.6.20+, and it is the most popular PHP application. We would loose about 20% of the PHP servers according to https://w3techs.com/technologies/details/pl-php/5/all but I expect this number to drop fast after the release of CentOS 8 (CentOS accounts for 17% of Linux servers https://w3techs.com/technologies/details/os-linux/all/all ). Distributions: * no impact on Ubuntu, Fedora, Alpine, OpenWRT, FreeBSD, OpenSuze, Mageia, as all active versions have PHP > 7 * no impact on OpenSuze, Synology, as all active versions have PHP > 5.5 * we drop Debian 8 Jessie (-2020) - we keep supporting Debian 9 Stretch (2017-06) - current is Debian 10 Buster * we drop Red Hat 7 (-2024) - we keep supporting RHEL 8 (2019-05) * we drop CentOS 7 (-2024) - we will support CentOS 8 (to be released soonish) When dropping older versions, I can better like when it is for a good reason, and there is actually one with PHP 5.5, namely generators (yield) https://php.net/language.generators.overview which I consider using. * Version note for JSON.php * hex2bin * Update .travis.yml Co-Authored-By: Frans de Jonge <fransdejonge@gmail.com>
2019-08-17Doc MariaDB (#2494)Gravatar Alexandre Alapetite
2019-08-15tec: Provide a Minz_Mailer class (#2476)Gravatar Marien Fressinaud
* Add Minz_View::_path method (replace change_view) The `_path` method is more powerful since it allows to choose the file extension. It is also Minz_Request-agnostic, which is useful to reuse the Minz_View class in other places. `change_view` is now deprecated and a warning is logged if we use it. * Provide a Minz_Mailer to send emails It uses PHPMailer under the hood and only supports PHP >= 5.5
2019-03-09Add reference to Readably appGravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/1406#issuecomment-469310998
2019-02-13Less jQuery (#2234)Gravatar Alexandre Alapetite
* Less jQuery Follow-up of https://github.com/FreshRSS/FreshRSS/pull/2199 * Even less jQuery + global view unread title fix * Even less jQuery * Yet even less jQuery * Even less jQuery * Reduce some events * Even less jQuery * jQuery gone from main view +Fixed English i18n * Fix feed folded view * Remove Firefox 64 workaround Remove workaround for Gecko bug 1514498 in Firefox 64, fixed in Firefox 65 * Split to extra.js Avoid loading unneeded JavaScript code for the main view. + several adjustements * Improve CSS transition fold category * Rewrite shortcuts Remove library. Much faster, shorter, one listener instead of many. Control of the shortcut context. Fix https://github.com/FreshRSS/FreshRSS/issues/2215 * Remove debug * Minor syntax * Filter out unwanted shortcut modifiers * Menu overflow fix * Typo * Fix unfolding in mobile view * Remove jQuery from category.js * Remove jQuery from Global view
2018-12-21Add Liberapay icon (#2192)Gravatar Alexandre Alapetite
https://liberapay.com/FreshRSS https://github.com/FreshRSS/FreshRSS/issues/1694
2018-12-16Readme more minor changesGravatar Alexandre Alapetite
2018-12-16Minor reorganisation of the readmeGravatar Alexandre Alapetite
2018-12-16Update naming to WebSub (#2184)Gravatar Alexandre Alapetite
Instead of PubSubHubbub / PuSH
2018-12-16Remove simple-scrollbar fallback (#2182)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/pull/2181#issuecomment-447636787
2018-12-16Documentation Vienna (#2126)Gravatar Alexandre Alapetite
* Documentation Vienna / Open Reader https://github.com/FreshRSS/FreshRSS/issues/2091 https://github.com/FreshRSS/FreshRSS/pull/2093 https://github.com/ViennaRSS/vienna-rss/issues/1197 * Remove references to Open Reader API for now
2018-12-16French readme parity English (#2183)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/pull/2158#issuecomment-444217219
2018-12-12Decouple scrolling of feeds and articles (#2117)Gravatar Patrick Crandol
* Remove Sticky Kit Remove sticky-kit, as functionality is unsuitable for separate scrolling. * Remove sticky-kit load in main.js Further removing the sticky-kit kruft * Finish removal of references to Sticky-kit * CSS Changes to template for Independent Scrolling * Addition of JS and supporting CSS and html * More CSS fixes to establish expected behavior Should be able to scroll navbar without it being in sticky mode now. * Fix typo in main.js sortcut.js -> shortcut.js * Fix unexpected tree scrolling behavior * Change name of generic JS function * Improve sticky-aside * CSS changes in themes to accommodate independent Scroll In themes where .aside's width is not the standard 300px, .tree's width must be specified to be equal to .aside * Remove Sticky-Kit from README files * Updates to Sticky-Aside * Update Template to fix screwup * Make Recalculating height actually work * Let sidebar fill height if nav buttons aren't visible * Make accommodating for nav buttons actually work * update Swage theme for Independent Scroll feature * Integrate sticky_aside into main.js * Add Simple Scrollbar * Patch scrollbar color for themes with dark colored asides * Increase Visibility of scrollbar on Dark Themes * Improve async loading, events, and performance * CSS typo * Fix double scrollbar on mobile * Fix regression causing sticky to not be removed * No $ for non-jQuery variables * Fix strange condition + option for nice scrollbar * Initial attempt to use css sticky * Add stickyfill * make the correct element sticky * re-add incorrectly removed sidebar code * Continue fixing mistaken deletions * decrease frequency of recalc * use minified version of simple-scrollbar. * Load stickyfill instead of injecting * put recalc back where it belongs * re-remove script injector * remove padding bottom padding was causing the last item in the feed to be hidden under the nav buttons * Manual merge of css_scrollbar Add auto-detection of -webkit-scrollbar-thumb, otherwise fall back to simple-scrollbar.js * Fix Regression Sticky recalc is still needed when using css scrollbars * Replace method of closing dropdowns Changed from an overlay href to a javascript solution, for better compatibility * Remove Treepadding Treepadding was causing dropdown menus at the bottom of the tree to be obscured. * Undo unnecessary move of dropdown-target * Move Dropdown Handler to a sensibleish place * Fix light Scrollbar color not picking up on Firefox * Minor syntax * Minor Clarification of CSS/ patch BlueLagoon * Change logic for native WebKit scrollbar detection Fix https://github.com/FreshRSS/FreshRSS/pull/2117#issuecomment-444251419 Tested with Firefox 63, Firefox 65, Chrome 71, IE11, Edge 42 * Fixes for other views E.g. reader view * Cleaner way of generating hash for dropdowns * Make dropdown-toggle an actual toggle * Prepare for CSS Scrollbars Module Level 1 * Fix regression causing my labels dropdown not to appear * remove unneeded dropdown-close css rule * Re-apply some lost changes https://github.com/FreshRSS/FreshRSS/pull/2117/commits/3c509989e890b88852e52c67c1c5507d1e0bf28c * Add standard scrollbar compatibility E.g. Firefox 64+ * Make All dropdowns click-to-close * Remove BlueLagoon template * Try to fix Firefox https://github.com/FreshRSS/FreshRSS/pull/2117#discussion_r239539984 * Add CSS rules necessary for consistent function of scrollbar in Firefox * Use inheritance to determine width * Use overlay scrollbar where possible * Test Reduced Listener * Fix Firefox 62 And show subtle scrollbar even when not hovering * Add margin at bottom To allow opening the menus https://github.com/FreshRSS/FreshRSS/pull/2117#issuecomment-444571218 * Minor - tab correction * Spaces -> tabs * Remove unneeded inheritance * Fix indenting * Revert bad merge * Messy WIP to make dropdowns work * Style Cleanup * Break it down * Lets try a move-it move-it * Update p/scripts/main.js Co-Authored-By: pattems <patrick@crandol.com> * Update p/themes/BlueLagoon/BlueLagoon.css Co-Authored-By: pattems <patrick@crandol.com> * separate ALL THE THINGS * erroneous commas * and to or * removing double condition that doesn't do what I want * More breaking down * fix var * Fix variable name again * Remove magic number https://github.com/FreshRSS/FreshRSS/pull/2117#discussion_r240052598 * Suuuuper inelegant solution for dropdowns * lets try that again * Inelegant Fix For Dropdowns Now with 100% more working dropdowns * Make sidebar dropdowns work correctly? * Fix reversion * Make JS scrollbar always visible * Remove unneeded CSS Added early in this pull request, didn't get pulled out when it was obsolete * Fix CSS removal I missed * CSS comment update/consistency for dark themes * Clean Up Duplicate code * Make dropdowns properly hide Downside: Can no longer click on header/nav buttons to close * Strip unneeded if statement * jshint -W018 https://github.com/FreshRSS/FreshRSS/pull/2117#discussion_r240392851 * Half-reversion to old dropdown * make overlay href scale to sidebar width * remove init of nonexistent method * remove trailing tabs * move #close href where it belongs in index.phtml * Revert all changes to index.phtml * remove whitespace accidentally added in last commit * Move var's in init_column categories * Finish putting old style dropdowns back * Make CSS changes to use support statements * Cleanup Whitespace * re-add missing class * spaces -> tabs in main.js * tabs -> spaces css * Minor whitespace * Cleanup per @Alkarex * Second attempt to add bottom margin https://github.com/FreshRSS/FreshRSS/pull/2117#discussion_r240820901 * Fix error in IE11 * Simple-scrollbar color match for dark themes
2018-12-04Update Readme.conf (#2158)Gravatar Patrick Crandol
* Update Readme.conf Add information in Readme.conf to hopefully stop bug reports about intended behavior. * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update README.md Co-Authored-By: pattems <patrick@crandol.com> * Update Readme * Update Documentation Section * Add main Documentation link near top of Document * Make Documentation header a link * Fix spelling mistake I didn't catch * Apply suggestions from code review Co-Authored-By: pattems <patrick@crandol.com> * Changes per Frenzie comments * Move non-disclaiming disclaimer * Resolve #2159
2018-10-14Readme remove old Ubuntu 15.10Gravatar Alexandre Alapetite
2018-09-29Custom labels (#2027)Gravatar Alexandre Alapetite
* First draft of custom tags https://github.com/FreshRSS/FreshRSS/issues/928 https://github.com/FreshRSS/FreshRSS/issues/1367 * SMALLINT to BIGINT for id_entry And uppercase SQL types * Fix layout for unreads * Start UI menu * Change menu order * Clean database helpers https://github.com/FreshRSS/FreshRSS/pull/2027#discussion_r217971535 * Travis rules do not understand PostgreSQL constants Grrr * Tag controller + UI * Add column attributes to tags * Use only favicon for now, for label * Fix styling for different themes * Constant for maximum InnoDB index length in Unicode https://github.com/FreshRSS/FreshRSS/pull/2027#discussion_r219052200 (I would have personnally prefered keeping the readability of a real value instead of a constant, in this case of many SQL fields) * Use FreshRSS_Factory::createCategoryDao * Add view of all articles containing any tag * Fix search in tags * Mark as read tags * Partial auto-update unread tags * More auto update tag unreads * Add tag deletion * Do not purge tagged articles * Minor comment * Fix SQLite and UI bug * Google Reader API support for user tags Add SQL check that tag names must be distinct from category names * whitespace * Add missing API for EasyRSS * Compatibility SQLite Problematic parentheses * Add SQL DISTINCT for cases with multiple tags * Fix for PostgreSQL PostgreSQL needs some additional type hint to avoid "could not determine data type of parameter $1" http://www.postgresql-archive.org/Could-not-determine-data-type-of-parameter-1-tp2171092p2171094.html
2018-09-25Small docs update (see #1999) and i18n fix (see #1309) (#2026)Gravatar Roland Arendes
* Update conf.php Small i18n fix for german translation * Update README.md Added Reeder-3 as an supported client via Fever API * Update README.md Adding Reeder-3/iOS as an supported client * Update README.fr.md Adding Reeder-3/iOS as an supported client * Update 06_Fever_API.md Adding Reeder-3/iOS as an supported client * Update 06_Fever_API.md Adding Reeder-3/iOS as an supported client * Adding myself As requested, adding myself to the list of contributors
2018-09-09Update deployment linksGravatar Alexandre Alapetite
Remove broken DP deploy links https://github.com/DFabric/DPlatform-Shell/issues/51
2018-09-02Use mb_strcut (#1996)Gravatar Alexandre Alapetite
* Use mb_strcut Avoid cutting in the middle of a multi-byte UTF-8 character * Forgotten php5-* * Typo * Whitespace * More mb_strcut
2018-06-03A bit of API documentation (#1914)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/1754
2018-05-24Minor readme whitespaceGravatar Alexandre Alapetite
2018-05-24Add Fever API and user documentation (#1836)Gravatar Kevin Papst
* added fever api and documentation * spaces to tabs * fixed code format * added links * added utf8 to header * removed XML support * removed before check, as we have to convert it afterwards * added sandboxed setting (currently disabled) added support for extensions using entry_before_display * listFeedsOrderUpdate LIMIT https://github.com/FreshRSS/FreshRSS/pull/1836/files#r175287881 * removed custom sql by using FreshRSS_FeedDAO::listFeedsOrderUpdate() * fixed mark all as read * replaced custom sql for getUnread() and getStarred() with dao functions * removed sanitization functions * Rework fever login * Fix config bug Plus documentation * Fix array syntax For compatibility with PHP 5.3 * Disable cookies and session for API * Fix currentUser * added response header and error log * adjusted phpdoc to match new authentication * Mechanism to delete old keys * replace PHP_INT_MAX with zero to disable limit * replace method_exists with check for explicit methods * removed Press support and smaller refactoring + updated docu * Rewrite bindParamArray Avoid one of the SQL injection risks * Docs and readme * Fix API link * Simplify reverse key check Using userConfig
2018-03-04Docker follow-up (#1817)Gravatar Alexandre Alapetite
* Docker follow-up https://github.com/FreshRSS/FreshRSS/pull/1813 * Readme links cloud.docker.com does not seem to have a public version of the pages re-add https://hub.docker.com/r/freshrss/freshrss/ * Link to original GitHub readme * Docker readme MySQL PostgreSQL https://github.com/FreshRSS/FreshRSS/pull/1817#issuecomment-370195319 * docker exec username
2018-03-04New Docker (#1813)Gravatar Alexandre Alapetite
* Draft of new Docker Based on Alpine Linux. Size ~78MB. https://github.com/FreshRSS/docker-freshrss/issues/4 https://github.com/FreshRSS/FreshRSS/issues/520 https://github.com/FreshRSS/docker-freshrss https://github.com/FreshRSS/docker-freshrss-production * Docker readme * +x execution rights prepare * Docker readme links to hub.docker.com https://hub.docker.com/r/freshrss/freshrss/
2018-03-03Fix documentation links (#1814)Gravatar Alexandre Alapetite
2018-02-08API /reader/api/0/stream/items/contents (#1774)Gravatar Alexandre Alapetite
* API /reader/api/0/stream/items/contents For FeedMe * Fix continuation * Continuation in stream/items/ids * Fix multiple continuations * Allow empty POST tokens For FeedMe. This token is not used by e.g. The Old Reader API. There is the Authorization header anyway. TODO: Check security consequences * API compatibility FeedMe: add/remove feed FeedMe uses GET for some parameters typically given by POST * A bit of sanitization * Links to FeedMe * API favicons more robust when base_url is not set * Changelog FeedMe
2017-12-21Improving README in English and French (#1746)Gravatar Nicola Spanti
2017-12-02Documentation updates (#1697)Gravatar Kevin Papst
* added documentation about updating FreshRSS moved Installation to admin directory linked some already existing documentation files
2017-10-14A bit of Apache documentation (#1670)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/1666 https://github.com/FreshRSS/FreshRSS/issues/1669 https://github.com/FreshRSS/FreshRSS/issues/908
2017-09-26Update some HTTP links (doc, HTTPS) (#1641)Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/1605
2017-09-22[ci] Add Travis (#1619)Gravatar Frans de Jonge
* [ci] Add Travis * Exclude some libs * Semi-auto whitespace fixes * line length in SQLite * Exclude tests from line length * Feed.php line length * Feed.php: get rid of unnecessary concat * Feed.php: line length * bootstrap.php: no newline at end of file * Allow concatenating across multiple lines * Add Travis badge * do-install line length * update-or-create-user line length * cli/create-user line length * tests/app/Models/SearchTest.php fix indentation * tests/app/Models/UserQueryTest.php fix indentation * tests/app/Models/CategoryTest.php fix indentation * [fix] PHP 5.3 on precise * cli/do-install no spaces * cli/list-users line length * cli/reconfigure line length * empty catch statements * api/index line length nonsense * spaces before semicolon * app/Models/EntryDAO bunch of indentation * extra blank lines * spaces before comma in function call * testing tabwidth * increase to 10 * comment out tabwidth line * try older phpcs version 3.0.0RC4 * line length exception for app/install.php * proper spaces * stray spaces in i18n * Minz/ModelPdo line length * Minz whitespace * greader line length * greader elseif placement * app/Models/Feed.php spacing in function argument * ignore php 5.3 * app/Models/ConfigurationSetter.php stray whitespace * EntryDAOSQLite line length * I vote for higher max line length =P * ignore SQL * remove classname complaint * line length/more legible SQL * ignore line length nonsense * greader line length * feedController issues * uppercase TRUE, FALSE, NULL * revert * importExportController lowercase null * Share.php default value not necessary because ! is_array () a few lines down * CategoryDAO constants should be UPPERCASE * EntryDAO reduce line length * contentious autofix * Allow failures on all versions of PHP except 7.1 because reasons
2017-08-21Increase minimal support to PHP 5.3.8+Gravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/1604
2017-06-06Merge pull request #1572 from Alwaysin/masterGravatar Alexandre Alapetite
Add session and ctype PHP modules in README
2017-06-06Update README.mdGravatar Alwaysin
2017-06-06Fix outdated documentationGravatar Alexis Degrugillier
2017-05-25More git readmeGravatar Alexandre Alapetite
2017-05-12Move default configuration filesGravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/issues/1531
2017-05-07Merge pull request #1510 from marienfressinaud/doc/put-documentation-under-docsGravatar Alexandre Alapetite
Doc / Put documentation under docs
2017-04-23Minor favicon textGravatar Alexandre Alapetite
https://github.com/FreshRSS/FreshRSS/pull/1505 https://github.com/FreshRSS/FreshRSS/pull/1504
generated by cgit v1.2.3 (git 2.39.1) at 2026-02-10 21:28:47 +0000