{"id":37133520,"url":"https://github.com/yaproxy/yap","last_synced_at":"2026-01-14T15:35:25.961Z","repository":{"id":50466519,"uuid":"86283162","full_name":"yaproxy/yap","owner":"yaproxy","description":"Yet Another Proxy powered by Golang","archived":false,"fork":false,"pushed_at":"2023-01-12T09:37:41.000Z","size":63,"stargazers_count":2,"open_issues_count":0,"forks_count":4,"subscribers_count":2,"default_branch":"master","last_synced_at":"2024-06-20T17:30:57.815Z","etag":null,"topics":["golang","https","proxy"],"latest_commit_sha":null,"homepage":"","language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"apache-2.0","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/yaproxy.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":"2017-03-27T02:34:53.000Z","updated_at":"2024-06-20T17:30:57.816Z","dependencies_parsed_at":"2023-02-09T11:02:22.595Z","dependency_job_id":null,"html_url":"https://github.com/yaproxy/yap","commit_stats":null,"previous_names":["yaproxy/yaproxy"],"tags_count":1,"template":false,"template_full_name":null,"purl":"pkg:github/yaproxy/yap","repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaproxy%2Fyap","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaproxy%2Fyap/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaproxy%2Fyap/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaproxy%2Fyap/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/yaproxy","download_url":"https://codeload.github.com/yaproxy/yap/tar.gz/refs/heads/master","sbom_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/yaproxy%2Fyap/sbom","scorecard":null,"host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":286080680,"owners_count":28424374,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2026-01-14T13:30:50.153Z","status":"ssl_error","status_checked_at":"2026-01-14T13:29:08.907Z","response_time":107,"last_error":"SSL_connect returned=1 errno=0 peeraddr=140.82.121.5:443 state=error: unexpected eof while reading","robots_txt_status":"success","robots_txt_updated_at":"2025-07-24T06:49:26.215Z","robots_txt_url":"https://github.com/robots.txt","online":false,"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":["golang","https","proxy"],"created_at":"2026-01-14T15:35:25.334Z","updated_at":"2026-01-14T15:35:25.947Z","avatar_url":"https://github.com/yaproxy.png","language":"Go","readme":"# [WIP] Yap - Yet Another Proxy powered by Golang\n\n[![Docker](https://github.com/yaproxy/yap/actions/workflows/docker.yml/badge.svg?branch=master)](https://github.com/yaproxy/yap/actions/workflows/docker.yml) [![Go Report Card](https://goreportcard.com/badge/github.com/yaproxy/yap?style=flat-square)](https://goreportcard.com/report/yaproxy/yap) [![Apache License Version 2.0](https://img.shields.io/badge/license-Apache%20V2-blue.svg)](https://www.apache.org/licenses/LICENSE-2.0.html)\n\nYap is a HTTP1.1/HTTP2 proxy which forked and refactored from [branch vps of Goproxy](https://github.com/phuslu/goproxy/tree/server.vps)\n\n## Usage\n\nFirst of all, download the latest Yap program from [Release](https://github.com/yaproxy/yap/releases) page according to your os and arch.\n\n### Prepare for Server\n\n* A domain: `example.org`\n* Certificate for the domain: `example.org.cer`\n* Key of the certificate for the domain: `example.org.key`\n\n### Create a config file `yap.toml`\n\n```toml\n[default]\nreject_nil_sni = false\n\n[[http2]]\nlisten = \":443\"\n# server name for http2 proxy\nserver_name = [\"example.org\"]\n# cert file\ncert_file = \"example.org.cer\"\n# key file\nkey_file = \"example.org.key\"\n\n[http]\nlisten = \":8088\"\n```\n\n### Start Yap Server\n\n```shell\n./yap yap.toml\n```\n\n### Use Yap\n\n#### 1. Use HTTP2 Proxy in Chrome or Firefox\n\nCreate a new pac proxy configuration for you browser and setting:\n\n```pac\nfunction FindProxyForURL(url, host) {\n  return \"HTTPS example.org:443\";\n}\n```\n\n#### 2. Use Yap in Proxy Chains\n\n```toml\n[http]\nlisten = \"localhost:8088\"\nupstream_proxy = \"https://example.org:443\"\n```\n\n```shell\n./yap yap.toml\n```\n\nConfig HTTP Proxy `localhost:8088` for you application.\n\n### Enjoy you life\n\n## Configuration\n\nYap supports multiple format configuration files such as `toml`, `yaml` and so on.\n\n### Section - default\n\nTBD\n\n### Section - http2\n\n`http2` section contains a list for HTTP2 proxy.\n\n* network - optional\n\n  The network must be a stream-oriented network:\n  \u003e \"tcp\", \"tcp4\", \"tcp6\", \"unix\" or \"unixpacket\".\n\n  Currently, only support `tcp`, `tcp4`, `tcp6`.\n\n* listen\n\n  The syntax of listen is \"host:port\", e.g. \":443\"\n\n* server_name\n\n  The server name for http2 proxy, should be a list, such as `[\"example.org\", \"yap.example.org\"]`\n\n* proxy_fallback - optional\n\n  The fallback URL for non-proxy request\n\n* pem - optional\n\n  The pem file location for key pair contains cert and key, if pem is setting, the `cert_file` and `key_file` will be not used.\n\n* cert_file - optional\n\n  The certificate file location\n\n* key_file - optional\n\n  The key file location\n\n* upstream_proxy - optional\n\n  The upstream proxy URL, used for proxy chain.\n\n* proxy_auth_method - optional\n\n  The proxy authenticate method, currently contains 3 options: \"pam\", \"htpasswd\", \"build-in\".\n\n  Leave it blank for disable proxy authenticate\n\n* proxy_auth_htpasswd_path - optional\n\n  The htpasswd file location.\n\n  Only used when `proxy_auth_method` is set to `htpasswd`.\n\n* proxy_auth_buildin_credential - optional\n\n  The build-in authentication credential.\n  Only used when `proxy_auth_method` is set to `build-in`.\n\n### Section - http\n\n* network - optional\n\n  The network must be a stream-oriented network:\n  \u003e \"tcp\", \"tcp4\", \"tcp6\", \"unix\" or \"unixpacket\".\n\n  Currently, only support `tcp`, `tcp4`, `tcp6`.\n\n* listen\n\n  The syntax of listen is \"host:port\", e.g. \":443\"\n\n* upstream_proxy - optional\n\n  The upstream proxy URL, used for proxy chain.\n\n* proxy_auth_method - optional\n\n  The proxy authenticate method, currently contains 3 options: \"pam\", \"htpasswd\", \"build-in\".\n\n  Leave it blank for disable proxy authenticate\n\n  Please reference [Authentication section](#authentication).\n\n* proxy_auth_htpasswd_path - optional\n\n  The htpasswd file location.\n\n  Only used when `proxy_auth_method` is set to `htpasswd`.\n\n* proxy_auth_buildin_credential - optional\n\n  The build-in authentication credential.\n  Only used when `proxy_auth_method` is set to `build-in`.\n\n## Authentication\n\nYap supports two auth methods.\n\n### Build-in Authentication\n\nSet `proxy_auth_method` to `build-in`.\nSet `proxy_auth_buildin_credential` to `username:password`.\n\n### Basic Authentication - htpasswd file auth\n\nSet `proxy_auth_method` to `htpasswd`.\nSet `proxy_auth_htpasswd_path` to htpasswd file path.\n\nConfiguration:\n\n```toml\n# ...\nproxy_auth_method = \"htpasswd\"\nproxy_auth_htpasswd_path = \"/path/to/htpasswd\"\n# ...\n```\n\nGenerate htpasswd:\n\n```shell\nhtpasswd -bc /path/to/htpasswd username passwd\n```\n\n### PAM Authentication\n\nInstall `python` for PAM authentication.\nSet `proxy_auth_method` to `pam`.\n\n## Use Yap in Docker\n\nQuick start:\n\n```\ndocker run -d \\\n    -v /path/to/yap.toml:/yap.toml \\\n    -v /path/to/example.cert:/example.cert \\\n    -v /path/to/example.key:/example.key \\\n    -v /path/to/htpasswd:/htpasswd \\\n    -p 443:443 \\\n    -p 8088:8088 \\\n    yaproxy/yap\n```\n\nYou can find more details from [Yap in Docker hub](https://hub.docker.com/r/yaproxy/yap/).\n\n## Contributing\n\nContributions are welcome.\n\n## Copyright / License\n\nCopyright 2013-2017 Yaproxy\n\nThis software is licensed under the terms of the Apache License Version 2. See the [LICENSE](./LICENSE) file.","funding_links":[],"categories":[],"sub_categories":[],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyaproxy%2Fyap","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fyaproxy%2Fyap","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fyaproxy%2Fyap/lists"}