Skip to content

Latest commit

 

History

History
306 lines (243 loc) · 11.4 KB

README.md

File metadata and controls

306 lines (243 loc) · 11.4 KB
Raw

# Shadowsocks Plugin Management Script:

This script provides a comprehensive suite of utilities to manage and configure various Shadowsocks plugins along with other related services such as kcptun, simple-obfs, v2ray-plugin, and others on Unix-like operating systems.

Overview

The script automates the tasks related to the installation, uninstallation, and management of Shadowsocks and its plugins. It supports various operations like starting, stopping, and updating Shadowsocks and its associated plugins, applying configurations, handling SSL certificates, and more.

Features

  • Automatic Installation: Scripts to install Shadowsocks and popular plugins such as kcptun, simple-obfs, v2ray-plugin, etc.
  • Service Management: Start, stop, restart, and check the status of installed services.
  • Configuration Management: Automatically apply or display configurations for services.
  • Security: Generate and renew SSL certificates for secure communications.
  • Logging: View and manage log files.
  • Network Management: Configure server ports and manage network settings.

Requirements

  • Unix-like operating system (CentOS, Ubuntu, Debian).
  • curl or wget should be available.
  • tar, gzip for decompression of files.
  • Root permissions are required for most operations.

Installation

To install Shadowsocks and plugins, use the following command:

wget -N --no-check-certificate -c -t3 -T60 -O ss-plugins.sh https://raw.githubusercontent.com/oxmento/one-click/main/ss-plugins.sh
chmod +x ss-plugins.sh
./ss-plugins.sh install
## Download and install:

Usage:

Here is how to use the script to manage the Shadowsocks services:

Usage:
  ./ss-plugins.sh [options...] [args...]

Available Options:
  install          Install
  uninstall        Uninstall
  update           Update
  start            Start
  stop             Stop
  restart          Restart
  status           Check status
  script           Update script
  show             Visualize configuration
  log              View log files
  catcfg           View original configuration files
  uid              Add a new uid user (Cloak)
  cert             Apply for certificates for .cf .ga .gq .ml .tk (90 days)
  link             Generate a new SS:// link using the newly added uid (Cloak)
  scan             Generate a scannable QR code in the current terminal using the ss:// link
  help             Print help information and exit

Options:

  • install: Install Shadowsocks and select plugins.
  • uninstall: Remove the installed services.
  • update: Update the Shadowsocks and plugins to the latest versions.
  • start: Start the Shadowsocks service.
  • stop: Stop the Shadowsocks service.
  • restart: Restart the Shadowsocks service.
  • status: Check the status of Shadowsocks and its plugins.
  • log: View the log files of Shadowsocks and its plugins.
  • cert: Renew SSL certificates.
  • show: Display the configuration visually.
  • script: Upgrade the script itself.
  • uid: Add a new UID for Cloak users.
  • link: Generate a new SS:// link for the configuration.
  • scan: Generate a scannable QR code for mobile devices.
  • help: Display the help message and usage instructions.

Contributing:

  • Contributions to this script are welcome, especially in the areas of:
    • Extending support to other plugins and configurations.
    • Enhancing security features.
    • Simplifying the management of network settings.

Acknowledgments:

Thanks to all the contributors who have helped in building and maintaining this script.

You can copy this revised document into a Markdown file or any text editor to save it as `README.md`. This version includes a more detailed breakdown of usage and available options for managing the Shadowsocks services.

ss-plugins.sh (Note: If an unexpected error occurs when running the script, please execute the ./ss-plugins.sh script to upgrade the script。)

Download and install:

wget -N --no-check-certificate -c -t3 -T60 -O ss-plugins.sh https://git.io/fjlbl
chmod +x ss-plugins.sh
./ss-plugins.sh

 

Usage:
  ./ss-plugins.sh [options...] [args...]

Available Options:
  install          Install
  uninstall        Uninstall
  update           Update
  start            Start
  stop             Stop
  restart          Restart
  status           Check status
  script           Update script
  show             Visualize configuration
  log              View log files
  catcfg           View original configuration files
  uid              Add a new uid user (Cloak)
  cert             Apply for certificates for .cf .ga .gq .ml .tk (90 days)
  link             Generate a new SS:// link using the newly added uid (Cloak)
  scan             Generate a scannable QR code in the current terminal using the ss:// link
  help             Print help information and exit

 

