{"id":16854475,"url":"https://github.com/neilalexander/vyatta-quicktun","last_synced_at":"2025-04-11T07:14:25.851Z","repository":{"id":142003612,"uuid":"84766615","full_name":"neilalexander/vyatta-quicktun","owner":"neilalexander","description":"A quicktun package for Ubiquiti EdgeOS","archived":false,"fork":false,"pushed_at":"2018-02-28T18:17:14.000Z","size":101,"stargazers_count":7,"open_issues_count":0,"forks_count":1,"subscribers_count":2,"default_branch":"master","last_synced_at":"2025-03-25T04:52:22.823Z","etag":null,"topics":["edgerouter","nacl0","nacltai","quicktun","salty","tunnel","ubiquiti-edgeos","vpn","vyatta"],"latest_commit_sha":null,"homepage":"","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":null,"status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/neilalexander.png","metadata":{"files":{"readme":"README.md","changelog":null,"contributing":null,"funding":null,"license":null,"code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null}},"created_at":"2017-03-13T00:03:07.000Z","updated_at":"2022-01-09T14:44:08.000Z","dependencies_parsed_at":"2023-07-22T01:49:37.650Z","dependency_job_id":null,"html_url":"https://github.com/neilalexander/vyatta-quicktun","commit_stats":null,"previous_names":[],"tags_count":0,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neilalexander%2Fvyatta-quicktun","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neilalexander%2Fvyatta-quicktun/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neilalexander%2Fvyatta-quicktun/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/neilalexander%2Fvyatta-quicktun/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/neilalexander","download_url":"https://codeload.github.com/neilalexander/vyatta-quicktun/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":248358603,"owners_count":21090405,"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":["edgerouter","nacl0","nacltai","quicktun","salty","tunnel","ubiquiti-edgeos","vpn","vyatta"],"created_at":"2024-10-13T13:55:26.404Z","updated_at":"2025-04-11T07:14:25.833Z","avatar_url":"https://github.com/neilalexander.png","language":"Shell","funding_links":[],"categories":[],"sub_categories":[],"readme":"# QuickTun for Ubiquiti EdgeOS\n\n### Introduction\n\nThis is a QuickTun distributable package for Ubiquiti EdgeOS, providing support for QuickTun TUN interfaces through the EdgeOS CLI.\n\n### Compatibility\n\n|                       | Architecture | Compatible |                      Notes                     |\n|-----------------------|:------------:|:----------:|:----------------------------------------------:|\n|    EdgeRouter X (ERX) |    mipsel    |     Yes    | Builds with crossbuild-essential, see below    |\n\n### Building for EdgeRouter X\n\nOn 64-bit Debian Jessie, start by installing the toolchain:\n```\necho \"deb http://emdebian.org/tools/debian/ jessie main\" \u003e\u003e /etc/apt/sources.list\n\nwget http://emdebian.org/tools/debian/emdebian-toolchain-archive.key\napt-key add emdebian-toolchain-archive.key\n\ndpkg --add-architecture mipsel\napt-get update\napt-get install crossbuild-essential-mipsel\n```\nCompile the package then by cloning the repository and running 'make':\n```\nPREFIX='mipsel-linux-gnu-' PKGARCH='mipsel' make -e\n```\nThe package `vyatta-quicktun.deb` will be created in the parent directory. Copy it to the EdgeRouter and install it:\n```\nsudo dpkg -i vyatta-quicktun.deb\n```\n\n### Creating an interface\n\nCreate the interface by specifying protocol (either `raw`, `nacl0`, `nacltai` or `salty`), remote and local endpoints and your peer's public key:\n```\nconfigure\nset interfaces quicktun tun0 description \"QuickTun Tunnel\"\nset interfaces quicktun tun0 protocol salty\nset interfaces quicktun tun0 local address 1.1.1.1\nset interfaces quicktun tun0 local port 1111\nset interfaces quicktun tun0 remote address 2.2.2.2\nset interfaces quicktun tun0 remote port 2222\nset interfaces quicktun tun0 remote public-key XXXXXXXXXX\ncommit\n```\nYour own keypair will automatically be generated if not specified. You can retrieve your keypair:\n```\nconfigure\nshow interfaces quicktun tun0 local private-key\nshow interfaces quicktun tun0 local public-key\n```\nYour private key is secret. Do not share it. Send your public key to your peer.\n\n### Set tunnel interface addresses\n\nAdd IPv4 or IPv6 addresses to the virtual tunnel interface:\n```\nconfigure\nset interfaces quicktun tun0 tunnel address 3.3.3.3/24\nset interfaces quicktun tun0 tunnel address fd33:3333:3333:3333::3/64\ncommit\n```\n\n### Set firewall rules\n\nSet any combination of firewall chains to be active on the virtual tunnel interface:\n```\nconfigure\nset interfaces quicktun tun0 firewall in name CHAIN-IPv4-IN\nset interfaces quicktun tun0 firewall local name CHAIN-IPv4-LOCAL\nset interfaces quicktun tun0 firewall out name CHAIN-IPv4-OUT\nset interfaces quicktun tun0 firewall in ipv6-name CHAIN-IPv6-IN\nset interfaces quicktun tun0 firewall local ipv6-name CHAIN-IPv6-LOCAL\nset interfaces quicktun tun0 firewall out ipv6-name CHAIN-IPv6-OUT\ncommit\n```\n\n### Restart quicktun\n\nIn operational view, you can restart the quicktun process associated with an interface:\n```\nrestart quicktun tun0\n```\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneilalexander%2Fvyatta-quicktun","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fneilalexander%2Fvyatta-quicktun","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fneilalexander%2Fvyatta-quicktun/lists"}