{"id":19865788,"url":"https://github.com/Jigsaw-Code/outline-go-tun2socks","last_synced_at":"2025-05-02T05:32:02.889Z","repository":{"id":36300949,"uuid":"178941656","full_name":"Jigsaw-Code/outline-go-tun2socks","owner":"Jigsaw-Code","description":null,"archived":true,"fork":false,"pushed_at":"2024-05-06T02:42:37.000Z","size":62511,"stargazers_count":231,"open_issues_count":10,"forks_count":94,"subscribers_count":23,"default_branch":"master","last_synced_at":"2024-11-12T15:30:54.696Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/Jigsaw-Code.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":"CONTRIBUTING.md","funding":null,"license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":".github/CODEOWNERS","security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2019-04-01T20:27:23.000Z","updated_at":"2024-11-10T00:10:00.000Z","dependencies_parsed_at":"2024-01-12T23:22:31.415Z","dependency_job_id":"90ca0e64-3ef7-456e-a882-7f8e75a74188","html_url":"https://github.com/Jigsaw-Code/outline-go-tun2socks","commit_stats":null,"previous_names":[],"tags_count":13,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jigsaw-Code%2Foutline-go-tun2socks","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jigsaw-Code%2Foutline-go-tun2socks/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jigsaw-Code%2Foutline-go-tun2socks/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Jigsaw-Code%2Foutline-go-tun2socks/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Jigsaw-Code","download_url":"https://codeload.github.com/Jigsaw-Code/outline-go-tun2socks/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":251992993,"owners_count":21677022,"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":[],"created_at":"2024-11-12T15:24:12.612Z","updated_at":"2025-05-02T05:31:58.234Z","avatar_url":"https://github.com/Jigsaw-Code.png","language":"Go","funding_links":[],"categories":["Go"],"sub_categories":[],"readme":"# outline-go-tun2socks\n\n\u003e [!WARNING]  \n\u003e This repository is no longer being maintained. The tun2socks source is now maintained in the [outline-apps repository](https://github.com/Jigsaw-Code/outline-apps/tree/master) and [Intra repository](https://github.com/Jigsaw-Code/Intra/tree/master/Android/app/src/go).\n\nGo package for building [go-tun2socks](https://github.com/eycorsican/go-tun2socks)-based clients for [Outline](https://getoutline.org) and [Intra](https://getintra.org) (now with support for [Choir](https://github.com/Jigsaw-Code/choir) metrics).  For macOS, iOS, and Android, the output is a library; for Linux and Windows it is a command-line executable.\n\n## Prerequisites\n\n- macOS host (iOS, macOS)\n- make\n- Go \u003e= 1.18\n- A C compiler (e.g.: clang, gcc)\n\n## Android\n\n### Set up\n\n- [sdkmanager](https://developer.android.com/studio/command-line/sdkmanager)\n  1. Download the command line tools from https://developer.android.com/studio.\n  1. Unzip the pacakge as `~/Android/Sdk/cmdline-tools/latest/`. Make sure `sdkmanager` is located at `~/Android/Sdk/cmdline-tools/latest/bin/sdkmanager`\n- Android NDK 23\n  1. Install the NDK with `~/Android/Sdk/cmdline-tools/latest/bin/sdkmanager \"platforms;android-30\" \"ndk;23.1.7779620\"` (platform from [outline-client](https://github.com/Jigsaw-Code/outline-client#building-the-android-app), exact NDK 23 version obtained from `sdkmanager --list`)\n  1. Set up the environment variables:\n     ```\n     export ANDROID_NDK_HOME=~/Android/Sdk/ndk/23.1.7779620 ANDROID_HOME=~/Android/Sdk\n     ```\n- [gomobile](https://pkg.go.dev/golang.org/x/mobile/cmd/gobind) (installed as needed by `make`)\n\n### Build\n\n```bash\nmake clean \u0026\u0026 make android\n```\nThis will create `build/android/{tun2socks.aar,tun2socks-sources.jar}`\n\nIf needed, you can extract the jni files into `build/android/jni` with:\n```bash\nunzip build/android/tun2socks.aar 'jni/*' -d build/android\n```\n\n## Apple (iOS and macOS)\n\n### Set up\n\n- Xcode\n- [gomobile](https://pkg.go.dev/golang.org/x/mobile/cmd/gobind) (installed as needed by `make`)\n\n\n### Build\n```\nmake clean \u0026\u0026 make apple\n```\nThis will create `build/apple/Tun2socks.xcframework`.\n\n## Linux and Windows\n\nWe build binaries for Linux and Windows from source without any custom integrations. `xgo` and Docker are required to support cross-compilation.\n\n### Set up\n\n- [Docker](https://docs.docker.com/get-docker/) (for xgo)\n- [xgo](https://github.com/crazy-max/xgo) (installed as needed by `make`)\n- [ghcr.io/crazy-max/xgo Docker image](https://github.com/crazy-max/xgo/pkgs/container/xgo). This is pulled automatically by xgo and takes ~6.8 GB of disk space.\n\n## Build\n\nFor Linux:\n```\nmake clean \u0026\u0026 make linux\n```\nThis will create `build/linux/tun2socks`.\n\nFor Windows:\n```\nmake clean \u0026\u0026 make windows\n```\nThis will create `build/windows/tun2socks.exe`.\n\n## Intra (Android)\n\nSame set up as for the Outline Android library.\n\nBuild with:\n\n```bash\nmake clean \u0026\u0026 make intra\n```\nThis will create `build/intra/{tun2socks.aar,tun2socks-sources.jar}`\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJigsaw-Code%2Foutline-go-tun2socks","html_url":"https://awesome.ecosyste.ms/projects/github.com%2FJigsaw-Code%2Foutline-go-tun2socks","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2FJigsaw-Code%2Foutline-go-tun2socks/lists"}