# ⚔️Bladoxy (原SSprivoxy) V1.4.3 使用说明
Author *：M.S.*
*LICENSE：Apache 2.0*
*Tips：请务必在每次执行命令后执行 source ～/.bashrc*
> #### SSPrivoxy 从 v1.3.0 已更名为：Bladoxy（⚔️Blade+Proxy）（刀锋代理）
> #### v1.2.0 最新支持功能：自动循环检测可用端口（避免多用户进程冲突）
>
> #### v1.3.0 最新支持功能：更新机制，代码全部迁移到 pypi平台，可以使用 pip 机制安装、卸载、更新
>
> #### v1.4.0最新支持功能：支持上传节点文件，并用光标可视化翻页、选择节点
### 一、准备
1. 购买一个机场账号，有可用的 SS 节点。（目前只支持SS节点，后续会支持更多节点类型）
2. 下载节点配置文件（clash yaml格式），其中一个节点一般长下面这样（下面不是真实的节点信息，只展示格式）
```yaml
name: 'Canada Quebec Montreal Beauharnois 10GE0/0/27 DELLR6515 F05'
type: ss
server: ca05.kp.wf
port: 19313
cipher: aes-256-cfb
password: MG34Sd
udp: true
```
3. 一个linux普通用户账号，要求安装 Anaconda Python 环境，gcc、 g++ 以及 make 工具。
### 二、安装说明
从 SSprivoxy 升级的用户，请先卸载 SSprivoxy.
执行命令:
```bash
ssprivoxy uninstall
```
通过 pip 安装、更新、卸载:
1）安装：
```bash
# 请选择 3.5-3.9 的 python 版本
conda create -n bladoxy python=3.9
conda activate bladoxy
pip install bladoxy
# 安装后一定要初始化 Bladoxy，必须在同一个 conda 环境
# 安装时需要输入节点文件路径，请提前准备好！
bladoxy init
# 务必刷新环境变量
source ~/.bashrc
```
2）更新：
```bash
bladoxy cleanup
pip -U install bladoxy
bladoxy init
source ~/.bashrc
```
3）卸载：
```bash
bladoxy cleanup
pip uninstall bladoxy
source ~/.bashrc
```
### 三、参数用法
下面命令选择一个执行:
```bash
bladoxy init
bladoxy cleanup
bladoxy run
bladoxy stop
bladoxy uptProf
bladoxy uptNode
```
> init ：初始化程序。
> cleanup ：清理卸载所有资源。
> run ：启动主程序。
> stop ：停止所有正在运行的进程。
> uptProf ：更新用户节点配置文件。
> uptNode ：切换节点。
切换节点时：
> 上下键（或者鼠标滚轮）切换同一页的节点，左右键翻页
> ## **重要！！！**
请在初始化、启动、更换节点、停止进程、清理以后确保执行 ```source ~/.bashrc```
也就是说，每次执行命令请确保正确加载 ```~/.bashrc``` 文件。
### 四、测试
初始化结束后程序自动进行网络测试，如果看到：`成功访问到外网，并且测试文件已下载到临时文件夹` ，就可以正常使用Bladoxy。
也可以随时自行测试，测试代码：
```bash
curl -I www.google.com
wget https://huggingface.co/moka-ai/m3e-base/resolve/main/README.md?download=true
```
第一条命令有返回值且第二条命令成功下载文件，即成功访问到外部网络。
### 五、Bladoxy V1 开发路线
- [x] shadowsock补丁
- [x] 支持安装、运行、更换节点（单节点）、停止、卸载操作
- [x] 环境检测
- [x] 支持本地安装（无需联网）
- [x] 数据持久化（环境变量正确写入和移除）
- [x] 自动循环检测可用端口（避免多用户进程冲突）
- [x] 支持脚本自动更新功能 -> 打包为pip包，采用pip系统更新
- [x] 支持多节点切换
- [x] 读取 yaml 多节点配置文件
- [ ] 支持多种加密算法
- [ ] 托管远程节点配置文件
- [ ] 支持配置多种路由规则，视编程环境自动切换
- [ ] 支持多种节点类型 -> 除ss节点类型之外的其他节点
- [ ] Coming soon……
### 六、致谢
Bladoxy 使用了以下开源项目：
- shadowsocks 由 [https://shadowsocks.org/](https://shadowsocks.org/)
- privoxy 由 [https://www.privoxy.org/](https://www.privoxy.org/)
我们对这些项目对开源社区的贡献表示感谢。
> ### FAQ
>
> 1. Q：为什么程序没有按照预期行为运行？
>
> A：重要的事情只说一遍：记得运行完成执行 ```source ~/.bashrc``` ！！！
>
> 4. Q：按照要求做了还是出现报错怎么办？
>
> A：我们建议更新到最新版本。我们并没有测试广泛的机器和环境，如果您遇到了安装问题，请提 issue，我们很乐意让我们的作品变得更好。如果您有更好的建议和想法，也请在 issue 中详细说明。
Raw data
{
"_id": null,
"home_page": "https://github.com/magicum-sidus/Bladoxy",
"name": "bladoxy",
"maintainer": null,
"docs_url": null,
"requires_python": "<3.10,>=3.5",
"maintainer_email": null,
"keywords": null,
"author": "Magicum Sidus",
"author_email": "M.S@MS.com",
"download_url": "https://files.pythonhosted.org/packages/36/d8/05e4567b344100d6ec7ab9168beaa7a87794a0bfff551295aaaad3986c4a/bladoxy-1.4.4.tar.gz",
"platform": null,
"description": "# \u2694\ufe0fBladoxy (\u539fSSprivoxy) V1.4.3 \u4f7f\u7528\u8bf4\u660e\n\nAuthor *\uff1aM.S.*\n\n*LICENSE\uff1aApache 2.0*\n\n*Tips\uff1a\u8bf7\u52a1\u5fc5\u5728\u6bcf\u6b21\u6267\u884c\u547d\u4ee4\u540e\u6267\u884c source \uff5e/.bashrc*\n\n\n\n> #### SSPrivoxy \u4ece v1.3.0 \u5df2\u66f4\u540d\u4e3a\uff1aBladoxy\uff08\u2694\ufe0fBlade+Proxy\uff09\uff08\u5200\u950b\u4ee3\u7406\uff09\n> #### v1.2.0 \u6700\u65b0\u652f\u6301\u529f\u80fd\uff1a\u81ea\u52a8\u5faa\u73af\u68c0\u6d4b\u53ef\u7528\u7aef\u53e3\uff08\u907f\u514d\u591a\u7528\u6237\u8fdb\u7a0b\u51b2\u7a81\uff09\n>\n> #### v1.3.0 \u6700\u65b0\u652f\u6301\u529f\u80fd\uff1a\u66f4\u65b0\u673a\u5236\uff0c\u4ee3\u7801\u5168\u90e8\u8fc1\u79fb\u5230 pypi\u5e73\u53f0\uff0c\u53ef\u4ee5\u4f7f\u7528 pip \u673a\u5236\u5b89\u88c5\u3001\u5378\u8f7d\u3001\u66f4\u65b0\n>\n> #### v1.4.0\u6700\u65b0\u652f\u6301\u529f\u80fd\uff1a\u652f\u6301\u4e0a\u4f20\u8282\u70b9\u6587\u4ef6\uff0c\u5e76\u7528\u5149\u6807\u53ef\u89c6\u5316\u7ffb\u9875\u3001\u9009\u62e9\u8282\u70b9\n\n\n\n### \u4e00\u3001\u51c6\u5907\n\n1. \u8d2d\u4e70\u4e00\u4e2a\u673a\u573a\u8d26\u53f7\uff0c\u6709\u53ef\u7528\u7684 SS \u8282\u70b9\u3002\uff08\u76ee\u524d\u53ea\u652f\u6301SS\u8282\u70b9\uff0c\u540e\u7eed\u4f1a\u652f\u6301\u66f4\u591a\u8282\u70b9\u7c7b\u578b\uff09\n2. \u4e0b\u8f7d\u8282\u70b9\u914d\u7f6e\u6587\u4ef6\uff08clash yaml\u683c\u5f0f\uff09\uff0c\u5176\u4e2d\u4e00\u4e2a\u8282\u70b9\u4e00\u822c\u957f\u4e0b\u9762\u8fd9\u6837\uff08\u4e0b\u9762\u4e0d\u662f\u771f\u5b9e\u7684\u8282\u70b9\u4fe1\u606f\uff0c\u53ea\u5c55\u793a\u683c\u5f0f\uff09\n\n ```yaml\n name: 'Canada Quebec Montreal Beauharnois 10GE0/0/27 DELLR6515 F05'\n type: ss\n server: ca05.kp.wf\n port: 19313\n cipher: aes-256-cfb\n password: MG34Sd\n udp: true\n ```\n3. \u4e00\u4e2alinux\u666e\u901a\u7528\u6237\u8d26\u53f7\uff0c\u8981\u6c42\u5b89\u88c5 Anaconda Python \u73af\u5883\uff0cgcc\u3001 g++ \u4ee5\u53ca make \u5de5\u5177\u3002\n\n### \u4e8c\u3001\u5b89\u88c5\u8bf4\u660e\n\n\u4ece SSprivoxy \u5347\u7ea7\u7684\u7528\u6237\uff0c\u8bf7\u5148\u5378\u8f7d SSprivoxy.\n\n\u6267\u884c\u547d\u4ee4:\n\n```bash \nssprivoxy uninstall\n```\n\n\u901a\u8fc7 pip \u5b89\u88c5\u3001\u66f4\u65b0\u3001\u5378\u8f7d:\n\n1\uff09\u5b89\u88c5\uff1a\n\n```bash\n# \u8bf7\u9009\u62e9 3.5-3.9 \u7684 python \u7248\u672c\nconda create -n bladoxy python=3.9\nconda activate bladoxy\npip install bladoxy\n# \u5b89\u88c5\u540e\u4e00\u5b9a\u8981\u521d\u59cb\u5316 Bladoxy\uff0c\u5fc5\u987b\u5728\u540c\u4e00\u4e2a conda \u73af\u5883\n# \u5b89\u88c5\u65f6\u9700\u8981\u8f93\u5165\u8282\u70b9\u6587\u4ef6\u8def\u5f84\uff0c\u8bf7\u63d0\u524d\u51c6\u5907\u597d\uff01\nbladoxy init\n# \u52a1\u5fc5\u5237\u65b0\u73af\u5883\u53d8\u91cf\nsource ~/.bashrc\n```\n\n2\uff09\u66f4\u65b0\uff1a\n\n```bash\nbladoxy cleanup\npip -U install bladoxy\nbladoxy init\nsource ~/.bashrc\n```\n\n3\uff09\u5378\u8f7d\uff1a\n\n```bash\nbladoxy cleanup\npip uninstall bladoxy\nsource ~/.bashrc\n```\n\n### \u4e09\u3001\u53c2\u6570\u7528\u6cd5\n\n\u4e0b\u9762\u547d\u4ee4\u9009\u62e9\u4e00\u4e2a\u6267\u884c:\n\n```bash\nbladoxy init\nbladoxy cleanup\nbladoxy run\nbladoxy stop\nbladoxy uptProf\nbladoxy uptNode\n```\n\n> init \uff1a\u521d\u59cb\u5316\u7a0b\u5e8f\u3002\n> cleanup \uff1a\u6e05\u7406\u5378\u8f7d\u6240\u6709\u8d44\u6e90\u3002\n> run \uff1a\u542f\u52a8\u4e3b\u7a0b\u5e8f\u3002\n> stop \uff1a\u505c\u6b62\u6240\u6709\u6b63\u5728\u8fd0\u884c\u7684\u8fdb\u7a0b\u3002\n> uptProf \uff1a\u66f4\u65b0\u7528\u6237\u8282\u70b9\u914d\u7f6e\u6587\u4ef6\u3002\n> uptNode \uff1a\u5207\u6362\u8282\u70b9\u3002\n\n\u5207\u6362\u8282\u70b9\u65f6\uff1a\n\n> \u4e0a\u4e0b\u952e\uff08\u6216\u8005\u9f20\u6807\u6eda\u8f6e\uff09\u5207\u6362\u540c\u4e00\u9875\u7684\u8282\u70b9\uff0c\u5de6\u53f3\u952e\u7ffb\u9875\n\n\n\n> ## **\u91cd\u8981\uff01\uff01\uff01**\n\n\u8bf7\u5728\u521d\u59cb\u5316\u3001\u542f\u52a8\u3001\u66f4\u6362\u8282\u70b9\u3001\u505c\u6b62\u8fdb\u7a0b\u3001\u6e05\u7406\u4ee5\u540e\u786e\u4fdd\u6267\u884c ```source ~/.bashrc``` \n\n\u4e5f\u5c31\u662f\u8bf4\uff0c\u6bcf\u6b21\u6267\u884c\u547d\u4ee4\u8bf7\u786e\u4fdd\u6b63\u786e\u52a0\u8f7d ```~/.bashrc``` \u6587\u4ef6\u3002\n\n### \u56db\u3001\u6d4b\u8bd5\n\n\u521d\u59cb\u5316\u7ed3\u675f\u540e\u7a0b\u5e8f\u81ea\u52a8\u8fdb\u884c\u7f51\u7edc\u6d4b\u8bd5\uff0c\u5982\u679c\u770b\u5230\uff1a`\u6210\u529f\u8bbf\u95ee\u5230\u5916\u7f51\uff0c\u5e76\u4e14\u6d4b\u8bd5\u6587\u4ef6\u5df2\u4e0b\u8f7d\u5230\u4e34\u65f6\u6587\u4ef6\u5939` \uff0c\u5c31\u53ef\u4ee5\u6b63\u5e38\u4f7f\u7528Bladoxy\u3002\n\n\u4e5f\u53ef\u4ee5\u968f\u65f6\u81ea\u884c\u6d4b\u8bd5\uff0c\u6d4b\u8bd5\u4ee3\u7801\uff1a\n\n```bash\ncurl -I www.google.com\nwget https://huggingface.co/moka-ai/m3e-base/resolve/main/README.md?download=true\n```\n\n\u7b2c\u4e00\u6761\u547d\u4ee4\u6709\u8fd4\u56de\u503c\u4e14\u7b2c\u4e8c\u6761\u547d\u4ee4\u6210\u529f\u4e0b\u8f7d\u6587\u4ef6\uff0c\u5373\u6210\u529f\u8bbf\u95ee\u5230\u5916\u90e8\u7f51\u7edc\u3002\n\n### \u4e94\u3001Bladoxy V1 \u5f00\u53d1\u8def\u7ebf\n\n- [x] shadowsock\u8865\u4e01\n- [x] \u652f\u6301\u5b89\u88c5\u3001\u8fd0\u884c\u3001\u66f4\u6362\u8282\u70b9\uff08\u5355\u8282\u70b9\uff09\u3001\u505c\u6b62\u3001\u5378\u8f7d\u64cd\u4f5c\n- [x] \u73af\u5883\u68c0\u6d4b\n- [x] \u652f\u6301\u672c\u5730\u5b89\u88c5\uff08\u65e0\u9700\u8054\u7f51\uff09\n- [x] \u6570\u636e\u6301\u4e45\u5316\uff08\u73af\u5883\u53d8\u91cf\u6b63\u786e\u5199\u5165\u548c\u79fb\u9664\uff09\n- [x] \u81ea\u52a8\u5faa\u73af\u68c0\u6d4b\u53ef\u7528\u7aef\u53e3\uff08\u907f\u514d\u591a\u7528\u6237\u8fdb\u7a0b\u51b2\u7a81\uff09\n- [x] \u652f\u6301\u811a\u672c\u81ea\u52a8\u66f4\u65b0\u529f\u80fd -> \u6253\u5305\u4e3apip\u5305\uff0c\u91c7\u7528pip\u7cfb\u7edf\u66f4\u65b0\n- [x] \u652f\u6301\u591a\u8282\u70b9\u5207\u6362\n- [x] \u8bfb\u53d6 yaml \u591a\u8282\u70b9\u914d\u7f6e\u6587\u4ef6\n- [ ] \u652f\u6301\u591a\u79cd\u52a0\u5bc6\u7b97\u6cd5\n- [ ] \u6258\u7ba1\u8fdc\u7a0b\u8282\u70b9\u914d\u7f6e\u6587\u4ef6\n- [ ] \u652f\u6301\u914d\u7f6e\u591a\u79cd\u8def\u7531\u89c4\u5219\uff0c\u89c6\u7f16\u7a0b\u73af\u5883\u81ea\u52a8\u5207\u6362\n- [ ] \u652f\u6301\u591a\u79cd\u8282\u70b9\u7c7b\u578b -> \u9664ss\u8282\u70b9\u7c7b\u578b\u4e4b\u5916\u7684\u5176\u4ed6\u8282\u70b9\n- [ ] Coming soon\u2026\u2026\n\n### \u516d\u3001\u81f4\u8c22\n\nBladoxy \u4f7f\u7528\u4e86\u4ee5\u4e0b\u5f00\u6e90\u9879\u76ee\uff1a\n- shadowsocks \u7531 [https://shadowsocks.org/](https://shadowsocks.org/)\n\n- privoxy \u7531 [https://www.privoxy.org/](https://www.privoxy.org/)\n\n \u6211\u4eec\u5bf9\u8fd9\u4e9b\u9879\u76ee\u5bf9\u5f00\u6e90\u793e\u533a\u7684\u8d21\u732e\u8868\u793a\u611f\u8c22\u3002\n\n> ### FAQ\n>\n> 1. Q\uff1a\u4e3a\u4ec0\u4e48\u7a0b\u5e8f\u6ca1\u6709\u6309\u7167\u9884\u671f\u884c\u4e3a\u8fd0\u884c\uff1f\n>\n> A\uff1a\u91cd\u8981\u7684\u4e8b\u60c5\u53ea\u8bf4\u4e00\u904d\uff1a\u8bb0\u5f97\u8fd0\u884c\u5b8c\u6210\u6267\u884c ```source ~/.bashrc``` \uff01\uff01\uff01\n>\n> 4. Q\uff1a\u6309\u7167\u8981\u6c42\u505a\u4e86\u8fd8\u662f\u51fa\u73b0\u62a5\u9519\u600e\u4e48\u529e\uff1f\n>\n> A\uff1a\u6211\u4eec\u5efa\u8bae\u66f4\u65b0\u5230\u6700\u65b0\u7248\u672c\u3002\u6211\u4eec\u5e76\u6ca1\u6709\u6d4b\u8bd5\u5e7f\u6cdb\u7684\u673a\u5668\u548c\u73af\u5883\uff0c\u5982\u679c\u60a8\u9047\u5230\u4e86\u5b89\u88c5\u95ee\u9898\uff0c\u8bf7\u63d0 issue\uff0c\u6211\u4eec\u5f88\u4e50\u610f\u8ba9\u6211\u4eec\u7684\u4f5c\u54c1\u53d8\u5f97\u66f4\u597d\u3002\u5982\u679c\u60a8\u6709\u66f4\u597d\u7684\u5efa\u8bae\u548c\u60f3\u6cd5\uff0c\u4e5f\u8bf7\u5728 issue \u4e2d\u8be6\u7ec6\u8bf4\u660e\u3002\n",
"bugtrack_url": null,
"license": "http://www.apache.org/licenses/LICENSE-2.0",
"summary": "Bladoxy is a linux network assistant.",
"version": "1.4.4",
"project_urls": {
"Homepage": "https://github.com/magicum-sidus/Bladoxy"
},
"split_keywords": [],
"urls": [
{
"comment_text": "",
"digests": {
"blake2b_256": "08d350399578c733caa816bafa4939e9508b38a5cd310d8c505852c653826b94",
"md5": "cb44f8446016cb379eb838c85eab9070",
"sha256": "af25059ab2e1fa27d84a088b004d7a3daf75ff3b5b4eed23383334dad6bbd1e0"
},
"downloads": -1,
"filename": "bladoxy-1.4.4-py3-none-any.whl",
"has_sig": false,
"md5_digest": "cb44f8446016cb379eb838c85eab9070",
"packagetype": "bdist_wheel",
"python_version": "py3",
"requires_python": "<3.10,>=3.5",
"size": 10372255,
"upload_time": "2024-10-15T01:44:25",
"upload_time_iso_8601": "2024-10-15T01:44:25.141968Z",
"url": "https://files.pythonhosted.org/packages/08/d3/50399578c733caa816bafa4939e9508b38a5cd310d8c505852c653826b94/bladoxy-1.4.4-py3-none-any.whl",
"yanked": false,
"yanked_reason": null
},
{
"comment_text": "",
"digests": {
"blake2b_256": "36d805e4567b344100d6ec7ab9168beaa7a87794a0bfff551295aaaad3986c4a",
"md5": "2e27a5b713be2891d366e78aec6ef2d6",
"sha256": "a365fd6d4d7a024e3615b18ee49ebaf595bdd8658743988514aa8a5cacf0d7be"
},
"downloads": -1,
"filename": "bladoxy-1.4.4.tar.gz",
"has_sig": false,
"md5_digest": "2e27a5b713be2891d366e78aec6ef2d6",
"packagetype": "sdist",
"python_version": "source",
"requires_python": "<3.10,>=3.5",
"size": 10344180,
"upload_time": "2024-10-15T01:44:32",
"upload_time_iso_8601": "2024-10-15T01:44:32.897192Z",
"url": "https://files.pythonhosted.org/packages/36/d8/05e4567b344100d6ec7ab9168beaa7a87794a0bfff551295aaaad3986c4a/bladoxy-1.4.4.tar.gz",
"yanked": false,
"yanked_reason": null
}
],
"upload_time": "2024-10-15 01:44:32",
"github": true,
"gitlab": false,
"bitbucket": false,
"codeberg": false,
"github_user": "magicum-sidus",
"github_project": "Bladoxy",
"travis_ci": false,
"coveralls": false,
"github_actions": false,
"lcname": "bladoxy"
}
JSON
