Shadowsocks

Ansible role that installs the Shadowsocks secure SOCKS 5 proxy (http://shadowsocks.org). A random password is automatically chosen, and a QR code is generated that makes it easy to configure the iOS and Android clients.

Role Variables

Gathered facts are used to determine the default IPv4 address that the server should bind to. Make sure that gather_facts is not set to "no" in your playbook.

Variables that can be set by the user (or another role)

• shadowsocks_server_ip: The public ip of your server. You MUST override this variable

• shadowsocks_server_inner_port: The port that the Shadowsocks server should listen on. Set to "8188" by default. In many servers, it cannot be less than 1024

• shadowsocks_server_outter_port: The port that Shadowsocks client will send data to. In the server, iptable is used to redirect data to real port. This variable can be set to any port, even less than 1024

• shadowsocks_local_port: The local port that Shadowsocks should listen on. Set to "1080" by default.

• shadowsocks_timeout: Timeout (in seconds). Set to "600" by default.

• shadowsocks_encryption_method: The encryption method that will be used to secure the connection. A list of options can be found in the Shadowsocks documentation. The default for this role is "rc4-md5".

Playbook Example

This example uses AWS EC2 and OS is Ubuntu Server 14.04

1. Create a main.yml in the parent direcroty of this repo

- name: Shadowsocks
  hosts: shadowsocks
  remote_user: ubuntu
  become: no
  become_user: root
  become_method: sudo
  roles:
    - { role: ansible-shadowsocks, shadowsocks_server_ip: aa.bbb.cc.dd, shadowsocks_server_inner_port: 8443, shadowsocks_server_outter_port: 53 }

2. Create a plain text file hosts

[shadowsocks]
aa.bbb.cc.dd

3. Run ansible-playbook -i hosts main.yml -vvvv

Note: You need configure your ~/.ssh/config file to make ssh login smoothly. And You need relace aa.bbb.cc.dd with your own server IP.

License

The MIT License (MIT)

Copyright (c) 2014 Joshua Lund

Permission is hereby granted, free of charge, to any person obtaining a copy of this software and associated documentation files (the "Software"), to deal in the Software without restriction, including without limitation the rights to use, copy, modify, merge, publish, distribute, sublicense, and/or sell copies of the Software, and to permit persons to whom the Software is furnished to do so, subject to the following conditions:

The above copyright notice and this permission notice shall be included in all copies or substantial portions of the Software.

THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. IN NO EVENT SHALL THE AUTHORS OR COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR THE USE OR OTHER DEALINGS IN THE SOFTWARE.

Author Information

You can find me on Twitter, and on GitHub. I also occasionally blog at MissingM.

https://github.com/jlund/ansible-shadowsocks