{"id":13649016,"url":"https://github.com/tunfish/tunfish-vxlan","last_synced_at":"2025-04-22T12:33:02.022Z","repository":{"id":117708088,"uuid":"127375476","full_name":"tunfish/tunfish-vxlan","owner":"tunfish","description":"A proof-of-concept for creating convenient VPN environments on top of secure WireGuard tunnels, with VXLAN.","archived":false,"fork":false,"pushed_at":"2019-02-22T23:31:31.000Z","size":61,"stargazers_count":25,"open_issues_count":0,"forks_count":1,"subscribers_count":3,"default_branch":"master","last_synced_at":"2024-08-03T01:39:25.324Z","etag":null,"topics":["encryption","noise-protocol-framework","privacy","vpn","vpn-manager","vpn-service","vxlan","vxlan-interface","wireguard"],"latest_commit_sha":null,"homepage":"https://tunfish.org/","language":"Shell","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"agpl-3.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/tunfish.png","metadata":{"files":{"readme":"README.rst","changelog":"CHANGES.rst","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":"2018-03-30T03:13:47.000Z","updated_at":"2024-06-24T12:12:05.000Z","dependencies_parsed_at":null,"dependency_job_id":"43482dd0-84ab-4595-a7f4-a376ba611907","html_url":"https://github.com/tunfish/tunfish-vxlan","commit_stats":null,"previous_names":[],"tags_count":2,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunfish%2Ftunfish-vxlan","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunfish%2Ftunfish-vxlan/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunfish%2Ftunfish-vxlan/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/tunfish%2Ftunfish-vxlan/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/tunfish","download_url":"https://codeload.github.com/tunfish/tunfish-vxlan/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":223896472,"owners_count":17221441,"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":["encryption","noise-protocol-framework","privacy","vpn","vpn-manager","vpn-service","vxlan","vxlan-interface","wireguard"],"created_at":"2024-08-02T01:04:42.367Z","updated_at":"2024-11-09T23:30:48.858Z","avatar_url":"https://github.com/tunfish.png","language":"Shell","funding_links":[],"categories":["Shell","vpn"],"sub_categories":[],"readme":".. image:: https://img.shields.io/github/tag/tunfish/tunfish-sandbox.svg\n    :target: https://github.com/tunfish/tunfish-sandbox\n.. image:: https://img.shields.io/badge/platform-Linux%20%7C%20OpenWRT%20%7C%20LEDE-blue.svg\n    :target: #\n.. image:: https://img.shields.io/badge/technologies-WireGuard%20%7C%20Netlink%20%7C%20AMQP%20%7C%20Websocket-blue.svg\n    :target: #\n\n|\n\n.. image:: https://ptrace.tunfish.org/thunfisch-160.jpg\n    :target: #\n\n\n###############\nTunfish Sandbox\n###############\n\n*****\nAbout\n*****\nA proof-of-concept for creating convenient VPN environments\non top of secure WireGuard_ tunnels.\n\nThis runbook will guide you through the process of setting\nup an appropriate testbed environment. It will provision\na number of Vagrant machines and configure them to talk\nto each other over a software-defined secure private network.\n\nAfter that, you will easily be able to conduct connectivity\ntests and continue with further experiments.\n\n\n*****\nSetup\n*****\nThis section will guide you through setting up\na development/testing sandbox on your machine.\n\nAcquire source repository::\n\n    git clone https://github.com/tunfish/tunfish-sandbox\n\nInstall requirements on Mac OS X using Homebrew::\n\n    ./requirements-macosx.sh\n\nMake Vagrant provision and spin up all machines configured in this environment::\n\n    vagrant up\n\n\n**************\nNetwork layout\n**************\nThere are three machines ``\"tf-portier\"``, ``\"tf-gateway-1\"`` and\n``\"tf-client-1\"``, completely provisioned by Vagrant.\n\nHere is a short overview as an introduction.\nPlease read this section carefully.\n\n\nMachines\n========\nThe Vagrant network \"192.168.50.0/24\".\n::\n\n    192.168.50.1        The hypervisor host on its \"vboxnet0\" interface\n    192.168.50.70       Portier server\n    192.168.50.71       Gateway server 1\n    192.168.50.80       Client 1\n\n\n*****\nUsage\n*****\n\nLogin to each virtual machine::\n\n    vagrant ssh tf-portier\n    vagrant ssh tf-gateway-1\n    vagrant ssh tf-client-1\n\n\n***********\nDevelopment\n***********\nTo repeat the virtual machine provisioning, run::\n\n    vagrant up --provision\n\nTo reprovision just a single host, use::\n\n    vagrant up --provision tf-portier\n\nThe source code directory ``./src`` will be mounted into each\nvirtual machine at ``/opt/tunfish-sandbox`` for convenient live\nediting.\n\n\n*******************\nProject information\n*******************\n\nAbout\n=====\nThe \"Tunfish sandbox\" spike is released under the GNU AGPL license.\nIts source code lives on `GitHub \u003chttps://github.com/tunfish/tunfish-sandbox\u003e`_.\nYou might also want to have a look at the `documentation \u003chttps://tunfish.org/doc/sandbox/\u003e`_.\n\nIf you'd like to contribute you're most welcome!\nSpend some time taking a look around, locate a bug, design issue or\nspelling mistake and then send us a pull request or create an issue.\n\nThanks in advance for your efforts, we really appreciate any help or feedback.\n\nLicense\n=======\nLicensed under the GNU AGPL license. See LICENSE_ file for details.\n\n.. _LICENSE: https://github.com/tunfish/tunfish-sandbox/blob/master/LICENSE\n\n\n\n****************\nAcknowledgements\n****************\n\nTunfish would not have been possible without these awesome people:\n\n- Jason Donenfeld for conceiving and building WireGuard_. After reading\n  the introduction `[RFC] WireGuard: next generation secure network tunnel`_\n  in late 2016 and quickly scanning his `paper about WireGuard`_, nobody\n  wondered that WireGuard rapidly gained attraction.\n\n- Mitchell Hashimoto, Chris Roberts and the countless other `contributors to Vagrant`_\n  for conceiving and maintaining Vagrant_.\n\n- Michael DeHaan, James Cammarata, Toshio Kuratomi, Brian Coca, Matt Clay, Dag Wieers\n  and the countless other `contributors to Ansible`_ for conceiving and maintaining Ansible_.\n\n- Countless other authors of packages from the Python\n  ecosystem and beyond for gluing everything together.\n\nThank you so much for providing such great infrastructure\ncomponents and resources to the community! You know who you are.\n\n\n***************\nTroubleshooting\n***************\nIf you encounter any problems during setup, we may humbly\nrefer you to the `\u003cdoc/troubleshooting.rst\u003e`_ documentation.\n\n\n----\n\nHave fun!\n\n\n.. _WireGuard: https://www.wireguard.com/\n\n.. _[RFC] WireGuard\\: next generation secure network tunnel: https://lkml.org/lkml/2016/6/28/629\n.. _paper about WireGuard: https://www.wireguard.com/papers/wireguard.pdf\n\n.. _Ansible role to deploy a wireguard server: https://github.com/botto/ansible-wireguard\n.. _Vagrant: https://www.vagrantup.com/\n.. _Ansible: https://www.ansible.com/\n.. _contributors to Vagrant: https://github.com/hashicorp/vagrant/graphs/contributors\n.. _contributors to Ansible: https://github.com/ansible/ansible/graphs/contributors\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunfish%2Ftunfish-vxlan","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ftunfish%2Ftunfish-vxlan","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ftunfish%2Ftunfish-vxlan/lists"}