Skip to content

Commit

Permalink
Docs and version bump
Browse files Browse the repository at this point in the history
  • Loading branch information
xurble committed Apr 18, 2024
1 parent e926d3e commit 257e451
Show file tree
Hide file tree
Showing 3 changed files with 18 additions and 20 deletions.
27 changes: 17 additions & 10 deletions docs/modules/overview.rst
Original file line number Diff line number Diff line change
Expand Up @@ -29,6 +29,23 @@ Installation
- Set ``FEEDS_SERVER`` to preferred web address of your service so that feed hosts can locate you if required e.g. ``https://example.com``
- Setup a mechanism to periodically refresh the feeds (see below)

Optional Settings
^^^^^^^^^^^^^^^^^

- ``FEEDS_VERIFY_HTTPS`` (Default True)
- Older versions of this library did not verify https connections when fetching feeds.
Set this to ``False`` to revert to the old behaviour.
- ``KEEP_OLD_ENCLOSURES`` (Default False)
- Some feeds (particularly podcasts with Dynamic Ad Insertion) will change their enclosure
urls between reads. By default, old enclosures are deleted and replaced with new ones.
Set this to true, to retain old enclosures - they will have their ``is_current`` flag
set to ``False``
- ``SAVE_JSON`` (Default False)
- If set, Sources and Posts will store a JSON representation of the all the data retrieved
from the feed so that uncommon or custom attributes can be retrieved. Caution - this will
dramatically increase tha amount of space used in your database.


Basic Models
------------

Expand Down Expand Up @@ -124,13 +141,3 @@ There are two helper methods in the ``utils`` module to help manage subscription
parent is None. ``get_unread_subscription_list_for_user`` will do the same but only returns
Subscriptions that are unread or that have unread children if they are a folder.

Dealing with Cloudflare
-----------------------

Depending on where you run your server, you may run into problems with Cloudflare's web captcha. Plenty of sites out there set up their Cloudflare to have default security on their RSS feed and this can block server-side RSS readers.

It's a huge pain and affects lots of self-hosted RSS readers. Seriously, Google it.

``django-feed-reader`` will do it's utmost to get these feeds anyway through the judicious use of public proxy servers, but is haphazard and you cannot rely on the scheduling of such feeds.

Feeds blocked by Cloudflare will have the ``is_cloudflare`` flag set on their ``Source`` and will update on a best-efforts basis.
9 changes: 0 additions & 9 deletions readme.rst
Original file line number Diff line number Diff line change
Expand Up @@ -124,15 +124,6 @@ There are two helper methods in the ``utils`` module to help manage subscription
parent is None. ``get_unread_subscription_list_for_user`` will do the same but only returns
Subscriptions that are unread or that have unread children if they are a folder.

Dealing with Cloudflare
-----------------------

Depending on where you run your server, you may run into problems with Cloudflare's web captcha. Plenty of sites out there set up their Cloudflare to have default security on their RSS feed and this can block server-side RSS readers.

It's a huge pain and affects lots of self-hosted RSS readers. Seriously, Google it.

``django-feed-reader`` will do it's utmost to get these feeds anyway through the judicious use of public proxy servers, but is haphazard and you cannot rely on the scheduling of such feeds.

Feeds blocked by Cloudflare will have the ``is_cloudflare`` flag set on their ``Source`` and will update on a best-efforts basis.

For more details see the `full documentation <https//django-feed-reader.readthedocs.io>`_.
2 changes: 1 addition & 1 deletion setup.py
Original file line number Diff line number Diff line change
Expand Up @@ -7,7 +7,7 @@

setuptools.setup(
name='django-feed-reader',
version='2.0.0-beta.2',
version='2.0.0',
description='An RSS feed reading library for Django.',
long_description=long_description,
long_description_content_type='text/markdown',
Expand Down

0 comments on commit 257e451

Please sign in to comment.