https://github.com/geekdada/ssmgr-trojan-client
A shadowsocks-manager s-node client for trojan-go
https://github.com/geekdada/ssmgr-trojan-client
shadowsocks-manager trojan-gfw trojan-go
Last synced: about 1 month ago
JSON representation
A shadowsocks-manager s-node client for trojan-go
- Host: GitHub
- URL: https://github.com/geekdada/ssmgr-trojan-client
- Owner: geekdada
- License: mit
- Fork: true (llc1123/ssmgr-trojan-client)
- Created: 2022-03-13T15:05:38.000Z (about 3 years ago)
- Default Branch: master
- Last Pushed: 2023-11-12T14:38:19.000Z (over 1 year ago)
- Last Synced: 2024-07-23T23:21:51.186Z (10 months ago)
- Topics: shadowsocks-manager, trojan-gfw, trojan-go
- Language: CSS
- Homepage:
- Size: 2.72 MB
- Stars: 3
- Watchers: 2
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
- License: LICENSE
Awesome Lists containing this project
README
# ssmgr-trojan-client
> This is a fork of the original [ssmgr-trojan-client](https://github.com/llc1123/ssmgr-trojan-client).
[][npm-url]
[][npm-url]
[npm-url]: https://www.npmjs.com/package/@royli/ssmgr-trojan-client
A [shadowsocks-manager](https://github.com/shadowsocks/shadowsocks-manager) s-node for trojan-gfw. If you know how to use trojan and shadowsocks-manager, you know what this does.
**Support [p4gefau1t/trojan-go](https://github.com/p4gefau1t/trojan-go) only.**
## Prerequisites
- Node.js >= 16.0
- shadowsocks-manager >= 0.36.0
- trojan-go v0.10.6 tested
## Installation
```
npm -g i @royli/ssmgr-trojan-client
```
## Usage
```
Usage: ssmgr-trojan-client [options]
Options:
-l, --listen-address [addr:port] listening address for this client (default: "0.0.0.0:4001")
-k, --key ssmgr client password
--api trojan-go API address
--trojan-config trojan-go config file path
--fake-website [addr:port] run a fake website on address [addr:port], default to "127.0.0.1:4002" if not specified
-d, --debug verbose output for debugging (default: false)
-h, --help display help for command
```
## Examples
### Run the client in standalone mode
```bash
ssmgr-trojan-client -l [addr:port] -k --api
```
You need to run trojan-go separately in this mode.
### Run the client with a builtin trojan-go instance
```bash
ssmgr-trojan-client -l [addr:port] -k --trojan-config
```
A builtin trojan-go instance (latest version) will be started automatically using the configuration provided (please make sure the API feature is enabled).
### Run a fake website alongside the client
```bash
ssmgr-trojan-client -l [addr:port] -k --trojan-config --fake-website
```
A fake website will be started alongside the client, which can be used by trojan-go. The default listening address is `127.0.0.1:4002`.
## License
[MIT](./LICENSE)
[](https://app.fossa.com/projects/git%2Bgithub.com%2Fgeekdada%2Fssmgr-trojan-client?ref=badge_large)