Project: flask-cloudflared

Start a TryCloudflare Tunnel from your flask app.

Project Details

Latest version
0.0.14
Home Page
https://github.com/UWUplus/flask-cloudflared
PyPI Page
https://pypi.org/project/flask-cloudflared/

Project Popularity

PageRank
0.0023299620022971916
Number of downloads
217215

flask-cloudflared

PyPI - Downloads Run it button

Start a TryCloudflare tunnel to your flask app right from code.
This requires at least Python 3.6

Behavior

The Flask app will run on port 5000 by default and start the Cloudflared metrics page on a random port between 8100 and 9000.
This can be changed by passing the port and metrics_port arguments to the app.run() function after using the run_with_cloudflared decorator.

Custom tunnel domain

By default, the tunnel will be created with a random subdomain of trycloudflare.com.
To use custom domains, follow this tutorial by Cloudflare and pass either the tunnel_id or config_path arguments to the app.run() function after using the run_with_cloudflared decorator. For an example check out examples/flask_cloudflared_example.py.

Users on Apple Silicon

Because cloudflared doesn't support Darwin arm64 natively yet, Rosetta 2 is used to create a compatibility layer. If you don't have Rosetta 2 installed yet, please check Apple's support page.

Acknowledgements

This project is based on flask-ngrok.