# flask-cloudflared
 [](https://colab.research.google.com/github/UWUplus/flask-cloudflared/blob/main/examples/flask_cloudflared_example.ipynb)
Start a [TryCloudflare](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/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](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/local/) 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](https://github.com/UWUplus/flask-cloudflared/blob/main/examples/flask_cloudflared_example.py#L13-L14).
### Users on Apple Silicon
Because [cloudflared](https://github.com/cloudflare/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](https://support.apple.com/en-us/HT211861).
## Acknowledgements
This project is based on [flask-ngrok](https://github.com/gstaff/flask-ngrok).
Raw data
{
"_id": null,
"home_page": "https://github.com/UWUplus/flask-cloudflared",
"name": "flask-cloudflared",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "flask cloudflared",
"author": "Ralf Rademacher",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/49/cf/d01e9f44c042bb77194c83d00bc98bcf1cd8ff24cdf686191d8d57b8d4dc/flask_cloudflared-0.0.14.tar.gz",
"platform": null,
"description": "# flask-cloudflared\n\n [](https://colab.research.google.com/github/UWUplus/flask-cloudflared/blob/main/examples/flask_cloudflared_example.ipynb)\n\nStart a [TryCloudflare](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/trycloudflare) tunnel to your flask app right from code. \nThis requires at least `Python 3.6`\n\n## Behavior\nThe Flask app will run on port 5000 by default and start the Cloudflared metrics page on a random port between 8100 and 9000. \nThis can be changed by passing the `port` and `metrics_port` arguments to the `app.run()` function after using the `run_with_cloudflared` decorator.\n\n### Custom tunnel domain\nBy default, the tunnel will be created with a random subdomain of `trycloudflare.com`. \nTo use custom domains, follow [this tutorial by Cloudflare](https://developers.cloudflare.com/cloudflare-one/connections/connect-apps/install-and-setup/tunnel-guide/local/) 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](https://github.com/UWUplus/flask-cloudflared/blob/main/examples/flask_cloudflared_example.py#L13-L14).\n\n### Users on Apple Silicon\nBecause [cloudflared](https://github.com/cloudflare/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](https://support.apple.com/en-us/HT211861).\n\n## Acknowledgements\n\nThis project is based on [flask-ngrok](https://github.com/gstaff/flask-ngrok).\n",
"bugtrack_url": null,
"license": "",
"summary": "Start a TryCloudflare Tunnel from your flask app.",
"version": "0.0.14",
"project_urls": {
"Homepage": "https://github.com/UWUplus/flask-cloudflared"
},
"split_keywords": [
"flask",
"cloudflared"
],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "f9e0d90aa747ae35adfcd6fa116936b1eb42a6e5d8c69419694862476cefd34b",
"md5": "05b96a0f13ec124508997c0932a03962",
"sha256": "abd11c16030d5c68f91cf64efaecdebf09ab0dce10db43333aaebc790569bdbf"
},
"downloads": -1,
"filename": "flask_cloudflared-0.0.14-py3-none-any.whl",
"has_sig": false,
"md5_digest": "05b96a0f13ec124508997c0932a03962",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 6420,
"upload_time": "2023-07-04T12:44:53",
"upload_time_iso_8601": "2023-07-04T12:44:53.571457Z",
"url": "https://files.pythonhosted.org/packages/f9/e0/d90aa747ae35adfcd6fa116936b1eb42a6e5d8c69419694862476cefd34b/flask_cloudflared-0.0.14-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "49cfd01e9f44c042bb77194c83d00bc98bcf1cd8ff24cdf686191d8d57b8d4dc",
"md5": "049b641720d7e6f490df2dca07ad005b",
"sha256": "be88151714f306d042923c6996332de39519c24a1914692547d92789d098912a"
},
"downloads": -1,
"filename": "flask_cloudflared-0.0.14.tar.gz",
"has_sig": false,
"md5_digest": "049b641720d7e6f490df2dca07ad005b",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 6157,
"upload_time": "2023-07-04T12:44:55",
"upload_time_iso_8601": "2023-07-04T12:44:55.283784Z",
"url": "https://files.pythonhosted.org/packages/49/cf/d01e9f44c042bb77194c83d00bc98bcf1cd8ff24cdf686191d8d57b8d4dc/flask_cloudflared-0.0.14.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-07-04 12:44:55",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "UWUplus",
"github_project": "flask-cloudflared",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "flask-cloudflared"
}
JSON
