mirror/Arsse
1
1
Fork 0
mirror of https://code.mensbeam.com/MensBeam/Arsse.git synced 2025-01-08 17:02:41 +00:00
Code Issues Activity

Document TTRSS authentication modes better

Browse source 
The different modes can be likened to either multi-user or single-user
mode in original
This commit is contained in:
J. King 2019-02-18 14:40:08 -05:00
parent 5885e14566
commit a467115d59
1 changed files with 6 additions and 0 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

6
docs/en/030_Supported_Protocols/020_Tiny_Tiny_RSS.md
View file

@ -61,25 +61,31 @@ Tiny Tiny RSS itself is unaware of HTTP authentication: if HTTP authentication i
- Clients may optionally provide HTTP credentials - Clients may optionally provide HTTP credentials
- API authentication proceeds as normal - API authentication proceeds as normal
- All feed icons are visible to unauthenticated clients - All feed icons are visible to unauthenticated clients
- Analogous to multi-user mode
- If the `userHTTPAuthRequired` setting is `true`: - If the `userHTTPAuthRequired` setting is `true`:
- Clients must pass HTTP authentication - Clients must pass HTTP authentication
- API authentication proceeds as normal - API authentication proceeds as normal
- Feed icons are visible only to their owners - Feed icons are visible only to their owners
- Analoguous to multi-user mode with additional HTTP authentication
- If the `userSessionEnforced` setting is `false`: - If the `userSessionEnforced` setting is `false`:
- Clients may optionally provide HTTP credentials - Clients may optionally provide HTTP credentials
- If HTTP authentication succeeded API authentication is skipped: tokens are issued upon login, but ignored for HTTP-authenticated requests - If HTTP authentication succeeded API authentication is skipped: tokens are issued upon login, but ignored for HTTP-authenticated requests
- All feed icons are visible to unauthenticated clients - All feed icons are visible to unauthenticated clients
- Analogous to single-user mode if using HTTP authentication, and to multi-user mode otherwise
- If the `userHTTPAuthRequired` setting is `true` and the `userSessionEnforced` setting is `false`: - If the `userHTTPAuthRequired` setting is `true` and the `userSessionEnforced` setting is `false`:
- Clients must pass HTTP authentication - Clients must pass HTTP authentication
- API authentication is skipped: tokens are issued upon login, but thereafter ignored - API authentication is skipped: tokens are issued upon login, but thereafter ignored
- Feed icons are visible only to their owners - Feed icons are visible only to their owners
- Analogous to single-user mode
- If the `userPreAuth` setting is `true`: - If the `userPreAuth` setting is `true`:
- The Web server asserts HTTP authentication was successful - The Web server asserts HTTP authentication was successful
- API authentication only checks that HTTP and API user names match - API authentication only checks that HTTP and API user names match
- Feed icons are visible only to their owners - Feed icons are visible only to their owners
- Analoguous to multi-user mode with additional HTTP authentication
- If the `userPreAuth` setting is `true` and the `userSessionEnforced` setting is `false`: - If the `userPreAuth` setting is `true` and the `userSessionEnforced` setting is `false`:
- The Web server asserts HTTP authentication was successful - The Web server asserts HTTP authentication was successful
- API authentication is skipped: tokens are issued upon login, but thereafter ignored - API authentication is skipped: tokens are issued upon login, but thereafter ignored
- Feed icons are visible only to their owners - Feed icons are visible only to their owners
- Analogous to single-user mode
In all cases, supplying invalid HTTP credentials will result in a 401 response. In all cases, supplying invalid HTTP credentials will result in a 401 response.