https://github.com/jakbin/flask-tor

Host your flask website on tor using flask-tor.
https://github.com/jakbin/flask-tor

flask onion onion-service onionshare python security tor tor-onion-service

Last synced: 6 days ago
JSON representation

Host your flask website on tor using flask-tor.

• Host: GitHub
• URL: https://github.com/jakbin/flask-tor
• Owner: jakbin
• License: mit
• Created: 2021-06-27T09:26:29.000Z (over 3 years ago)
• Default Branch: main
• Last Pushed: 2023-05-09T09:20:03.000Z (over 1 year ago)
• Last Synced: 2024-08-09T07:28:28.789Z (3 months ago)
• Topics: flask, onion, onion-service, onionshare, python, security, tor, tor-onion-service
• Language: Python
• Homepage: https://youtu.be/gmssaGzRT8M
• Size: 18.6 KB
• Stars: 12
• Watchers: 1
• Forks: 1
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • Changelog: CHANGELOG.md
  • License: LICENSE

Awesome Lists containing this project

README

        
# flask-tor

Run your flask website in tor using flask_tor.It doesn’t interfere with other tor processes on your computer, so you can use the Tor Browser or the system tor on their own.

 [![PyPI version](https://badge.fury.io/py/flask-tor.svg)](https://badge.fury.io/py/flask-tor)

 [![Downloads](https://pepy.tech/badge/flask-tor/month)](https://pepy.tech/project/flask-tor)

 [![Downloads](https://static.pepy.tech/personalized-badge/flask-tor?period=total&units=international_system&left_color=green&right_color=blue&left_text=Total%20Downloads)](https://pepy.tech/project/flask-tor)

 ![Python 3.6](https://img.shields.io/badge/python-3.6-yellow.svg)

### Disclaimer:-

Use it only for educational purpose.

## Features

- No need root permission

- Multiple instances

## Compatability

Python 3.6+ is required.

## Installation

```bash

pip install flask-tor

```

## Quickstart

1. Import with ```from flask_tor import run_with_tor``` .

2. call function `run_with_tor()` , store as variable and give it as port argument in flask app.

```python

# flask_tor_example.py

from flask import Flask

from flask_tor import run_with_tor

app = Flask(__name__)

port = run_with_tor()

@app.route("/")

def hello():

    return "Hello World!"

if __name__ == '__main__':

    app.run(port=port)

```

Running the example:

```bash

python flask_tor_example.py

connecting_to_tor: 100% - Done                                                       

 * Running on .onion

 * Serving Flask app "main"

 * Debug mode: off

 * Running on http://127.0.0.1:/

```

## Tutorial

[Watch Here](https://youtu.be/gmssaGzRT8M)

### Credit :- [onionshare](https://github.com/onionshare/onionshare)