{"id":16081901,"url":"https://github.com/mon4ik/forward-port","last_synced_at":"2025-03-28T06:30:46.922Z","repository":{"id":180139768,"uuid":"664661751","full_name":"Mon4ik/forward-port","owner":"Mon4ik","description":null,"archived":true,"fork":false,"pushed_at":"2024-12-06T17:26:18.000Z","size":58,"stargazers_count":0,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-03-22T06:40:42.990Z","etag":null,"topics":[],"latest_commit_sha":null,"homepage":null,"language":"TypeScript","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/Mon4ik.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":"2023-07-10T13:21:55.000Z","updated_at":"2024-12-06T17:26:30.000Z","dependencies_parsed_at":"2024-12-25T22:05:34.387Z","dependency_job_id":"77c0cd3d-7351-4b25-ae5c-98b049cc6e3f","html_url":"https://github.com/Mon4ik/forward-port","commit_stats":{"total_commits":6,"total_committers":1,"mean_commits":6.0,"dds":0.0,"last_synced_commit":"af1ba98a64c6719d92bea89cfe5de0d753f52ff9"},"previous_names":["mon4ik/forward-port"],"tags_count":7,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mon4ik%2Fforward-port","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mon4ik%2Fforward-port/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mon4ik%2Fforward-port/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/Mon4ik%2Fforward-port/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/Mon4ik","download_url":"https://codeload.github.com/Mon4ik/forward-port/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":245984260,"owners_count":20704787,"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":[],"created_at":"2024-10-09T11:24:31.000Z","updated_at":"2025-03-28T06:30:46.916Z","avatar_url":"https://github.com/Mon4ik.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# deprecated\njust use SSH lol\n\n# Forward Port\nYour local port forwarding\n\n## Installation\n- Install from NPM\n  ```shell\n  npm i -g @idkncc/forward-port\n  forward-port server \u003cpreshared-key\u003e\n  ```\n- Build\n  ```shell\n  #1. Install deps\n  yarn\n  \n  #2. Build\n  yarn dev\n    \n  #3. Run\n  yarn start server \u003cpreshared-key\u003e\n  # or\n  # node ./bin server \u003cpreshared-key\u003e\n  ```\n\n## Usage\n\u003e **Note:** Pre-Shared key needs to be random and identical on server and client\n```shell\n# Generate unique pre-shared key\nforward-port gen-key [length]\n\n# Create ForwardPort (FP) Server\nforward-port server \u003cpreshared-key\u003e [-p \u003cother-port\u003e]\n\n# Create ForwardPort Client\nforward-port client \u003clocal-port\u003e \u003cfp-server\u003e \u003cpreshared-key\u003e [-p \u003cother-port\u003e] [--debug]\n```\n\n## Example (Minecraft Server)\n- On your server (with white IP, **f.e. VDS**)\n  ```shell\n  npx @idkncc/forward-port server SUPER_SECRET_KEY\n  # f.e. Server runs on IP 5.5.5.5\n  ```\n- On your PC\n  ```shell\n  #                      minecraft port   vds\n  #                                v       v\n  npx @idkncc/forward-port client 25565 5.5.5.5 SUPER_SECRET_KEY\n  ```\n- Your friend: Uses **5.5.5.5:1337** to connect\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmon4ik%2Fforward-port","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fmon4ik%2Fforward-port","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fmon4ik%2Fforward-port/lists"}