diff options
| author | supahgreg <supahgreg@users.noreply.github.com> | 2025-10-05 19:59:55 +0000 |
|---|---|---|
| committer | supahgreg <supahgreg@users.noreply.github.com> | 2025-10-05 19:59:55 +0000 |
| commit | 54771ac70bd4516d566d558318f46253919ff5c4 (patch) | |
| tree | b5725a36575945d00acbb63dcc13444b1faaff33 | |
| parent | 987e283677bde3d3f5926655a4673fb38961d08b (diff) | |
Switch to GitHub format for alerts/notifications (part 2).
| -rw-r--r-- | Android-Client.md | 5 | ||||
| -rw-r--r-- | Archived-Feed.md | 7 | ||||
| -rw-r--r-- | Content-Filters.md | 27 | ||||
| -rw-r--r-- | Email-Digests.md | 5 | ||||
| -rw-r--r-- | Encryption.md | 5 | ||||
| -rw-r--r-- | FAQ.md | 5 | ||||
| -rw-r--r-- | Feed-Handler-Plugins.md | 7 | ||||
| -rw-r--r-- | Generated-Feeds.md | 7 | ||||
| -rw-r--r-- | Global-Config.md | 5 | ||||
| -rw-r--r-- | Installation-Notes.md | 17 | ||||
| -rw-r--r-- | Plugins.md | 19 | ||||
| -rw-r--r-- | Publish-Articles.md | 5 | ||||
| -rw-r--r-- | SSL-Certificate-Authentication.md | 9 | ||||
| -rw-r--r-- | Search-Syntax.md | 5 | ||||
| -rw-r--r-- | Securing-Cache-Directories.md | 7 | ||||
| -rw-r--r-- | Sorting.md | 5 |
16 files changed, 59 insertions, 81 deletions
diff --git a/Android-Client.md b/Android-Client.md index 8e19774..ea130eb 100644 --- a/Android-Client.md +++ b/Android-Client.md @@ -25,9 +25,8 @@ This content is no longer accurate, given the original tt-rss project has closed Releases are built automatically for every commit pushed to master branch and [published on Gitlab](https://gitlab.tt-rss.org/tt-rss/tt-rss-android/-/releases). -!!! warning - - This is the only official and supported way to get the APK. If you see the app on any marketplace or anywhere else, it had been uploaded there without my knowledge or consent. +> [!WARNING] +> This is the only official and supported way to get the APK. If you see the app on any marketplace or anywhere else, it had been uploaded there without my knowledge or consent. Release APKs are signed. You can verify the signature using [apksigner](https://developer.android.com/tools/apksigner): diff --git a/Archived-Feed.md b/Archived-Feed.md index 440fbbc..6ec30bb 100644 --- a/Archived-Feed.md +++ b/Archived-Feed.md @@ -3,7 +3,6 @@ Archived is the place for articles for which originating feed no longer exists. It's either Starred articles from unsubscribed feeds or [externally shared data](Share-Anything). -[!NOTE] - - Articles in Archived feed are not expired automatically, you can delete them manually - using `Select...` → `Delete permanently` in the main toolbar. +> [!NOTE] +> Articles in Archived feed are not expired automatically, you can delete them manually +> using `Select...` → `Delete permanently` in the main toolbar. diff --git a/Content-Filters.md b/Content-Filters.md index b1020c1..6694e8c 100644 --- a/Content-Filters.md +++ b/Content-Filters.md @@ -9,11 +9,10 @@ Matching is case-insensitive, [PCRE](http://php.net/manual/en/reference.pcre.pattern.syntax.php) pattern syntax is used. -[!NOTE] - - Filter test dialog may not give entirely accurate results, especially for - complex filters. It is suggested to test filters using ``Feed debugger`` (hotkey `f D`) if you - feel that some filter is somehow misfiring on a specific feed. +> [!NOTE] +> Filter test dialog may not give entirely accurate results, especially for +> complex filters. It is suggested to test filters using ``Feed debugger`` (hotkey `f D`) if you +> feel that some filter is somehow misfiring on a specific feed. ### Load order @@ -41,19 +40,17 @@ expressions. Filter matching is performed during feed processing. -[!NOTE] - - Some actions may be applied only when the article is initially imported from the - feed. Other actions may be applied every time article is seen in the originating - feed. It is suggested to only rely on filters applying to articles imported - after the filter had been created - they will not retroactively apply to your - article database. +> [!NOTE] +> Some actions may be applied only when the article is initially imported from the +> feed. Other actions may be applied every time article is seen in the originating +> feed. It is suggested to only rely on filters applying to articles imported +> after the filter had been created - they will not retroactively apply to your +> article database. Several actions are available: -[!WARNING] - - Filters may not apply actions conditionally based on previous filters. All actions for an article are applied together, once. +> [!WARNING] +> Filters may not apply actions conditionally based on previous filters. All actions for an article are applied together, once. 1. ``Delete article`` - do not import article from the feed, does not actually delete anything from the database diff --git a/Email-Digests.md b/Email-Digests.md index 9966cec..42bc564 100644 --- a/Email-Digests.md +++ b/Email-Digests.md @@ -5,9 +5,8 @@ Users may opt into receiving daily (sent once every 24 hours) digests of unread Digests are sent out by the update daemon or if running <code>update.php —feeds</code> manually. At most 15 messages are sent in one batch. -[!NOTE] - - [PHPMailer plugin](https://github.com/supahgreg/tt-rss-plugin-mailer-smtp) is required to send mail under Docker. +> [!NOTE] +> [PHPMailer plugin](https://github.com/supahgreg/tt-rss-plugin-mailer-smtp) is required to send mail under Docker. * Digests may be customized by editing ``templates/digest_template*.txt``. diff --git a/Encryption.md b/Encryption.md index e76c880..98c56ea 100644 --- a/Encryption.md +++ b/Encryption.md @@ -10,6 +10,5 @@ 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. +> [!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. @@ -5,9 +5,8 @@ hide: # FAQ -[!NOTE] - - [Docker-related stuff has a separate FAQ page](Installation-Notes#faq) +> [!NOTE] +> [Docker-related stuff has a separate FAQ page](Installation-Notes#faq) ### I want to check how tt-rss renders my feed / the feed I'm trying to use is parsed incorrectly diff --git a/Feed-Handler-Plugins.md b/Feed-Handler-Plugins.md index 61fe15b..a12a95b 100644 --- a/Feed-Handler-Plugins.md +++ b/Feed-Handler-Plugins.md @@ -1,9 +1,8 @@ # Feed handler plugins -[!WARNING] - - Unless you have a strong need for these plugins, using them is not recommended. If - you do use them, at least don't enable them for all feeds. +> [!WARNING] +> Unless you have a strong need for these plugins, using them is not recommended. If +> you do use them, at least don't enable them for all feeds. Some plugins utilize global per-feed content hooks which either modify fetched feed XML data (i.e. fixing broken XML) or even generate it entirely, for tt-rss diff --git a/Generated-Feeds.md b/Generated-Feeds.md index dd48e64..5a302cc 100644 --- a/Generated-Feeds.md +++ b/Generated-Feeds.md @@ -6,10 +6,9 @@ this icon:  -[!WARNING] - - Subscribing to your own feed of search results is going to produce - duplicate articles on each and every feed update. +> [!WARNING] +> Subscribing to your own feed of search results is going to produce +> duplicate articles on each and every feed update. ## Data protection diff --git a/Global-Config.md b/Global-Config.md index 1f2d972..ff9a31c 100644 --- a/Global-Config.md +++ b/Global-Config.md @@ -48,9 +48,8 @@ putenv('TTRSS_SESSION_COOKIE_LIFETIME=86400*30'); // instead you're casting string literal "86400*30" to an integer ``` -[!NOTE] - - All values should be precalculated when setting via `.env` because they are not evaluated by PHP and used as-is. +> [!NOTE] +> All values should be precalculated when setting via `.env` because they are not evaluated by PHP and used as-is. ## Minimal config.php for a non-Docker setup diff --git a/Installation-Notes.md b/Installation-Notes.md index 7e3aaf7..fd79c4f 100644 --- a/Installation-Notes.md +++ b/Installation-Notes.md @@ -6,9 +6,8 @@ The Docker images related to https://github.com/supahgreg/tt-rss are: * https://hub.docker.com/r/supahgreg/tt-rss * https://hub.docker.com/r/supahgreg/tt-rss-web-nginx -[!NOTE] - - Podman is not Docker. Please don't report issues when using Podman or podman-compose. +> [!NOTE] +> Podman is not Docker. Please don't report issues when using Podman or podman-compose. This setup uses PostgreSQL and runs tt-rss using several containers as outlined below. We recommend using an external [Patroni cluster](https://patroni.readthedocs.io/en/latest/) instead of a single `db` container in production deployments. @@ -171,11 +170,10 @@ services: `BUILDKIT_CONTEXT_KEEP_GIT_DIR` build argument is needed to display tt-rss version info properly. If that doesn't work for you (no BuildKit?) you'll have to resort to terrible hacks. -[!WARNING] - - Self-built images are not supported. +> [!WARNING] +> Self-built images are not necessarily supported (i.e. best effort only). -### I got the updated compose file above and now my database keeps restarting +### I got the updated Docker Compose file above and now my database keeps restarting Error message: The data directory was initialized by PostgreSQL version 12, which is not compatible with this version 15.4. @@ -266,9 +264,8 @@ Note: `sudo -E` is needed to keep environment variables. ### How do I add plugins and themes? -[!NOTE] - - First party plugins can be added using plugin installer in `Preferences` → `Plugins`. +> [!NOTE] +> First party plugins can be added using plugin installer in `Preferences` → `Plugins`. By default, tt-rss code is stored on a persistent docker volume (``app``). You can find its location like this: @@ -27,9 +27,8 @@ https://github.com/topics/tt-rss-plugin , https://github.com/topics/ttrss-plugin ### Installing plugins -[!NOTE] - - First party plugins can be added via built-in plugin installer in `Preferences` → `Plugins`. +> [!NOTE] +> First party plugins can be added via built-in plugin installer in `Preferences` → `Plugins`. Copy plugin folder to ```tt-rss/plugins.local``` then activate it in the settings panel. Plugin folder name should correspond to plugin class name defined in ``(plugin)/init.php``, @@ -41,15 +40,13 @@ https://github.com/supahgreg?tab=repositories&q=tt-rss-plugin&sort=name ## Third party plugins -[!WARNING] - - We’re not responsible for third party plugins. Use at your own risk. - -[!NOTE] +> [!WARNING] +> We’re not responsible for third party plugins. Use at your own risk. - Third party plugins may be unmaintained and incompatible with newer tt-rss - code (especially those from the old forums). Please report plugin-related - problems to their developers. +> [!NOTE] +> Third party plugins may be unmaintained and incompatible with newer tt-rss +> code (especially those from the old forums). Please report plugin-related +> problems to their developers. ### Sharing plugins diff --git a/Publish-Articles.md b/Publish-Articles.md index 50eca0e..f083e71 100644 --- a/Publish-Articles.md +++ b/Publish-Articles.md @@ -13,6 +13,5 @@ icon](http://feedicons.com/) near headline title: Resulting URL is displayed in Preferences (`Feeds` → `Published & shared articles`). -[!NOTE] - - You can also publish articles automatically using filters (`Action` → `Publish article`). +> [!NOTE] +> You can also publish articles automatically using filters (`Action` → `Publish article`). diff --git a/SSL-Certificate-Authentication.md b/SSL-Certificate-Authentication.md index 2d172ba..fb44b4a 100644 --- a/SSL-Certificate-Authentication.md +++ b/SSL-Certificate-Authentication.md @@ -1,10 +1,9 @@ # SSL Certificate Authentication -[!WARNING] - - This guide is considered legacy and is no longer supported as it is not compatible with - [stock docker compose](Installation-Notes) setup. Please don't report any issues when - trying to DIY this. +> [!WARNING] +> This guide is considered legacy and is no longer supported as it is not compatible with the +> [stock Docker Compose](Installation-Notes) setup. Please don't report any issues when +> trying to DIY this. This article details the steps to enable user authentication with TT-RSS using a client certificate. diff --git a/Search-Syntax.md b/Search-Syntax.md index 7f5e22c..8c172b1 100644 --- a/Search-Syntax.md +++ b/Search-Syntax.md @@ -1,8 +1,7 @@ # Search Syntax -[!NOTE] - - This only applies to built-in search, other search plugins like may override this syntax. +> [!NOTE] +> This only applies to built-in search, other search plugins like may override this syntax. Search query consists of several keywords. Keyword starting with "-" is considered a negative match. Several special keywords are available: diff --git a/Securing-Cache-Directories.md b/Securing-Cache-Directories.md index 15dba7a..360c8f6 100644 --- a/Securing-Cache-Directories.md +++ b/Securing-Cache-Directories.md @@ -1,9 +1,8 @@ # Securing Cache Directories -[!NOTE] - - Official container images restrict `/cache` access by default. This page applies only to - legacy host installations. +> [!NOTE] +> Official container images restrict `/cache` access by default. This page applies only to +> legacy host installations. While nothing critical is stored in cache directories by tt-rss nor do files have easily guessable names, you may consider forbidding external access over @@ -3,9 +3,8 @@ Tiny Tiny RSS provides four options for how articles appear within a selected feed: `Default`, `Newest`, `Oldest`, `Title`. -[!NOTE] - - Special feeds (e.g. *Starred articles*) have unique sorting when *Default* is selected, otherwise they behave as described below. +> [!NOTE] +> Special feeds (e.g. *Starred articles*) have unique sorting when *Default* is selected, otherwise they behave as described below. - *Descending score* means **higher numbers** are shown before lower numbers. - *Descending date/time* means **more recent** is shown before less recent. |