{"id":13480819,"url":"https://github.com/siketyan/nakoud","last_synced_at":"2025-04-15T06:15:55.346Z","repository":{"id":158709270,"uuid":"633805196","full_name":"siketyan/nakoud","owner":"siketyan","description":"🐳 Access your Docker containers easily without port forwarding","archived":false,"fork":false,"pushed_at":"2024-08-01T17:18:28.000Z","size":92,"stargazers_count":29,"open_issues_count":1,"forks_count":0,"subscribers_count":2,"default_branch":"main","last_synced_at":"2025-04-15T06:15:48.697Z","etag":null,"topics":["docker","go","http-proxy","networking"],"latest_commit_sha":null,"homepage":"","language":"Go","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/siketyan.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},"funding":{"github":"siketyan","patreon":"siketyan"}},"created_at":"2023-04-28T10:14:19.000Z","updated_at":"2024-10-04T13:51:45.000Z","dependencies_parsed_at":"2023-06-04T19:45:25.589Z","dependency_job_id":"b81f1ad7-08cc-42a9-96a0-ee6976bc6736","html_url":"https://github.com/siketyan/nakoud","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/siketyan%2Fnakoud","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siketyan%2Fnakoud/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siketyan%2Fnakoud/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/siketyan%2Fnakoud/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/siketyan","download_url":"https://codeload.github.com/siketyan/nakoud/tar.gz/refs/heads/main","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":249016643,"owners_count":21198833,"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":["docker","go","http-proxy","networking"],"created_at":"2024-07-31T17:00:45.435Z","updated_at":"2025-04-15T06:15:55.322Z","avatar_url":"https://github.com/siketyan.png","language":"Go","funding_links":["https://github.com/sponsors/siketyan","https://patreon.com/siketyan"],"categories":["Go"],"sub_categories":[],"readme":"# nakoud\n\n[![go](https://github.com/siketyan/nakoud/actions/workflows/go.yaml/badge.svg)](https://github.com/siketyan/nakoud/actions/workflows/go.yaml)\n[![docker](https://github.com/siketyan/nakoud/actions/workflows/docker.yaml/badge.svg)](https://github.com/siketyan/nakoud/actions/workflows/docker.yaml)\n\nAccess your Docker containers easily without port forwarding\n\n```mermaid\nflowchart LR\n    client[Client]\n    nakoud[nakoud-proxy]\n    containerA[Container A]\n    containerB[Container B]\n    \n    client -- HTTP/1.1 CONNECT --\u003e nakoud\n    client -- HTTP/1.1 GET --\u003e nakoud\n    \n    subgraph network [Docker Network]\n        nakoud -- TCP --\u003e containerA\n        nakoud -- HTTP --\u003e containerB\n    end\n```\n\n\u003e **Warning**  \n\u003e This product is still in development and for development environment.\n\u003e Do not use in any production environment.\n\n## Getting Started\n\n### Run the proxy\n\nThe nakoud proxy works as a HTTP proxy, to accept connections from your client.\nThis will be the entrypoint of all connections to Docker containers, instead of port forwarding.\n\n```shell\ndocker network create nakoud\ndocker run \\\n    -p '127.0.0.1:8080:8080/tcp' \\\n    -p '[::1]:8080:8080/tcp' \\\n    -v '/var/run/docker.sock:/var/run/docker.sock:z' \\\n    --network nakoud \\\n    ghcr.io/siketyan/nakoud:latest\n```\n\n### Run your application\n\nYou don't need port forwarding your application from now.\nTo access through nakoud, run your application in the nakoud network, with a label to specify the FQDN to access using.\n\n```shell\ndocker run \\\n    # No port forwarding (-p) is needed :)\n    --network nakoud \\\n    --label 'jp.s6n.nakoud.fqdn=nginx.nakoud.local' \\\n    nginx:latest\n```\n\n### Test the connection\n\nUse telnet or some TCP client to test the connection.\n\n```shell\ntelnet localhost:8080\n```\nOnce you connected to the nakoud proxy, type these to request `/` from nginx (`+` is what you type, `-` is what you receive):\n\n```diff\n+ CONNECT nginx.nakoud.local:80 HTTP/1.1\n+\n- HTTP/1.1 200 OK\n- Content-Length: 0\n-\n+ GET / HTTP/1.1\n+ Host: nakoud.nginx.local\n+\n- HTTP/1.1 200 OK\n- Server: nginx/1.23.4\n- Date: Sat, 29 Apr 2023 07:55:11 GMT\n- Content-Type: text/html\n- Content-Length: 615\n- Last-Modified: Tue, 28 Mar 2023 15:01:54 GMT\n- Connection: keep-alive\n- ETag: \"64230162-267\"\n- Accept-Ranges: bytes\n- \n- \u003c!DOCTYPE html\u003e\n- \u003chtml\u003e\n- ...(truncated)\n```\n\nWelcome to nakoud!\n\n## Roadmap\n\nThere are more things to do:\n\n- [x] Other HTTP methods support than CONNECT method\n- [ ] Intermediate TLS certificate\n- [ ] Automatic FQDN without labeling (`\u003ccontainer\u003e.nakoud.local` or something)\n- [ ] Docker Compose support (`\u003cservice\u003e.\u003cproject\u003e.nakoud.local` or something)\n- [ ] HTTPS, SOCKS proxy\n\n... and more!\n\nIf you have an idea to improve nakoud, please file at [Issues](https://github.com/siketyan/nakoud/issues).\n\n## FAQ\n\n### What is \"nakoud\" from?\n\n\"nakoud\" is originally from \"nakoudo\" which means a matchmaker in Japanese.\nThe nakoud proxy receives a request from your client and intermediate it through Docker network.\nIt looks like a matchmaker, and also it is a daemon; typically daemons are named with \"d\" suffix, so we named this \"nakoud\".\n","project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiketyan%2Fnakoud","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fsiketyan%2Fnakoud","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fsiketyan%2Fnakoud/lists"}