{"id":22608898,"url":"https://github.com/bitfinexcom/hypertele","last_synced_at":"2025-04-11T06:14:06.802Z","repository":{"id":43256856,"uuid":"424948107","full_name":"bitfinexcom/hypertele","owner":"bitfinexcom","description":"A swiss-knife proxy powered by Hyperswarm DHT","archived":false,"fork":false,"pushed_at":"2025-04-07T13:48:37.000Z","size":72,"stargazers_count":24,"open_issues_count":3,"forks_count":8,"subscribers_count":8,"default_branch":"main","last_synced_at":"2025-04-07T14:39:51.994Z","etag":null,"topics":["hyperswarm","p2p","peer-to-peer"],"latest_commit_sha":null,"homepage":"","language":"JavaScript","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/bitfinexcom.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":"2021-11-05T12:55:18.000Z","updated_at":"2025-04-07T13:48:41.000Z","dependencies_parsed_at":"2024-01-02T16:32:08.602Z","dependency_job_id":"68962147-35d1-48f2-b60e-ad2009991121","html_url":"https://github.com/bitfinexcom/hypertele","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/bitfinexcom%2Fhypertele","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fhypertele/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fhypertele/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/bitfinexcom%2Fhypertele/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/bitfinexcom","download_url":"https://codeload.github.com/bitfinexcom/hypertele/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":247675205,"owners_count":20977371,"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":["hyperswarm","p2p","peer-to-peer"],"created_at":"2024-12-08T15:10:01.630Z","updated_at":"2025-04-11T06:14:06.779Z","avatar_url":"https://github.com/bitfinexcom.png","language":"JavaScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# hypertele\n\nA swiss-knife proxy powered by [HyperDHT](https://github.com/holepunchto/hyperdht)!\n\n## Installation\n```\nnpm install -g hypertele // hyperdht server proxy\nnpm install -g hyper-cmd-utils // keygen utils\n```\n\n## Server\n\nStandard pipe server\n\n```sh\nhypertele-server --help\n```\n\n**Create a JSON config file for your server**\n```\n{\n  \"seed\": \"SEED\",\n  \"allow\": [\n    \"CLIENT_PEER_KEY\",\n    ...\n  ]\n}\n```\n\n```\noptions:\n\n-l PORT : port of the service you want to expose to the peers\n--address ADDRESS : IP of the service you want to expose to the peers\n--cert-skip : skip certificate check when connecting to the service\n--seed SEED : seed (command-line)\n--compress : enable chunk compression\n--private : make the proxy private (do not leak the access capability to the DHT)\n```\n\n```sh\nexamples:\n\nhypertele-server -l 22 -c config-server.json\nhypertele-server -l 22 --seed XXX\n```\n\nNote: the command will print out the pubkey\n\n\n## Pub\n\nPub server\n\n```sh\nhypertele-pub --help\n```\n\n**Create a JSON config file for your server**\n```\n{\n  \"seed\": \"SEED\",\n  \"allow\": [\n    \"CLIENT_PEER_KEY\",\n    ...\n  ]\n}\n```\n\n```\noptions:\n\n-l PORT : port of the service you want to expose to the peers\n--address ADDRESS : IP of the service you want to expose to the peers\n--seed SEED : seed (command-line)\n--compress : enable chunk compression\n```\n\n```sh\nexamples:\n\nhypertele-pub -l 5555 -c config-server.json\nhypertele-pub -l 5555 --seed XXX\n```\n\nNote: the command will print out the pubkey\n\n\n## Client\n\n```sh\nhypertele --help\n```\n\n**Create a JSON config file for your client**\n```\n{\n  \"peer\": \"SERVER_PEER_KEY\"\n}\n```\n\n```\noptions:\n\n-s SERVER_PEER_KEY : server peer key (command-line)\n-i keypair.json : keypair file\n--compress : enable chunk compression\n--private : access a private hypertele server (expects -s to contain the server's seed instead of the public key)\n```\n\nRead more about using identities here: https://github.com/prdn/hyper-cmd-docs/blob/main/identity.md\n\n```sh\nexamples:\n\nhypertele -p 1337 -c config-client.json\nhypertele -p 1337 -s PUBKEY_FROM_SERVER -i keypair.json\n\nand...\ntelnet localhost 1337\n```\n\n## The hyper-cmd system\n\nhypertele supports the hyper-cmd system!\n\nIdentity management: https://github.com/prdn/hyper-cmd-docs/blob/main/identity.md\n\nHost resolution: https://github.com/prdn/hyper-cmd-docs/blob/main/resolve.md\n\n## License\n\nMIT\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fhypertele","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fbitfinexcom%2Fhypertele","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fbitfinexcom%2Fhypertele/lists"}