Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/shadowsocks/v2ray-plugin
A SIP003 plugin based on v2ray
https://github.com/shadowsocks/v2ray-plugin
Last synced: 5 days ago
JSON representation
A SIP003 plugin based on v2ray
- Host: GitHub
- URL: https://github.com/shadowsocks/v2ray-plugin
- Owner: shadowsocks
- License: mit
- Created: 2019-01-08T08:02:01.000Z (about 6 years ago)
- Default Branch: master
- Last Pushed: 2024-12-12T00:38:39.000Z (about 1 month ago)
- Last Synced: 2024-12-31T00:04:16.101Z (12 days ago)
- Language: Go
- Size: 104 KB
- Stars: 2,715
- Watchers: 84
- Forks: 579
- Open Issues: 89
-
Metadata Files:
- Readme: README.md
- License: LICENSE
- Security: SECURITY.md
Awesome Lists containing this project
- awesome-network-stuff - **1188**星
- awesome-privacy - v2ray-plugin - A plugin that is based v2ray (Anonymous web browsing / Shadowsocks)
README
## Yet another SIP003 plugin for shadowsocks, based on [v2ray](https://github.com/v2fly/v2ray-core)
[![CircleCI](https://circleci.com/gh/shadowsocks/v2ray-plugin.svg?style=shield)](https://circleci.com/gh/shadowsocks/v2ray-plugin)
[![Releases](https://img.shields.io/github/downloads/shadowsocks/v2ray-plugin/total.svg)](https://github.com/shadowsocks/v2ray-plugin/releases)
[![Language: Go](https://img.shields.io/badge/go-1.13+-blue.svg)](https://github.com/shadowsocks/v2ray-plugin/search?l=go)
[![Go Report Card](https://goreportcard.com/badge/github.com/shadowsocks/v2ray-plugin)](https://goreportcard.com/report/github.com/shadowsocks/v2ray-plugin)
[![License](https://img.shields.io/github/license/shadowsocks/v2ray-plugin.svg)](LICENSE)## Build
* `go build`
* Alternatively, you can grab the latest nightly from Circle CI by logging into Circle CI or adding `#artifacts` at the end of URL like such: https://circleci.com/gh/shadowsocks/v2ray-plugin/20#artifacts## Usage
See command line args for advanced usages.
### Shadowsocks over websocket (HTTP)
Warning: HTTP only provides a moderate (but lightweight) traffic obfuscation. Cautious users should refrain from using this mode.
On your server
```sh
ss-server -c config.json -p 80 --plugin v2ray-plugin --plugin-opts "server"
```On your client
```sh
ss-local -c config.json -p 80 --plugin v2ray-plugin
```### Shadowsocks over websocket (HTTPS)
On your server
```sh
ss-server -c config.json -p 443 --plugin v2ray-plugin --plugin-opts "server;tls;host=mydomain.me"
```On your client
```sh
ss-local -c config.json -p 443 --plugin v2ray-plugin --plugin-opts "tls;host=mydomain.me"
```### Shadowsocks over quic
On your server
```sh
ss-server -c config.json -p 443 --plugin v2ray-plugin --plugin-opts "server;mode=quic;host=mydomain.me"
```On your client
```sh
ss-local -c config.json -p 443 --plugin v2ray-plugin --plugin-opts "mode=quic;host=mydomain.me"
```### Issue a cert for TLS and QUIC
`v2ray-plugin` will look for TLS certificates signed by [acme.sh](https://github.com/acmesh-official/acme.sh) by default.
Here's some sample commands for issuing a certificate using CloudFlare.
You can find commands for issuing certificates for other DNS providers at acme.sh.```sh
curl https://get.acme.sh | sh
~/.acme.sh/acme.sh --issue --dns dns_cf -d mydomain.me
```Alternatively, you can specify path to your certificates using option `cert` and `key`.
### Use `certRaw` to pass certificate
Instead of using `cert` to pass the certificate file, `certRaw` could be used to pass in PEM format certificate, that is the content between `-----BEGIN CERTIFICATE-----` and `-----END CERTIFICATE-----` without the line breaks.