{"id":29869632,"url":"https://github.com/fksms/128kvpn","last_synced_at":"2025-08-11T05:09:09.413Z","repository":{"id":305931137,"uuid":"984762279","full_name":"fksms/128kVPN","owner":"fksms","description":"Provides a bandwidth-limited environment using WireGuard","archived":false,"fork":false,"pushed_at":"2025-07-22T17:29:20.000Z","size":2147,"stargazers_count":5,"open_issues_count":0,"forks_count":0,"subscribers_count":1,"default_branch":"main","last_synced_at":"2025-07-30T17:53:13.991Z","etag":null,"topics":["128kbps","docker","firebase","nextjs","rate-limiter","vpn","wireguard"],"latest_commit_sha":null,"homepage":"https://128kvpn.net","language":"TypeScript","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/fksms.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,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null}},"created_at":"2025-05-16T13:16:27.000Z","updated_at":"2025-07-22T22:02:52.000Z","dependencies_parsed_at":"2025-07-22T19:22:23.370Z","dependency_job_id":"4fadec15-3d31-4afa-9344-4c90e1b833a1","html_url":"https://github.com/fksms/128kVPN","commit_stats":null,"previous_names":["fksms/128kvpn"],"tags_count":0,"template":false,"template_full_name":null,"purl":"pkg:github/fksms/128kVPN","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fksms%2F128kVPN","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fksms%2F128kVPN/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fksms%2F128kVPN/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fksms%2F128kVPN/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/fksms","download_url":"https://codeload.github.com/fksms/128kVPN/tar.gz/refs/heads/main","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/fksms%2F128kVPN/sbom","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":269832882,"owners_count":24482330,"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","status":"online","status_checked_at":"2025-08-11T02:00:10.019Z","response_time":75,"last_error":null,"robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":true,"can_crawl_api":true,"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":["128kbps","docker","firebase","nextjs","rate-limiter","vpn","wireguard"],"created_at":"2025-07-30T17:00:49.271Z","updated_at":"2025-08-11T05:09:09.394Z","avatar_url":"https://github.com/fksms.png","language":"TypeScript","funding_links":[],"categories":[],"sub_categories":[],"readme":"# 128kVPN\n\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"./assets/logo.svg\" width=\"125\" alt=\"128kVPN Logo\" /\u003e\n    \u003cbr\u003e\n    Provides a bandwidth-limited environment.\n    \u003cbr\u003e\n    Bandwidth control is implemented via VPN.\n    \u003cbr\u003e\n    \u003cbr\u003e\n    \u003cimg src=\"./assets/screenshot.png\" width=\"750\" alt=\"128kVPN Screenshot\" /\u003e\n\u003c/div\u003e\n\n## Features\n- Establishes a VPN connection using WireGuard, with all traffic controlled server-side.\n- Uses `tc` and the `ifb` module on the server to enforce both upload and download bandwidth limits.\n- Bandwidth is limited to 128 kbps for both upload and download.\n- Easily and quickly deployable via Next.js and Docker.\n- User information is managed using Firebase Authentication.\n- Provides management APIs to check and disconnect active sessions.\n- Web interface is multilingual.\n- Enables HTTPS communication via Nginx as a reverse proxy.\n\n## Architecture\n\u003cdiv align=\"center\"\u003e\n    \u003cimg src=\"./assets/architecture.png\" width=\"700\" alt=\"128kVPN Architecture\" /\u003e\n\u003c/div\u003e\n\n## Requirements\n- Requires Linux to utilize network control features like `tc` and `ifb`.\n- Docker is required to run the application.\n- You must obtain the Firebase Client SDK config and Admin SDK config in advance and set them in the `.env` file.\n- To use the management API, a shared secret must be set in the `.env` file.\n\n## How to deploy\n\n### Linux (Ubuntu etc.)\n\n#### Setup\n\nInstall Docker\n```sh\ncurl https://get.docker.com | sudo sh\n```\n\nLoad `ifb` and `act_mirred`, `ip_tables` module\n```sh\nsudo modprobe ifb\nsudo modprobe act_mirred\nsudo modprobe ip_tables\n```\n\nCopy the `.env.sample` file and fill in the required information\n```sh\ncp .env.sample .env\n```\n\nPlease place the private key (`privkey.pem`) and the server certificate issued by a certificate authority such as Let's Encrypt + intermediate certificate (`fullchain.pem`) in the `nginx` directory.\n\n(In a development environment, use `mkcert` to generate the certificate.)\n\n```sh\ncp /path/to/privkey.pem nginx/privkey.pem\ncp /path/to/fullchain.pem nginx/fullchain.pem\n```\n\n#### Deploy\n\nBuild (Dev)\n```sh\nsudo docker compose -f compose.dev.yml up -d\nsudo docker compose -f compose.dev.yml down\n```\n\nBuild (Prod)\n```sh\nsudo docker compose up -d\nsudo docker compose down\n```\n\nBuild only `app` (Prod)\n```sh\nsudo docker compose up -d app\nsudo docker compose down\n```\n\n### MacOS and Windows\n\n\u003e [!IMPORTANT]\n\u003e The GUI works perfectly, but the VPN is not available.\n\n#### Setup\n\nCopy the `.env.sample` file and fill in the required information\n```sh\ncp .env.sample .env\n```\n\nPlease start DevContainer.\n\n#### Build\n\nChange to the `src/` directory\n```sh\ncd src/\n```\n\nInstall dependencies\n```sh\nnpm install\n```\n\nBuild (Dev)\n```sh\nnpm run dev\n```\n\nBuild (Prod)\n```sh\nnpm run build\nnpm run start\n```","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffksms%2F128kvpn","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Ffksms%2F128kvpn","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Ffksms%2F128kvpn/lists"}