{"id":13436424,"url":"https://github.com/changlan/kytan","last_synced_at":"2025-03-18T21:30:31.905Z","repository":{"id":45684698,"uuid":"50458237","full_name":"changlan/kytan","owner":"changlan","description":"kytan: High Performance Peer-to-Peer VPN in Rust","archived":false,"fork":false,"pushed_at":"2023-10-16T07:35:20.000Z","size":121,"stargazers_count":458,"open_issues_count":13,"forks_count":59,"subscribers_count":16,"default_branch":"master","last_synced_at":"2024-04-22T13:31:37.320Z","etag":null,"topics":["censorship-circumvention","rust","vpn"],"latest_commit_sha":null,"homepage":"","language":"Rust","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/changlan.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,"governance":null,"roadmap":null,"authors":null}},"created_at":"2016-01-26T20:50:14.000Z","updated_at":"2024-04-14T09:50:28.000Z","dependencies_parsed_at":"2024-01-07T21:53:54.789Z","dependency_job_id":"e67dd6d4-dbed-4df2-9b89-5f2ae3fd350b","html_url":"https://github.com/changlan/kytan","commit_stats":null,"previous_names":["changlan/mangi"],"tags_count":4,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/changlan%2Fkytan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/changlan%2Fkytan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/changlan%2Fkytan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/changlan%2Fkytan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/changlan","download_url":"https://codeload.github.com/changlan/kytan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":244310266,"owners_count":20432504,"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":["censorship-circumvention","rust","vpn"],"created_at":"2024-07-31T03:00:48.019Z","updated_at":"2025-03-18T21:30:29.199Z","avatar_url":"https://github.com/changlan.png","language":"Rust","funding_links":[],"categories":["Applications","应用","应用 Applications","Rust","应用程序 Applications"],"sub_categories":["贡献"],"readme":"[![Build Status](https://travis-ci.org/changlan/kytan.svg?branch=master)](https://travis-ci.org/changlan/kytan)\n[![codecov](https://codecov.io/gh/changlan/kytan/branch/master/graph/badge.svg)](https://codecov.io/gh/changlan/kytan)\n\n## kytan: High Performance Peer-to-Peer VPN\n\n`kytan` is a high performance peer to peer VPN written in Rust. The goal is to\nto minimize the hassle of configuration and deployment with a goal of\nmulti-platform support.\n\n### Supported Platforms\n\n- Linux\n- macOS (Client mode only)\n\n### Installation\n\nCurrently, precompiled `kytan` binaries are available for Linux and macOS.\nYou can download them from [releases](https://github.com/changlan/kytan/releases).\n\nAlternatively, you can compile it from source if\nyour machine is installed with [Rust](https://www.rust-lang.org/en-US/install.html).\n\n```\n$ git clone https://github.com/changlan/kytan.git\n$ cd kytan\n$ cargo build --release\n```\n\n### Running `kytan`\n\nFor complete information:\n\n```\n$ sudo ./kytan -h\n```\n\n#### Server Mode\n\nLike any other VPN server, you need to configure `iptables` as following to make\nsure IP masquerading (or NAT) is enabled, which should be done only once. In the\nfuture, `kytan` will automate these steps. You may change `\u003cINTERFACE\u003e` to the\ninterface name on your server (e.g. `eth0`):\n\n```\n$ sudo iptables -t nat -A POSTROUTING -s 10.10.10.0/24 -o \u003cINTERFACE\u003e -j MASQUERADE\n```\n\nTo run `kytan` in server mode and listen on UDP port `9527` with password `hello`:\n\n```\n$ sudo ./kytan server -k hello \n```\nIf you want open log display (`info` is log level, you can change it by your idea)\n\n```\n$ sudo RUST_LOG=info ./kytan server -k hello \n```\n\n#### Client Mode\n\nTo run `kytan` in client mode and connect to the server `\u003cSERVER\u003e:9527` using password `hello`:\n\n```\n$ sudo ./kytan client -s \u003cSERVER\u003e -p 9527 -k hello\n```\n\nif you want open log display (`info` is log level, you can change it by your idea)\n\n```\n$ sudo RUST_LOG=info ./kytan client -s \u003cSERVER\u003e -p 9527 -k hello\n```\n\n### License\n\nApache 2.0\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchanglan%2Fkytan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fchanglan%2Fkytan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fchanglan%2Fkytan/lists"}