From d7f888392678d711478ed64f4a52f43021d143af Mon Sep 17 00:00:00 2001 From: Patrick Date: Tue, 22 Oct 2019 05:17:12 -0400 Subject: 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 * Update README.md Co-Authored-By: pattems * Update README.md Co-Authored-By: pattems * Update README.md Co-Authored-By: pattems * 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 * 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 --- docs/en/admins/09_AccessControl.md | 24 ++++++++++++++++++++++++ 1 file changed, 24 insertions(+) create mode 100644 docs/en/admins/09_AccessControl.md (limited to 'docs/en/admins/09_AccessControl.md') diff --git a/docs/en/admins/09_AccessControl.md b/docs/en/admins/09_AccessControl.md new file mode 100644 index 000000000..c17ad1fc3 --- /dev/null +++ b/docs/en/admins/09_AccessControl.md @@ -0,0 +1,24 @@ +# Access Control + +FreshRSS offers three methods of Access control: Form Authentication using Javascript, HTTP based Authentication, or an uncontrolled state with no authentication required. + +## Form Authentication + +Form Authentication requires the use of Javascript. It will work on any supported version of PHP, but version 5.5 or newer is recommended (see footnote 1 in [prerequisites](02_Prerequisites.md) for the reason why). + +This option requires nothing more than selecting Form Authentication during installation. + +## HTTP Authentication + +You may also choose to use HTTP Authentication provided by your web server.[^1] + +If you choose to use this option, create a `./p/i/.htaccess` file with a matching `.htpasswd` file. + +## No Authentication +Not using authentication on your server is dangerous, as anyone with access to your server would be able to make changes as an admin. It is never advisable to not use any form of authentication, but **never** chose this option on a server that is able to be accessed outside of your home network. + +## Hints + +You can switch your authentication method at any time by editing the `./data/config.php` file, on the line that begins `'auth_type'`. + +[^1]: See [the Apache documentation](https://httpd.apache.org/docs/trunk/howto/auth.html) -- cgit v1.2.3