{"id":13623175,"url":"https://github.com/haxpor/Potatso","last_synced_at":"2025-04-15T14:32:21.099Z","repository":{"id":44903426,"uuid":"76630616","full_name":"haxpor/Potatso","owner":"haxpor","description":"Potatso is an iOS client that implements Shadowsocks proxy with the leverage of NetworkExtension framework. ***This project is unmaintained, try taking a look at this fork https://github.com/shadowcoel/shadowcoel instead.","archived":true,"fork":false,"pushed_at":"2018-10-01T00:54:23.000Z","size":29545,"stargazers_count":2046,"open_issues_count":53,"forks_count":1377,"subscribers_count":92,"default_branch":"master","last_synced_at":"2025-01-17T16:39:57.028Z","etag":null,"topics":["china","client","ios","network","proxy","shadowsocks","shadowsocks-client","ss","ssr"],"latest_commit_sha":null,"homepage":"","language":"Swift","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"gpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/haxpor.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null}},"created_at":"2016-12-16T07:08:26.000Z","updated_at":"2025-01-12T15:17:15.000Z","dependencies_parsed_at":"2022-08-30T23:51:38.672Z","dependency_job_id":null,"html_url":"https://github.com/haxpor/Potatso","commit_stats":null,"previous_names":[],"tags_count":6,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haxpor%2FPotatso","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haxpor%2FPotatso/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haxpor%2FPotatso/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/haxpor%2FPotatso/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/haxpor","download_url":"https://codeload.github.com/haxpor/Potatso/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249088968,"owners_count":21210896,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["china","client","ios","network","proxy","shadowsocks","shadowsocks-client","ss","ssr"],"created_at":"2024-08-01T21:01:28.884Z","updated_at":"2025-04-15T14:32:17.536Z","avatar_url":"https://github.com/haxpor.png","language":"Swift","funding_links":[],"categories":["Swift"],"sub_categories":[],"readme":"[![donate button](https://img.shields.io/badge/$-donate-ff69b4.svg?maxAge=2592000\u0026amp;style=flat)](https://github.com/haxpor/donate)\n\n![GPLv3 License](https://img.shields.io/badge/License-GPLv3-blue.svg)\n\n# Potatso \n\n## Important\n\nPlease read [this](https://github.com/haxpor/Potatso/blob/master/ADHERE_LICENSE.md) first before you do anything with this project.  \nIn short, you need to respect to license of the project. You cannot copy the source code and publish to App Store.\n\n---\n\n## What is it?\n\nPotatso is an iOS client that implements custom proxies with the leverage of Network Extension framework introduced by Apple since iOS 9.\n\nCurrently, Potatso is compatible with following proxies:\n\n- [Shadowsocks](https://shadowsocks.org)\n- [ShadowsocksR](https://github.com/breakwa11/shadowsocks-rss)\n\n[Subscribe Telegram Channel](https://telegram.me/potatso) to get updates of Potatso.  \n[Join Telegram Group](https://telegram.me/joinchat/BT0c4z49OGNZXwl9VsO0uQ) to chat with users.\n\nOriginal Author: [@icodesign](https://twitter.com/icodesign_me)  \nSwift 4 Maintainer: [@haxpor](https://twitter.com/haxpor)\n\n## Project Info\n\nPotatso has in total 26 dependencies as following\n\n* 20 Cocoapod dependencies\n* 4 submodules dependencies via local cocoapod\n\nThe project is tested with Xcode `9.4 (9F1027a)` on iOS `11.4 (15F79)` device with cocoapod version `1.4.0`+.  \nIf you experienced an expected issue, try to use those versions, if still experience the problem please file the issue.\n\nThe project will be further reduced for its dependencies.\n\n## How to Build Project\n\nPerform the following steps to be able to build the project.\nBe 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.\n\n1. `git clone https://github.com/haxpor/Potatso.git` or for faster using less time in cloning `git clone https://github.com/haxpor/Potatso.git --depth=1`\n2. `cd Potatso`\n3. `git submodule update --init` to update git submodule\n4. `pod install` to pull down dependencies into our project\n5. Open `Potatso.xcworkspace` then Build and Run the project. Done.\n\n\u003e First two steps are clearly listed here as per [#89](https://github.com/haxpor/Potatso/issues/89); if you download project as zip via Github web interface it will not have enough information to pull down required gitsubmodule, and step 3 will have error. So make sure you clone via command line, or using any git client application before proceeding.\n   \n## How To Contribute\n\nClone the project, make some changes or add a new feature, then make a pull request.\n\n## Acknowlegements\n\nWe use the following services or open-source libraries. So we'd like show them highest respect and thank for bringing those great projects:\n\n### Services\n\n- [Fabric](https://get.fabric.io/) -- currently not use anymore\n- [Reveal](http://revealapp.com/)\n- [realm](https://realm.io/)\n\n### Open-source Libraries\n\n- [KissXML](https://github.com/robbiehanson/KissXML)\n- [MMWormhole](https://github.com/mutualmobile/MMWormhole)\n- [CocoaAsyncSocket](https://github.com/robbiehanson/CocoaAsyncSocket)\n- [Cartography](https://github.com/robb/Cartography)\n- [AsyncSwift](https://github.com/duemunk/Async)\n- [Appirater](https://github.com/arashpayan/appirater)\n- [Eureka](https://github.com/xmartlabs/Eureka)\n- [MBProgressHUD](https://github.com/matej/MBProgressHUD)\n- [CallbackURLKit](https://github.com/phimage/CallbackURLKit)\n- [ISO8601DateFormatter](https://github.com/boredzo/iso-8601-date-formatter)\n- [Alamofire](https://github.com/Alamofire/Alamofire)\n- [ObjectMapper](https://github.com/Hearst-DD/ObjectMapper)\n- [CocoaLumberjack](https://github.com/CocoaLumberjack/CocoaLumberjack)\n- [AlamofireObjectMapper](https://github.com/tristanhimmelman/AlamofireObjectMapper)\n- [YAML.framework](https://github.com/mirek/YAML.framework)\n- [tun2socks-iOS](https://github.com/shadowsocks/tun2socks-iOS)\n- [shadowsocks-libev](https://github.com/shadowsocks/shadowsocks-libev)\n- [Antinat](http://antinat.sourceforge.net/)\n- [Privoxy](https://www.privoxy.org/)\n\n### Also we'd like to thank people that helped with the project\n\n- [@Blankwonder](https://twitter.com/Blankwonder)\n- [@龙七](#)\n- [@haxpor](https://twitter.com/haxpor)\n- TestFlight Users and [Telegram Group](https://telegram.me/joinchat/BT0c4z49OGNZXwl9VsO0uQ) users.\n\n### Donate\n- [@liqianyu](https://twitter.com/liqianyu)\n- [@anonymous](#) x2\n\n## Notice\n\nPotatso 2 was released on [App Store](https://itunes.apple.com/us/app/id1162704202?mt=8)  \nYou can purchase it from App Store, or still use Potatso by building it manually and installing to your device from this project.\n\nPlease note that Potatso 2 will be closed-source as stated from original author's reason. Read more from [here](https://github.com/haxpor/Potatso/blob/master/ADHERE_LICENSE.md).\n\n## Support Us\n\nThe development covers a lot of complicated work, costing not only money but also time.\nThese are the way to support\n\n- [Download Potatso 2 from Apple Store](https://itunes.apple.com/us/app/id1162704202?mt=8). (**Recommended**) \n- Donate with Alipay to original author. (Account: **leewongstudio.com@gmail.com**)\n- Donate to swift4 maintainer (WeChat: http://imgur.com/lsAao62, or PayPal: haxpor@gmail.com)\n\n## License\n\n**You cannot just copy the project, and publish to App Store.**  Please read [this](https://github.com/haxpor/Potatso/blob/master/ADHERE_LICENSE.md) first.\n\n--\n\nTo be compatible with those libraries using GPL, we're distributing with GPLv3 license.\n\nThis 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.\n\nThis 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.\n\nYou should have received a copy of the GNU General Public License along with this program. If not, see http://www.gnu.org/licenses/.\n\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaxpor%2FPotatso","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fhaxpor%2FPotatso","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fhaxpor%2FPotatso/lists"}