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

• 28 Cocoapod dependencies
• 1 Carthage dependency
• 4 submodules dependencies

The project is tested with Xcode 8.2 (8C38) on iOS 10.2 (14C92) device with cocoapod version 1.1.1+, and carthage version 0.18.1.
If you experienced an expected issue, try to use those versions.

Change log

You can take a look at Change log for changes that has made for specific commit that has significant updates. Thus you can freely decide whether you want to rebuild Potatso to include such update or not.

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.

1. git submodule update --init to update git submodule
2. pod install to pull down dependencies into our project
3. carthage update to pull down dependencies into Carthage/Checkouts folder and build each one
4. Open Potatso.xcworkspace then Build and Run the project. Done.

Build Notices

If you try to build for iOS 10.3, please try to use XCode Version 8.3 (8E162) onwards and only for release version.

Code Notices

There're a couple of issues that needed to look at, but after testing, it does not affect the functionality of the app.

• In file Potatso/Core/API.swift, it's the following code focusing on line with comment that I can't figure it out yet how to migrate it to Swift 3 code.

  var JSONToMap: AnyObject?
  if let keyPath = keyPath, keyPath.isEmpty == false {
      //JSONToMap = (result.value? as AnyObject).value(forKeyPath: keyPath)
      JSONToMap = nil
  } else {
      JSONToMap = result.value as AnyObject?
  }

• Potatso core code depends on version 1.7.0 of Eureka with manual migration to Swift 3. It's already done and linked to project. But you will see observeValue() function in Eureka/Source/Rows/PostalAddressRow.swift that has been commented for all of its function code due to Eureka's newer version 2.0.0-beta.1 doesn't include such file in the project anymore, but it still works with no problem. This note is meant to mark that there is going to be a lot of effort if we decide to depend on Eureka version 2.0.0-beta.1 as we need to change a lot of Potatso core code.

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

• Fabric
• Reveal
• realm
• HelpShift

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: leewongstudio.com@gmail.com)
• Donate to swift3 maintainer (WeChat: http://imgur.com/lsAao62, or PayPal: haxpor@gmail.com)

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/.