Potatso

Important

Please read this first before you do anything with this project.
In short, you need to respect to license of the project. You cannot copy the source code and publish to App Store.

---

What is it?

Potatso is an iOS client that implements custom proxies with the leverage of Network Extension framework introduced by Apple since iOS 9.

Currently, Potatso is compatible with following proxies:

• Shadowsocks
• ShadowsocksR

Subscribe Telegram Channel to get updates of Potatso.
Join Telegram Group to chat with users.

Original Author: @icodesign
Swift 3 Maintainer: @haxpor

Project Info

Potatso has in total 33 (2 as submodules dependencies as used as local file in Cocoapod) dependencies as following

• 20 Cocoapod dependencies
• 9 submodules dependencies

The project is tested with Xcode 9.2 (9C40B) on iOS 11.2 (15B92) device with cocoapod version 1.3.1+, and carthage version 0.18.1.
If you experienced an expected issue, try to use those versions, if still experience the problem please file the issue.

How to Build Project

Perform the following steps to be able to build the project. Be warned that you should not call pod update as newer version of pod frameworks that Potatso depends on might break building process and there will be errors.

git clone https://github.com/ssrlive/iShadowsocksR.git
cd iShadowsocksR
git submodule update --init --recursive    # update git submodules
sudo gem install cocoapods
pod install                                # pull down dependencies into our project
cd Library/openssl
./build-libssl.sh                          # build OpenSSL library

Then open iShadowsocksR.xcworkspace with Xcode to Build and Run the project. Done.

Tips

• If you are a China mainland developer, you must set your git with proxy, such as SOCKS5 etc., or you can not pull some submodules because of GFW. Like this:

# Enable Proxy settings
git config --global http.proxy socks5://127.0.0.1:1080
git config --global https.proxy socks5://127.0.0.1:1080

# Disable Proxy settings
git config --global --unset-all

• You must have an Apple Developer account with an annual fee of $99.
• To compile the app running on your iOS device, you must search the project for the com.ssrlive.issr identifier string and replace it with your own identifier string.

How To Contribute

Clone the project, make some changes or add a new feature, then make a pull request.

Acknowlegements

We use the following services or open-source libraries. So we'd like show them highest respect and thank for bringing those great projects:

Services

• realm

Open-source Libraries

• KissXML
• MMWormhole
• CocoaAsyncSocket
• Cartography
• AsyncSwift
• Appirater
• Eureka
• MBProgressHUD
• CallbackURLKit
• ISO8601DateFormatter
• Alamofire
• ObjectMapper
• CocoaLumberjack
• AlamofireObjectMapper
• YAML.framework
• tun2socks-iOS
• shadowsocks-libev
• Antinat
• Privoxy

Also we'd like to thank people that helped with the project

• @Blankwonder
• @龙七
• @haxpor
• TestFlight Users and Telegram Group users.

Donate

• @liqianyu
• @anonymous x2

Notice

Potatso 2 was released on App Store
You can purchase it from App Store, or still use Potatso by building it manually and installing to your device from this project.

Please note that Potatso 2 will be closed-source as stated from original author's reason. Read more from here.

Support Us

The development covers a lot of complicated work, costing not only money but also time. These are the way to support

• Download Potatso from Apple Store. (Recommended)
• Donate with Alipay to original author. (Account: [email protected])
• Donate to swift3 maintainer (WeChat: http://imgur.com/lsAao62, or PayPal: [email protected])

License

You cannot just copy the project, and publish to App Store. Please read this first.

--

To be compatible with those libraries using GPL, we're distributing with GPLv3 license.

This program is free software: you can redistribute it and/or modify it under the terms of the GNU General Public License as published by the Free Software Foundation, either version 3 of the License, or (at your option) any later version.

This program is distributed in the hope that it will be useful, but WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for more details.

You should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.