Browse Source

init script & update README.md

dev
破娃酱 8 years ago
parent
commit
c7fb9bcb5e
  1. 57
      README.md
  2. 7
      initcfg.sh

57
README.md

@ -1,9 +1,7 @@
shadowsocks ShadowsocksR
=========== ===========
[![PyPI version]][PyPI]
[![Build Status]][Travis CI] [![Build Status]][Travis CI]
[![Coverage Status]][Coverage]
A fast tunnel proxy that helps you bypass firewalls. A fast tunnel proxy that helps you bypass firewalls.
@ -14,36 +12,47 @@ Server
Debian / Ubuntu: Debian / Ubuntu:
apt-get install python-pip apt-get install git
pip install shadowsocks git clone https://github.com/breakwa11/shadowsocks.git
CentOS: CentOS:
yum install python-setuptools && easy_install pip yum install git
pip install shadowsocks git clone https://github.com/breakwa11/shadowsocks.git
Windows: Windows:
See [Install Server on Windows] git clone https://github.com/breakwa11/shadowsocks.git
### Usage ### Usage for single user on linux platform
ssserver -p 443 -k password -m aes-256-cfb If you clone it into "~/shadowsocks"
move to "~/shadowsocks", then run:
bash initcfg.sh
move to "~/shadowsocks/shadowsocks", then run:
python server.py -p 443 -k password -m aes-128-cfb -O auth_aes128_md5_compatible -o tls1.2_ticket_auth_compatible
Check all the options via `-h`.
You can also use a configuration file instead (recommand), move to "~/shadowsocks" and edit the file "user-config.json", then move to "~/shadowsocks/shadowsocks" again, just run:
python server.py
To run in the background: To run in the background:
sudo ssserver -p 443 -k password -m aes-256-cfb --user nobody -d start ./logrun.sh
To stop: To stop:
sudo ssserver -d stop ./stop.sh
To check the log: To monitor the log:
sudo less /var/log/shadowsocks.log ./tail.sh
Check all the options via `-h`. You can also use a [Configuration] file
instead.
Client Client
------ ------
@ -80,27 +89,17 @@ under the License.
Bugs and Issues Bugs and Issues
---------------- ----------------
* [Troubleshooting]
* [Issue Tracker] * [Issue Tracker]
* [Mailing list]
[Android]: https://github.com/shadowsocks/shadowsocks-android [Android]: https://github.com/shadowsocks/shadowsocks-android
[Build Status]: https://travis-ci.org/falseen/shadowsocks.svg?branch=manyuser-travis [Build Status]: https://travis-ci.org/falseen/shadowsocks.svg?branch=manyuser-travis
[Configuration]: https://github.com/shadowsocks/shadowsocks/wiki/Configuration-via-Config-File
[Coverage Status]: https://jenkins.shadowvpn.org/result/shadowsocks
[Coverage]: https://jenkins.shadowvpn.org/job/Shadowsocks/ws/PYENV/py34/label/linux/htmlcov/index.html
[Debian sid]: https://packages.debian.org/unstable/python/shadowsocks [Debian sid]: https://packages.debian.org/unstable/python/shadowsocks
[iOS]: https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help [iOS]: https://github.com/shadowsocks/shadowsocks-iOS/wiki/Help
[Issue Tracker]: https://github.com/shadowsocks/shadowsocks/issues?state=open [Issue Tracker]: https://github.com/breakwa11/shadowsocks/issues?state=open
[Install Server on Windows]: https://github.com/shadowsocks/shadowsocks/wiki/Install-Shadowsocks-Server-on-Windows
[Mailing list]: https://groups.google.com/group/shadowsocks
[OpenWRT]: https://github.com/shadowsocks/openwrt-shadowsocks [OpenWRT]: https://github.com/shadowsocks/openwrt-shadowsocks
[OS X]: https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help [OS X]: https://github.com/shadowsocks/shadowsocks-iOS/wiki/Shadowsocks-for-OSX-Help
[PyPI]: https://pypi.python.org/pypi/shadowsocks
[PyPI version]: https://img.shields.io/pypi/v/shadowsocks.svg?style=flat
[Travis CI]: https://travis-ci.org/falseen/shadowsocks [Travis CI]: https://travis-ci.org/falseen/shadowsocks
[Troubleshooting]: https://github.com/shadowsocks/shadowsocks/wiki/Troubleshooting [Windows]: https://github.com/breakwa11/shadowsocks-csharp
[Wiki]: https://github.com/shadowsocks/shadowsocks/wiki [Wiki]: https://github.com/breakwa11/shadowsocks-rss/wiki
[Windows]: https://github.com/shadowsocks/shadowsocks-csharp

7
initcfg.sh

@ -0,0 +1,7 @@
#!/bin/bash
chmod +x *.sh
chmod +x shadowsocks/*.sh
cp -n apiconfig.py userapiconfig.py
cp -n config.json user-config.json
Loading…
Cancel
Save