mirror of
https://github.com/tt-rss/tt-rss.github.io.git
synced 2026-09-18 14:11:46 +00:00
Initial restructuring of pages.
Also some minor content tweaks.
This commit is contained in:
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: default
|
||||
title: API Reference
|
||||
nav_order: 3
|
||||
---
|
||||
|
||||
{: .no_toc }
|
||||
|
||||
@@ -1,18 +1,18 @@
|
||||
---
|
||||
layout: default
|
||||
title: Android Client
|
||||
nav_order: 40
|
||||
parent: Legacy
|
||||
---
|
||||
|
||||
## **IMPORTANT**
|
||||
|
||||
* The original tt-rss-android project, hosted at <https://tt-rss.org/> and its various subdomains,
|
||||
[will be gone after 2025-11-01](https://community.tt-rss.org/t/the-end-of-tt-rss-org/7164).
|
||||
went away on 2025-11-01.
|
||||
* There are currently no plans to continue maintaining the app.
|
||||
* The app's source code may be found at <https://github.com/tt-rss/tt-rss-android>.
|
||||
* **APK downloads from <https://gitlab.tt-rss.org/tt-rss/tt-rss-android/-/releases> are no longer working. This is likely permanent.**
|
||||
* APKs that were available at <https://gitlab.tt-rss.org/tt-rss/tt-rss-android/-/releases> are gone.
|
||||
* This page's content should only be treated as a historical reference.
|
||||
* Refer to <https://github.com/tt-rss/tt-rss/discussions/29> for more information.
|
||||
* Refer to <https://github.com/tt-rss/tt-rss-android/discussions/8> for more information.
|
||||
|
||||
## Screenshots
|
||||
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Archived Feed
|
||||
nav_order: 41
|
||||
parent: Features
|
||||
---
|
||||
|
||||
Archived is the place for articles for which originating feed no longer exists.
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Content Filters
|
||||
nav_order: 20
|
||||
parent: Features
|
||||
---
|
||||
|
||||
Filters are a very powerful and flexible tool which may significantly ease the
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Email Digests
|
||||
nav_order: 42
|
||||
parent: Features
|
||||
---
|
||||
|
||||
Users may opt into receiving daily (sent once every 24 hours) digests of unread headlines via email.
|
||||
|
||||
+8
-4
@@ -1,12 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: Encryption
|
||||
nav_order: 43
|
||||
parent: Security
|
||||
---
|
||||
|
||||
Transparent at rest encryption is optionally supported for sensitive data stored in the database, currently limited to stored session data and passwords for feeds with authentication enabled.
|
||||
Transparent at-rest encryption is optionally supported for sensitive data stored in the database,
|
||||
currently limited to stored session data and passwords for feeds with authentication enabled.
|
||||
|
||||
To enable, [global configuration](Global-Config) option `TTRSS_ENCRYPTION_KEY` should be set to a 32-byte hex string of random bytes, which may be generated using CLI like this:
|
||||
To enable, [global configuration](Global-Config) option `TTRSS_ENCRYPTION_KEY` should be set to a 32-byte hex string of random bytes,
|
||||
which may be generated using CLI like this:
|
||||
|
||||
```sh
|
||||
php ./update.php --gen-encryption-key
|
||||
@@ -15,4 +17,6 @@ php ./update.php --gen-encryption-key
|
||||
If enabled, existing plaintext login sessions are automatically encrypted when used, plaintext feed passwords are encrypted on feed update.
|
||||
|
||||
{: .warning }
|
||||
> Automatic encryption of plaintext data is a one-way process. If you decide to disable `TTRSS_ENCRYPTION_KEY` afterwards, all encrypted sessions would become invalid and you will get logged out. Feed passwords would become unreadable until you either enable encryption back using same key or edit feeds manually.
|
||||
> Automatic encryption of plaintext data is a one-way process. If you decide to disable `TTRSS_ENCRYPTION_KEY` afterwards, all encrypted sessions would
|
||||
> become invalid and you will get logged out. Feed passwords would become unreadable until you either enable encryption back using same key or edit feeds
|
||||
> manually.
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: FAQ
|
||||
nav_order: 30
|
||||
nav_order: 3
|
||||
---
|
||||
|
||||
{: .note }
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Feed Handler Plugins
|
||||
nav_order: 44
|
||||
parent: Plugins
|
||||
nav_order: 2
|
||||
---
|
||||
|
||||
{: .warning }
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Generated Feeds
|
||||
nav_order: 45
|
||||
parent: Features
|
||||
---
|
||||
|
||||
You can generate a feed (in Atom or JSON format) for almost anything displayed
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Global Configuration
|
||||
nav_order: 21
|
||||
nav_order: 4
|
||||
---
|
||||
|
||||
All settings (see `_DEFAULTS[]` for default values) are listed here:
|
||||
|
||||
@@ -1,7 +1,8 @@
|
||||
---
|
||||
layout: default
|
||||
title: Making Plugins
|
||||
nav_order: 11
|
||||
parent: Plugins
|
||||
nav_order: 1
|
||||
---
|
||||
|
||||
Plugins may render new preference panes or embed themselves into several
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Publish Articles
|
||||
nav_order: 46
|
||||
parent: Features
|
||||
---
|
||||
|
||||
You can publish selected articles to a special RSS feed, accessible to anyone
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: SSL Certificate Authentication
|
||||
nav_order: 52
|
||||
parent: Legacy
|
||||
---
|
||||
|
||||
{: .warning }
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Scoring
|
||||
nav_order: 47
|
||||
parent: Features
|
||||
---
|
||||
|
||||
Scoring is supported in a way similar to some newsreaders. Score is calculated
|
||||
|
||||
@@ -1,7 +1,6 @@
|
||||
---
|
||||
layout: default
|
||||
title: Search Syntax
|
||||
nav_order: 48
|
||||
---
|
||||
|
||||
{: .note }
|
||||
|
||||
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Securing Cache Directories
|
||||
nav_order: 49
|
||||
parent: Security
|
||||
---
|
||||
|
||||
{: .note }
|
||||
|
||||
@@ -1,14 +1,14 @@
|
||||
---
|
||||
layout: default
|
||||
title: Share Anything
|
||||
nav_order: 50
|
||||
parent: Features
|
||||
---
|
||||
|
||||
You can share arbitrary webpages to appear as articles in your ``Published``
|
||||
feed. Combined with Readability this makes tt-rss function like a read it later
|
||||
kind of website.
|
||||
|
||||
Sharing is available via bookmarklet in Preferences: (`Feeds`-→
|
||||
Sharing is available via bookmarklet in Preferences: (`Feeds` →
|
||||
`Bookmarklets`) (if you have ``bookmarklets`` plugin enabled) or through Android
|
||||
application.
|
||||
|
||||
|
||||
+1
-1
@@ -1,7 +1,7 @@
|
||||
---
|
||||
layout: default
|
||||
title: Sorting
|
||||
nav_order: 51
|
||||
parent: Features
|
||||
---
|
||||
|
||||
Tiny Tiny RSS provides four options for how articles appear within a
|
||||
|
||||
@@ -70,9 +70,8 @@ Browse the documentation:
|
||||
|
||||
## Development and Contributing
|
||||
|
||||
* Contributions (documentation improvements, translations, reporting issues, etc.) are welcome.
|
||||
* Development and issue tracking primarily happens in [https://github.com/tt-rss/tt-rss](https://github.com/tt-rss/tt-rss).
|
||||
* Help translate tt-rss into your own language using [Weblate](https://hosted.weblate.org/engage/tt-rss/).
|
||||
Contributions (code, translations, reporting issues, etc.) are welcome.
|
||||
Please see <https://github.com/tt-rss/tt-rss/blob/main/CONTRIBUTING.md> for more information.
|
||||
|
||||
---
|
||||
|
||||
|
||||
Reference in New Issue
Block a user