Here are the relevant directories：

  SS-libev Installation Directory：/usr/local/bin
  SS-libev Startup File：/etc/init.d/shadowsocks-libev
  SS-libev Configuration File：/etc/shadowsocks/config.json
    
  SS-rust Installation Directory：/usr/local/bin
  SS-rust Startup File：/etc/init.d/shadowsocks-rust
  SS-rust Configuration File：/etc/shadowsocks/config.json
    
  Go-ss2 Installation Directory：/usr/local/bin
  Go-ss2 Startup File：/etc/init.d/go-shadowsocks2
  Go-ss2 Configuration File：/etc/shadowsocks/config.json

  rabbit-tcp Configuration File: /etc/rabbit-tcp/config.json
  caddy Installation Directory: /usr/local/caddy
  caddy Configuration File: /usr/local/caddy/Caddyfile

  nginx Binary File: /usr/sbin/nginx
  nginx Configuration File: /etc/nginx/nginx.conf

  SS-libev Log File: /var/log/shadowsocks-libev.log
  SS-rust Log File: /var/log/shadowsocks-rust.log
  Go-ss2 Log File: /var/log/go-shadowsocks2.log
  kcptun Log File: /var/log/kcptun.log
  cloak Log File: /var/log/cloak.log
  rabbit-tcp Log File: /var/log/rabbit-tcp.log
  caddy Error Log File: /var/log/caddy-error.log
  caddy Access Log File: /var/log/caddy-access.log
  nginx Error Log File: /var/log/nginx-error.log
  nginx Access Log File: /var/log/nginx-access.log

  acme.sh Installation Directory: ~/.acme.sh
  acme.sh Generated Certificate Directory: ~/.acme.sh xxx.xxx(domain)/

  Cloudflare API Storage Path: /root/.cloudflare/apiInfo
  Other Plugin Executable Binary Directory: /usr/local/bin

 

  1. Main Menu

 Shadowsocks-libev一 One-Click Management Script [v1.0.0]

  1. BBR
  2. Install
  3. Uninstall

 Current Status: Installed and Running

Please enter a number [1-3]:

 

  1. Optional plugins and plugin options:

  1. v2ray-plugin
      1. ws
      2. wss
      3. quic
      4. grpc
  2. kcptun
  3. simple-obfs
      1. http
      2. tls
  4. goquiet
  5. cloak
  6. mos-tls-tunnel
      1. tls
      2. wss
  7. rabbit-tcp
  8. simple-tls
      1. v0.3.4
      2. v0.4.7
      3. latest
  9. gost-plugin
      1. ws
      2. wss
      3. tls
      4. xtls
      5. quic
      6. http2
      7. grpc
 10. xray-plugin
      1. ws
      2. wss
      3. quic
      4. grpc
 11. qtun
 12. gun
      1. grpc-with-tls
      2. grpc-without-tls


### Note:

When using CDN, please change the CloudFlare "SSL/TLS"-"Overview" tab to "Full" or "Full (Strict)" mode (the former does not validate the server certificate, while the latter does), otherwise, opening your domain in a browser will prompt an error "too many redirects". Additionally, when using CDN + gRPC, please enable gRPC in the CloudFlare "Network" tab.

 

  1. Brief installation steps - animation preview, taking ss + v2ray-plugin as an example：

01-v2ray-plugin

 

  1. After the installation is completed, the terminal configuration is shown below, taking ss + kcptun as an example：

 Shadowsocks configuration information:

Address: 66.66.66.66
Port: 6666
Password: bc1xQkj3
Encryption: aes-256-gcm
Plug-in: kcptun
Plugin options:
Plug-in parameters: -l %SS_LOCAL_HOST%:%SS_LOCAL_PORT% -r %SS_REMOTE_HOST%:%SS_REMOTE_PORT% --crypt aes --key 0EP4edcP --mtu 1350 --sndwnd 1024 --rcvwnd 1024 --mode fast2 --datashard 10 - -parityshard 3 --dscp 46 --nocomp true

Mobile phone parameters : crypt=aes;key=0EP4edcP;mtu=1350;sndwnd=1024;rcvwnd=1024;mode=fast2;datashard=10;parityshard=3;dscp=46;nocomp=true

 SS QR code: ./ss-plugins.sh scan < ss://links >
 SS  Link : ss://[email protected]:6666/?plugin=kcptun%3bcrypt%3daes%3bkey%3d0EP4edcP%3bmtu%3d1350%3bsndwnd%3d1024%3brcvwnd%3d1024%3bmode%3dfast2%3bdatashard%3d10%3bparityshard%3d3%3bdscp%3d46%3bnocomp%3dtrue

 

Stargazers over time

 

This script is adapted from various great masters, so it is of a so-so level and is convenient for your own use.

It supports linux-amd64, and some supports linux-arm64 (aarch64). Don’t try the others. It supports CentOS6+ | Ubuntu16.04+ | Debian9+. If other lower versions are supported, please try it yourself. It is recommended to use the latest version。

The domain name to be used by ~~v2ray-plugin can be obtained from freenom.com. To apply, you need to attach an agent. Please fill in the information of which country the agent is based on. Otherwise, the application may not be possible. ~~ (It seems to be invalid. Those who have an account can still register)

In addition, the generated ss:// link does not support the import of plug-in parameters and needs to be copied and pasted manually. When using the kcptun plug-in, this link only supports import on mobile phones.

 

Related downloads：