Metadata-Version: 1.1
Name: Flask-CloudflareRemote
Version: 1.0.1
Summary: Cloudflare proxy support for flask application
Home-page: https://github.com/cs91chris/flask_cloudflare_remote
Author: cs91chris
Author-email: cs91chris@voidbrain.me
License: MIT
Description: Flask-CloudflareRemote
        ======================
        
        Cloudflare proxy support for flask application.
        
        It gets client ip from cloudflare headers and can allow request from cloudflare ips only.
        
        
        Quickstart
        ~~~~~~~~~~
        
        Install ``flask_cloudflare_remote`` using ``pip``:
        
        ::
        
           $ pip install Flask-CloudflareRemote
        
        .. _section-1:
        
        Example usage
        ^^^^^^^^^^^^^
        
        .. code:: python
        
            import flask
            from flask_cloudflare_remote import CloudflareRemote
        
        
            app = Flask(__name__)
            cf = CloudflareRemote()
        
            cf.init_app(app)
        
        
        Configuration
        ^^^^^^^^^^^^^
        
        1. ``CF_DOMAIN``: *(default: 'www.cloudflare.com')*
        2. ``CF_REQ_TIMEOUT``: *(default: 10)*
        3. ``CF_IPs``: *(default: None)* list of allowed cloudflare ips
        4. ``CF_IP4_URI``: *(default: '/ips-v4')* ipv4 list uri
        5. ``CF_IP6_URI``: *(default: '/ips-v6')* ipv6 list uri
        6. ``CF_IPv6_ENABLED``: *(default: False)* enable ipv6
        7. ``CF_STRICT_ACCESS``: *(default: True)* return forbidden if remote ip is not in allowed list
        8. ``CF_OVERRIDE_REMOTE``: *(default: True)* override flask REMOTE_ADDR from request
        9. ``CF_HDR_CLIENT_IP``: *(default: 'CF-Connecting-IP')* header key used for client ip
        
        
        License MIT
        
Platform: any
Classifier: Environment :: Web Environment
Classifier: Intended Audience :: Developers
Classifier: License :: OSI Approved :: MIT License
Classifier: Operating System :: OS Independent
Classifier: Programming Language :: Python :: 3
Classifier: Topic :: Internet :: WWW/HTTP :: Dynamic Content
Classifier: Topic :: Software Development :: Libraries :: Python Modules
