https://github.com/wanjunzh/ssct

A wrapper tool for shadowsocks to consistently bypass firewalls.
https://github.com/wanjunzh/ssct

Last synced: 25 days ago
JSON representation

A wrapper tool for shadowsocks to consistently bypass firewalls.

• Host: GitHub
• URL: https://github.com/wanjunzh/ssct
• Owner: wanjunzh
• License: other
• Created: 2017-05-21T09:47:37.000Z (over 7 years ago)
• Default Branch: master
• Last Pushed: 2017-12-24T09:58:41.000Z (almost 7 years ago)
• Last Synced: 2024-08-03T17:12:06.493Z (4 months ago)
• Language: Python
• Size: 334 KB
• Stars: 83
• Watchers: 5
• Forks: 20
• Open Issues: 0
• Metadata Files:
  • Readme: README.md
  • License: LICENSE

Awesome Lists containing this project

• awesome-network-stuff - **85**星
• awesome-hacking-lists - wanjunzh/ssct - A wrapper tool for shadowsocks to consistently bypass firewalls. (Python)

README

        
# ShadowSocks ConnecTion

[![ssct](https://img.shields.io/badge/Platform-%20Linux%20%7C%20MACOS-brightgreen.svg)](ssct)

[![Documentation Status](https://img.shields.io/badge/中文文档-最新-brightgreen.svg)](README_zh.md)

A wrapper tool for [shadowsocks](https://github.com/shadowsocks/shadowsocks) to consistently bypass firewalls.

## Quick start

### Automatically connect

The easiest way to run this tool is just type `ssct` in terminal, and ssct will acquire available shadowsocks servers from [ishadowsocks](https://global.ishadowx.net) and connect to it automatically.

### Connect to a specific server

First, show all ss servers by `--list` option.

```

ssct --list

```

Then, connect to a specific server by `-n` option.

```

ssct -n 5

```

Alternatively, you can connect a custom server.

```

ssct -s  -p  -l  -k  -m 

```

## Usage

### Requirements

1 Install shadowsocks and requests (Required)

```

pip3 install shadowsocks

pip3 install requests

```

2 Install prettytable (Optional)

```

pip3 install prettytable

```

**Note:** The module `prettytable` is optional, but would be better if installed.

### Configuration for chrome and firefox

1. Install extension Proxy SwitchyOmega ([Chrome version](https://chrome.google.com/webstore/detail/proxy-switchyomega/padekgcemlokbadohgkifijomclgjgif), [Firefox version](https://addons.mozilla.org/en-US/firefox/addon/switchyomega/)).

2. Open the options of SwitchyOmega, and configure as below.  

![set switchyomega proxy](img/config-swithyomega.png)

3. List servers and select one to connect, or just type `ssct` to connect automatically.

![start ssct](img/start-ssct.png)

4. Select proxy option in chrome or firefox and enjoy it.

![select proxy option](img/chrome-proxy.png)

## More options

```

optional arguments:

  -h, --help         show this help message and exit

ssct options:

  -n            connect server number

  --list             list all ss servers

  --version          show program's version number and exit

shadowsocks options:

  -c         path to config file

  -s           server address, auto crawl online

  -p           server port, auto crawl online

  -b           local binding address [default: 127.0.0.1]

  -l           local port [default: 1080]

  -k       password, auto crawl online

  -m         encryption method, auto crawl online

  -t        timeout in seconds [default: 300]

  --fast-open        use TCP_FASTOPEN, requires Linux 3.7+

  -d         daemon mode, one of start, stop and restart

  --pid-file   pid file for daemon mode

  --log-file   log file for daemon mode

  --user       username to run as

  -v, -vv            verbose mode

  -q, -qq            quiet mode, only show warnings/errors

```

Connect to the available server automatically without any argument.

## LICENSE

Permission is hereby granted, free of charge, to any person, without any restriction.