{"id":18308186,"url":"https://github.com/cypherpunkarmory/holepunch","last_synced_at":"2025-10-23T18:48:47.557Z","repository":{"id":54680600,"uuid":"172134722","full_name":"CypherpunkArmory/holepunch","owner":"CypherpunkArmory","description":"Holepunch API","archived":false,"fork":false,"pushed_at":"2019-11-02T06:32:47.000Z","size":1202,"stargazers_count":61,"open_issues_count":4,"forks_count":9,"subscribers_count":8,"default_branch":"master","last_synced_at":"2025-03-21T08:11:12.543Z","etag":null,"topics":["python","rest-api","reverse-tunnel"],"latest_commit_sha":null,"homepage":"","language":"Python","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/CypherpunkArmory.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":"2019-02-22T21:07:33.000Z","updated_at":"2025-02-13T14:15:59.000Z","dependencies_parsed_at":"2022-08-13T23:50:34.714Z","dependency_job_id":null,"html_url":"https://github.com/CypherpunkArmory/holepunch","commit_stats":null,"previous_names":[],"tags_count":24,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CypherpunkArmory%2Fholepunch","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CypherpunkArmory%2Fholepunch/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CypherpunkArmory%2Fholepunch/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/CypherpunkArmory%2Fholepunch/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/CypherpunkArmory","download_url":"https://codeload.github.com/CypherpunkArmory/holepunch/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247374988,"owners_count":20928926,"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":["python","rest-api","reverse-tunnel"],"created_at":"2024-11-05T16:07:02.268Z","updated_at":"2025-10-23T18:48:42.521Z","avatar_url":"https://github.com/CypherpunkArmory.png","language":"Python","funding_links":[],"categories":[],"sub_categories":[],"readme":"[![Codacy Badge](https://api.codacy.com/project/badge/Grade/62df8afdbbe64aeb92e32be409932f6e)](https://www.codacy.com/app/CypherpunkArmory/holepunch?utm_source=github.com\u0026amp;utm_medium=referral\u0026amp;utm_content=CypherpunkArmory/holepunch\u0026amp;utm_campaign=Badge_Grade)\n[![Codacy Badge](https://api.codacy.com/project/badge/Coverage/62df8afdbbe64aeb92e32be409932f6e)](https://www.codacy.com/app/CypherpunkArmory/holepunch?utm_source=github.com\u0026utm_medium=referral\u0026utm_content=CypherpunkArmory/holepunch\u0026utm_campaign=Badge_Coverage)\n[![CircleCI](https://circleci.com/gh/CypherpunkArmory/holepunch.svg?style=svg)](https://circleci.com/gh/CypherpunkArmory/holepunch)\n# Holepunch\n\nThis is the code used to run [api.holepunch.io](https://api.holepunch.io) \u003cbr/\u003e\nVisit [holepunch.io](https://holepunch.io) to find out more\n\n# Setting Up\n\nThe holepunch nomad cluster requires a loopback alias in order to communicate\nwith containers running on the MacOS version of docker.\n\nIf you are running on a Mac, you can create this loopback alias at\n172.16.123.1 by running `task setup_net`\n\nIf you are running locally, you will need to set the sshendpoint in your `.punch.toml`\nfile to this address as well.\n\nThis step is not necessary for running on Linux - but you will probably need\nto change the `SEA_HOST` environment variable to your local IP.\n\n1. You will need a dockerhub account to run the app.\n2. Create a virtualenv (using pyenv) called \"holepunch\" based on Python 3.7.0\n3. Install go-task via homebrew\n4. Run `task setup_local setup_net`\n5. Run the tests  `docker-compose run web pytest`\n\n# Common Commands\n\n## Run Flask Shell\n\n`docker-compose run -e \"FLASK_APP=app:create_app('development')\" web python -m flask shell`\n\n## Exec into a container\n\nMost of the containers do not have bash so you'll need to use regular old sh.\n\n`docker ps` -\u003e note the _container id_\n`docker exec -it \u003ccontainer_id\u003e /bin/sh`\n\n\n# Deploying Holepunch\n\nContributors and Holepunch Developers\n\n1. Spin up a pushbutton environment using Grid.\n2. Login to the Pushbutton VPN\n3. Cd into the deploy directory and create a holepunch workspace with the _same\n   name_ as your Pusbutton\n4. Push a release to Docker Hub - for development it will deploy a tag with\n   your branch name.  If you're on master, it will create a tag release.\n5. task deploy WORKSPACE=\u003cyour workspace name\u003e\n  - If you are on master it will create new tags incremented by 0.0.1 and\n    release those\n  - You can specify a version using the VER variable.\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcypherpunkarmory%2Fholepunch","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fcypherpunkarmory%2Fholepunch","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fcypherpunkarmory%2Fholepunch/lists"}