Commit Graph

54 Commits

Author SHA1 Message Date
Alexandre Alapetite
4f957dfc4c Doc git latest (#5148)
#fix https://github.com/FreshRSS/FreshRSS/issues/4949
2023-02-28 08:11:27 +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
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
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
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
berumuron
a38fe3a15e doc: Add recommendations for manual updates (#4557) 2022-08-29 21:11:54 +02:00
maTh
10f29a7362 Improve documentation: example code to configure SMTP (#4555)
* add example code

* just a changed line break

* fix

* Fix

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2022-08-29 08:38:35 +02:00
maTh
4214954ea1 Improved: error page (#4465)
* 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-21 22:44:03 +02:00
Alexandre Alapetite
4f111c5b30 Easier full-text search possibility (#4505)
* 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-18 12:06:31 +02:00
Alexandre Alapetite
3b6ff67515 Add link to CHATONS list of FreshRSS instances (#4483) 2022-08-05 15:11:01 +02:00
Alexandre Alapetite
f89819bd64 Custom logo HTML (#4369)
* 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-23 14:03:19 +02:00
maTh
578a05e0e3 Docs: improve backup section (#4290)
* 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-11 22:56:52 +02:00
drosoCode
2aba861bc9 Add HTTP_REMOTE_USER header for auth (#4063)
* 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-04-02 21:40:30 +02:00
maTh
eabe95e28c Docs: information about extensions (#4281)
* 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-22 22:59:53 +01:00
Nicolas Ferrari
a6a4e806e4 Cloud Providers page (#4247) 2022-03-02 18:03:00 +01:00
Alexandre Alapetite
1acd3ab09b Use typographic quotes (#4133)
* 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-08 21:58:55 +01:00
Thomas Renes
916df412f5 Fix various typos and spelling errors in documentation, comments and code. (#4134) 2022-01-08 16:25:17 +01:00
maTh
078dc65cbc Improved manual: User Management/User registration (#4083)
* 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-26 12:47:17 +01:00
4xfu
3340235540 Correct cron example (#4079)
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-23 12:26:34 +01:00
Kaibin Yang
6660a2dded Add a reminder for NGINX installations (#3741) (#3934)
Update docs/en/admins/03_Installation.md
2021-10-25 20:26:09 +02:00
Alexandre Alapetite
acbba9adb2 Improved markdownlint (#3918)
* 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-23 13:43:24 +02:00
Alexis Degrugillier
3ae7474614 Fix documentation typo (#3810)
See #3809
2021-08-30 15:11:23 +02:00
maTh
9234a8a39a Fix docs link to dev themes (#3746)
* link fixed

* fix2
2021-08-14 12:23:16 +02:00
Frans de Jonge
2733fe1fd3 [docs] Fix typo in server requirements (#3681) 2021-06-29 13:35:01 +02:00
Alexandre Alapetite
483b6eb333 Drop PHP5 and IE11 (#3666)
* 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-07 17:53:47 +02:00
marcohald
c23e0136d0 Update 08_FeedUpdates.md (#3635)
* 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-06-06 22:32:12 +02:00
berumuron
cc6c529562 tec: Remove data/do-install.txt (#3555)
* 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-26 19:41:33 +01:00
Alexandre Alapetite
1c3159058f Quick update the doc for master renaming to edge 2021-03-15 00:00:25 +01:00
Lukas Vacula
a3f07d7d5e Theme Documentation (#3415)
* 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-06 16:46:03 +01:00
ldv8434
bf344cd302 Update and add to documentation (#3348)
* remove outdated mailing list information

* add information about normal view

* add information about global and reader view

* fix import section header

* reorder documentation to reflect menu's order

* clarify setting as default in normal view

* add info about reading section for config

* fix heading levels, add info about archive + profile sections

* unfix heading levels

* move section on feed-specific settings to the subscription management page

* update information about adding feeds, add information about feed management

* fix link to security page in installation

* fix broken links

* fix broken link to install page

* add lighttpd from project readme

* add php modules to step 4, add horizontal line to better separate steps from footnotes visually

* fix broken link

* add index page for easier access of other pages

* move first steps document

* make dedicated bug reporting page

* make index page for linking to other pages

* moved fever API to relevant location, linked to index

* remove outdated mailing list information

* add information about normal view

* add information about global and reader view

* fix import section header

* reorder documentation to reflect menu's order

* clarify setting as default in normal view

* add info about reading section for config

* fix heading levels, add info about archive + profile sections

* unfix heading levels

* move section on feed-specific settings to the subscription management page

* update information about adding feeds, add information about feed management

* fix link to security page in installation

* fix broken links

* fix broken link to install page

* add lighttpd from project readme

* add php modules to step 4, add horizontal line to better separate steps from footnotes visually

* fix broken link

* add index page for easier access of other pages

* move first steps document

* make dedicated bug reporting page

* make index page for linking to other pages

* moved fever API to relevant location, linked to index

* re-fix link

* remove mention of defunct mailing list

* grammar fix

* replace stream with feed

* add optional items, replace stream with feed

* replace stream with feed

* fix word choice

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* fix word choice

better reflect age of project

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* grammar fixes

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* remove double headings

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

* change single quote to double quote for consistency

* add subreddit link

* change php module list to Dockerfile link

* fix link to developer index, change html links to md for consistency

* update css selector terms

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>

Co-authored-by: Frans de Jonge <fransdejonge@gmail.com>
2021-01-10 20:50:54 +01:00
Alexis Degrugillier
5e4c392cf2 Document the SQLite utilities usage (#3344)
There is a CLI command to export from any database to a SQLite database
and also a CLI command to import a SQLite database to any database than
need to be documented.

See #961
2021-01-09 01:45:36 +01:00
LucasVerneyDGE
12d2baf64d Update doc about default configuration (#3124)
See https://github.com/FreshRSS/FreshRSS/issues/3066
2020-07-23 11:26:11 +02:00
jakem72360
4593594544 Fixed nginx split paths config issue (#3077)
* Fixed nginx split paths config issue

* Improved config comments.

* s/fixes/see/

* Added link to nginx issue tracker
2020-07-04 11:16:09 +02:00
bpatath
5c9d6a5396 Add auto-registration when using http_auth (#3003)
* Add auto-registration when using http_auth

* Document HTTP auth auto-registration

* Check email variable for HTTP auth auto-registration

* Auto-create HTTP users by default

* Fix Context init

(I will provide in another PR a better fix requiring a bit of global refactoring)

* Init language

Co-authored-by: Alexandre Alapetite <alexandre@alapetite.fr>
2020-06-19 23:01:19 +02:00
Troy Engel
1401186a48 pause automatic updates during upgrade (#2893) 2020-04-11 17:47:08 +02:00
Ths2-9Y-LqJt6
06c918d0d9 Fix wget in linux update guide (#2858)
* change link from wget to curl in linux update guid #2857

* change back to wget per feedback  #2857
2020-03-29 22:05:16 +02:00
Marien Fressinaud
82851d2039 Make master the rolling release branch (#2705)
* 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-15 14:08:49 +01:00
MonsieurP0uet
67fc72fb61 Correction in the line 38 (#2628) 2019-11-02 23:49:02 +01:00
Alexis Degrugillier
4b5474c87e Add systemd configuration in documentation (#2605)
See #2561 and #2557
2019-10-27 12:32:36 +01:00
Patrick
d7f8883926 Docs update (#2164)
* 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-22 11:17:12 +02:00
Alexandre Alapetite
61724c651b PostgreSQL 9.5+ (#2554)
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-10-05 15:48:25 +02:00
Alexandre Alapetite
37b52b7361 Trim whitespace (#2544) 2019-10-01 18:12:21 +02:00
Alexandre Alapetite
e761202f8a Remove JSON.php fallback (#2528)
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-18 17:18:36 +02:00
Alexandre Alapetite
38117df976 Require PHP 5.6+
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-09-17 20:28:07 +02:00
Marien Fressinaud
75632e70f0 Provide email address verification feature (#2481)
* Add an email field to the profile page

I reuse the `mail_login` from the configuration. I'm not sure if it's
useful today (I would say it was used when Persona login was available).

A good improvement would be to rename `mail_login` into `email` so it
would be more intuitive to use.

* Add boolean to the conf to force email validation

This commit only adds a configuration item.

* Add email during registration if email must be validated

* Set email token to validate when email changes

* Block access to FreshRSS if email is not validated

* Send email when address is changed

* Allow to resend the validation email

* Allow the user to change its email while blocked

* Document the email validation feature

* fixup! Allow the user to change its email while blocked

* tec: Autoload PHPMailer lib

* Validate email address format

* Add feedback on validation email resend action

* Allow to logout when user is blocked

* fix: Change default email "from"

* Reorganize i18n keys

* Complete all the locales with default english

* Hide sidebar (profile page) if email is not validated

* Check email requirements on registration

* Allow admin to specify email when creating users

* Don't check email format if value is empty

* Remove trailing comma in userController

Co-Authored-By: Alexandre Alapetite <alexandre@alapetite.fr>

* Set PHPMailer validator to html5 before sending email

* fixup! Remove trailing comma in userController
2019-08-29 12:02:05 +02:00
Alexandre Alapetite
d09826c145 Docker Alpine opcache (#2498)
https://github.com/FreshRSS/FreshRSS/pull/2495#discussion_r315662184
https://php.net/ref.opcache
We need to retest the performances
https://github.com/FreshRSS/FreshRSS/pull/2205
2019-08-20 15:48:54 +02:00
Alexandre Alapetite
fd33d92d41 Require PHP 5.5+ (#2495)
* 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-20 14:55:43 +02:00
Alexis Degrugillier
9720ab6a4d Add FAQ for admin section (#2427)
See #1987 and #2102
2019-06-23 21:37:30 +02:00
Sp3r4z
1a14860040 Fix line break in table (#2413)
* Fix line return 

Better with HTML native `<br>` than with `\\`

* Fix line break

Replace `\\` by native HTML `<br>`
2019-06-16 20:12:51 +02:00