<base target="_blank">
<div dir="ltr">
[** فارسی**](README_fa.md)
</div>
<br>
<div align=center markdown="1">
</div>
# Hiddify Reality Scanner
This is a TLS scanner that finds the best Reality SNI for you based on a list of SNIs. For more information about development, you can read through our [Contribution Guidelines](CONTRIBUTING.md) .
## ⚙️ Installation
The installation of this scanner has 2 parts. The first part is a server-side application and the 2nd part is client-side.
#### 🛠️ Server-side Installation
* First you need to install our custom Xray core on the server using the following command:
```
#remove old xray
bash -c "$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)" @ remove
systemctl stop hiddify-xray #only if you have hiddify manager and hiddify panel
#install hiddify custom xray
bash -c "$(curl -L https://github.com/hiddify/Xray-core-custom/raw/main/install-release.sh)" @ install
systemctl start hiddify-xray #only if you have hiddify manager and hiddify panel
```
* Now you should create a config with empty nameserver in your panel or add the following config:
```
curl -o server_config.json https://raw.githubusercontent.com/hiddify/Hiddify_Reality_Scanner/main/server_config.json
echo "---------------IPV6---------"
echo "vless://hiddify@$(curl -6 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify"
echo "---------------IPV4---------"
echo "vless://hiddify@$(curl -4 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify"
```
* Then you need to run the config via Xray like the command below. This will create a temporary Xray server for you :
```
xray run -c server_config.json
```
* You can use your Reality config like the the following link:
```
vless://hiddify@SERVER_IP:11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.yahoo.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify
```
#### 🛠️ Client-side Installation
For client-side, you just need to use Pypi and run the following command:
```bash
pip install -U hiddify_reality_scanner
```
<br>
## 🚀 Basic Usage
In order to run the scanner you need to [insall python](https://www.python.org/downloads/) first, then use one of the following commands on your client:
```bash
python -m hiddify_reality_scanner "vless_link"
#or
hiddify_reality_scanner "vless_link"
```
> Be careful that instead of `vless_link' you have to replace it with your Reality config.
## 🚀 Advanced Usage
* If you want to consider more items when scanning, use the following command on your client:
```bash
hiddify_reality_scanner --jobs 10 --sni yahoo.com,google.com "vless_link"
```
* Here:
* `--jobs` defines the number of concurrent scans.
* `--sni` defines the desired SNIs for scanning.
* `--limit` limit the number of working SNI.
* If you want to add a list of SNIs, use the following command
```bash
hiddify_reality_scanner --jobs 10 --limit 100 --sni path_to_the_list vless_link
```
* Here:
* `--jobs` defines the number of concurrent scans.
* `--sni path_to_the_list` desines the path for the list of SNIs.
* `--limit 100` desines the 100 limit for the working SNIs.
> Note: during the scan, if you want to intrupt it, you can simply use `ctrl+c` .
## 📊 Results
The results will be stored in `results-list.txt` and `results-list.json` on your client. You can use these SNIs as a Reality domain in your server. [How to add Reality domain on Hiddify Manager](https://github.com/hiddify/Hiddify-Manager/wiki/How-to-use-Reality-on-Hiddify)
> Note: If you have installed server-side scanner on your Hiddify Manager; You need to run the following command after finishing the scan:
```
systemctl start hiddify-xray
```
Raw data
{
"_id": null,
"home_page": "https://github.com/hiddify/Hiddify_Reality_Scanner/",
"name": "hiddify-reality-scanner",
"maintainer": "",
"docs_url": null,
"requires_python": "",
"maintainer_email": "",
"keywords": "",
"author": "hiddify",
"author_email": "",
"download_url": "https://files.pythonhosted.org/packages/4f/9a/00bb87e550a9e09d345407d4593ae12ee926877b6381d916e1b1f3e48224/hiddify_reality_scanner-1.8.0.tar.gz",
"platform": null,
"description": "<base target=\"_blank\">\n\n<div dir=\"ltr\">\n\n\n\n[** \u0641\u0627\u0631\u0633\u06cc**](README_fa.md) \n</div>\n<br>\n<div align=center markdown=\"1\">\n \n\n\n\n</div>\n\n# Hiddify Reality Scanner\n\nThis is a TLS scanner that finds the best Reality SNI for you based on a list of SNIs. For more information about development, you can read through our [Contribution Guidelines](CONTRIBUTING.md) .\n\n## \u2699\ufe0f Installation\nThe installation of this scanner has 2 parts. The first part is a server-side application and the 2nd part is client-side.\n\n\n#### \ud83d\udee0\ufe0f Server-side Installation\n\n* First you need to install our custom Xray core on the server using the following command:\n```\n#remove old xray\nbash -c \"$(curl -L https://github.com/XTLS/Xray-install/raw/main/install-release.sh)\" @ remove\n\nsystemctl stop hiddify-xray #only if you have hiddify manager and hiddify panel\n\n#install hiddify custom xray\nbash -c \"$(curl -L https://github.com/hiddify/Xray-core-custom/raw/main/install-release.sh)\" @ install\n\nsystemctl start hiddify-xray #only if you have hiddify manager and hiddify panel\n```\n\n* Now you should create a config with empty nameserver in your panel or add the following config:\n```\ncurl -o server_config.json https://raw.githubusercontent.com/hiddify/Hiddify_Reality_Scanner/main/server_config.json\n\necho \"---------------IPV6---------\"\necho \"vless://hiddify@$(curl -6 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify\"\n\necho \"---------------IPV4---------\"\necho \"vless://hiddify@$(curl -4 ip.sb):11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.google.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify\"\n\n```\n* Then you need to run the config via Xray like the command below. This will create a temporary Xray server for you :\n```\nxray run -c server_config.json\n```\n* You can use your Reality config like the the following link:\n\n```\nvless://hiddify@SERVER_IP:11443/?fp=chrome&security=reality&pbk=Z84J2IelR9ch3k8VtlVhhs5ycBUlXA7wHBWcBrjqnAw&sid=6ba85179e30d4fc2&sni=www.yahoo.com&type=tcp&flow=xtls-rprx-vision&encryption=none#Hiddify\n```\n\n#### \ud83d\udee0\ufe0f Client-side Installation\nFor client-side, you just need to use Pypi and run the following command:\n```bash\npip install -U hiddify_reality_scanner\n```\n\n<br>\n\n## \ud83d\ude80 Basic Usage\nIn order to run the scanner you need to [insall python](https://www.python.org/downloads/) first, then use one of the following commands on your client:\n```bash\npython -m hiddify_reality_scanner \"vless_link\"\n#or\nhiddify_reality_scanner \"vless_link\"\n```\n> Be careful that instead of `vless_link' you have to replace it with your Reality config.\n\n## \ud83d\ude80 Advanced Usage\n* If you want to consider more items when scanning, use the following command on your client:\n```bash\nhiddify_reality_scanner --jobs 10 --sni yahoo.com,google.com \"vless_link\"\n```\n* Here:\n * `--jobs` defines the number of concurrent scans.\n * `--sni` defines the desired SNIs for scanning.\n * `--limit` limit the number of working SNI.\n \n* If you want to add a list of SNIs, use the following command\n```bash\nhiddify_reality_scanner --jobs 10 --limit 100 --sni path_to_the_list vless_link\n```\n* Here:\n * `--jobs` defines the number of concurrent scans.\n * `--sni path_to_the_list` desines the path for the list of SNIs.\n * `--limit 100` desines the 100 limit for the working SNIs.\n\n> Note: during the scan, if you want to intrupt it, you can simply use `ctrl+c` .\n\n## \ud83d\udcca Results\nThe results will be stored in `results-list.txt` and `results-list.json` on your client. You can use these SNIs as a Reality domain in your server. [How to add Reality domain on Hiddify Manager](https://github.com/hiddify/Hiddify-Manager/wiki/How-to-use-Reality-on-Hiddify)\n\n\n\n> Note: If you have installed server-side scanner on your Hiddify Manager; You need to run the following command after finishing the scan:\n\n```\nsystemctl start hiddify-xray\n```\n",
"bugtrack_url": null,
"license": "",
"summary": "Awesome hiddify_reality_scanner created by hiddify",
"version": "1.8.0",
"project_urls": {
"Homepage": "https://github.com/hiddify/Hiddify_Reality_Scanner/"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "144a69f40a4a8e8639b2b8f492482f5501a24e460869b784f5ac6ba4a7066bce",
"md5": "db24a149783ed7e730134043a77298f1",
"sha256": "bac99087611de13243ca31842d8dbe81ab748aebdef68ee5f62b709123199558"
},
"downloads": -1,
"filename": "hiddify_reality_scanner-1.8.0-py3-none-any.whl",
"has_sig": false,
"md5_digest": "db24a149783ed7e730134043a77298f1",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": null,
"size": 10074,
"upload_time": "2023-11-29T12:52:03",
"upload_time_iso_8601": "2023-11-29T12:52:03.702277Z",
"url": "https://files.pythonhosted.org/packages/14/4a/69f40a4a8e8639b2b8f492482f5501a24e460869b784f5ac6ba4a7066bce/hiddify_reality_scanner-1.8.0-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "4f9a00bb87e550a9e09d345407d4593ae12ee926877b6381d916e1b1f3e48224",
"md5": "3f131bdb22711ccf57bc2937893926e9",
"sha256": "d64113eac8e33111e5772a504f77723f93d3f9e72de54026d6839e6ff8ddc67e"
},
"downloads": -1,
"filename": "hiddify_reality_scanner-1.8.0.tar.gz",
"has_sig": false,
"md5_digest": "3f131bdb22711ccf57bc2937893926e9",
"packagetype": "sdist",
"python_version": "source",
"requires_python": null,
"size": 11165,
"upload_time": "2023-11-29T12:52:05",
"upload_time_iso_8601": "2023-11-29T12:52:05.342568Z",
"url": "https://files.pythonhosted.org/packages/4f/9a/00bb87e550a9e09d345407d4593ae12ee926877b6381d916e1b1f3e48224/hiddify_reality_scanner-1.8.0.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2023-11-29 12:52:05",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "hiddify",
"github_project": "Hiddify_Reality_Scanner",
"travis_ci": false,
"coveralls": false,
"github_actions": true,
"requirements": [],
"lcname": "hiddify-reality-scanner"
}
JSON
