[{"_1":2,"_170":-5,"_171":-5},"loaderData",{"_3":4,"_13":14,"_20":21,"_168":169},"root",{"_5":-5,"_6":-7,"_7":8,"_9":-7,"_10":11,"_12":-7},"currentUser","primaryEmail","siteVerification","6LeIxAcTAAAAAJcZVRqyHh71UMIEGNQ_MXjiZKhI","toast","enableDev",false,"incidentStatus","routes/_layout",{"_15":-5,"_16":17,"_18":17,"_19":11},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","routes/_layout.r.$namespace.$reponame",{"_22":23,"_24":-5,"_25":11,"_26":11,"_27":28,"_29":30,"_31":-5,"_32":11,"_33":34,"_83":84,"_103":104,"_161":-5,"_162":11,"_163":17,"_164":11,"_165":-5,"_166":167},"canonicalUrl","https://hub.docker.com/r/pkgems/npm-cache-proxy/builds","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","pkgems","reponame","npm-cache-proxy","cloudBuildSource","isAutobuildsAvailable","repo",{"_35":36,"_37":38,"_40":41,"_42":43,"_44":11,"_45":46,"_47":48,"_49":50,"_52":30,"_27":28,"_53":54,"_55":39,"_56":57,"_58":57,"_59":60,"_61":-5,"_62":63,"_64":65,"_66":11,"_67":28,"_68":69,"_74":11,"_75":76,"_80":28,"_81":82},"categories",[],"content_types",[39],"image","date_registered","2019-05-07T08:12:51.385718Z","description","Ultra-fast NPM caching proxy with Redis","is_private","last_updated","2019-05-07T09:34:39.12574Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[51],"application/vnd.docker.container.image.v1+json","name","pull_count",7756,"repository_type","star_count",1,"status","status_description","active","source","collaborator_count",0,"full_description","

\n\n

npm-cache-proxy

\n\n \n $\"Current$ \n \n \n $\"CI$ \n \n \n $\"Licence\"$ \n \n

\n\n
\n
\n\n## Introduction\n\n#### ⚡️ Performance\nNCP is a tiny but very fast caching proxy written in Go. It uses Redis for data storage, which in combination with the speed of Go makes it incredibly fast. NCP is well-optimized and can be run on almost any platform, so if you have a Raspberry Pi, you can install NCP as your local cache there.\n\n#### ✨ Modularity\nNCP is modular. Now it has only one database adapter which is Redis. If you need support for any other database, feel free to open an issue or implement it [on your own](https://github.com/pkgems/npm-cache-proxy/blob/7c8b90ff6ba0656f60e3de915b9fb4eaabfb467b/proxy/proxy.go#L29) and then open a pull request (_bonus points_).\n\n#### 💡 Simplicity\nNCP is very simple. It just proxies requests to an upstream registry, caches response and returns cached response for next requests to the same package. Cached data are stored in Redis with an original request URL as a key.\n\n\n
\n\n\n## Installation\nNCP binaries for different paltforms can be downloaded can be downloaded on the [Releases](https://github.com/pkgems/npm-cache-proxy/releases) page. Also, Docker image is provided on [Docker Hub](https://cloud.docker.com/u/pkgems/repository/docker/pkgems/npm-cache-proxy).\n\n#### 💫 Quick Start\nThe quickies way to get started with NCP is to use Docker.\n\n```bash\n# run proxy inside of docker container in background\ndocker run -e REDIS_ADDRESS=host.docker.internal:6379 -p 8080:8080 -it -d pkgems/npm-cache-proxy\n\n# configure npm to use caching proxy as registry\nnpm config set registry http://localhost:8080\n```\n\n
\n\n## CLI\nNCP provides command line interface for interaction with a cached data.\n\n

Options

\n\n| Options | Env | Default | Description |\n| ----------------------------- | ------------------ | ---------------------------- | ----------------------------------- |\n| `--listen

` | `SILENT` | `0` | Disable logs |\n| `--cache-limit ` | `CACHE_LIMIT` | - | Cached packages count limit |\n| `--cache-ttl ` | `CACHE_TTL` | `3600` | Cache expiration timeout in seconds |\n| `--redis-address

\n\n#### `ncp`\nStart NCP server.\n\n#### `ncp list`\nList cached url paths.\n\n#### `ncp purge`\nPurge cached url paths.\n\n\n
\n\n\n## Benchmark\nBenchmark is run on Macbook Pro 15″ 2017, Intel Core i7-7700HQ.\n\n#### 1️⃣ 1 process\n\n```bash\n# GOMAXPROCS=1 ncp --silent\n\n$ go-wrk -c 100 -d 6 http://localhost:8080/tiny-tarball\nRunning 6s test @ http://localhost:8080/tiny-tarball\n 100 goroutine(s) running concurrently\n\n70755 requests in 5.998378587s, 91.16MB read\n\nRequests/sec:\t\t11795.69\nTransfer/sec:\t\t15.20MB\nAvg Req Time:\t\t8.477674ms\nFastest Request:\t947.743µs\nSlowest Request:\t815.787409ms\nNumber of Errors:\t0\n```\n\n#### ♾ unlimited processes\n\n```bash\n# ncp --silent\n\n$ go-wrk -c 100 -d 6 http://localhost:8080/tiny-tarball\nRunning 6s test @ http://localhost:8080/tiny-tarball\n 100 goroutine(s) running concurrently\n\n115674 requests in 5.98485984s, 149.04MB read\n\nRequests/sec:\t\t19327.77\nTransfer/sec:\t\t24.90MB\nAvg Req Time:\t\t5.173902ms\nFastest Request:\t273.015µs\nSlowest Request:\t34.777963ms\nNumber of Errors:\t0\n```\n\n\n
\n\n\n## Programmatic Usage\nNCP provides `proxy` go package that can be used programmatically. Docs are available on [godoc.org](https://godoc.org/github.com/pkgems/npm-cache-proxy/proxy).\n\n#### 🤖 Example\n```golang\npackage main\n\nimport (\n\t\"net/http\"\n\t\"time\"\n\n\tnpmproxy \"github.com/pkgems/npm-cache-proxy/proxy\"\n\t\"github.com/go-redis/redis\"\n)\n\nfunc main() {\n\t// create proxy\n\tproxy := npmproxy.Proxy{\n\t\t// use redis as database\n\t\tDatabase: npmproxy.DatabaseRedis{\n\t\t\t// see github.com/go-redis/redis\n\t\t\tClient: redis.NewClient(&redis.Options{\n\t\t\t\tAddr: \"localhost:6379\",\n\t\t\t}),\n\t\t},\n\n\t\t// reuse connections\n\t\tHttpClient: &http.Client{},\n\t}\n\n\t// create and start server\n\tproxy.Server(npmproxy.ServerOptions{\n\t\tListenAddress: \"localhost:8080\",\n\n\t\t// allow fetching options dynamically on each request\n\t\tGetOptions: func() (npmproxy.Options, error) {\n\t\t\treturn npmproxy.Options{\n\t\t\t\tDatabasePrefix: \"ncp-\",\n\t\t\t\tDatabaseExpiration: 1 * time.Hour,\n\t\t\t\tUpstreamAddress: \"https://registry.npmjs.org\",\n\t\t\t}, nil\n\t\t},\n\t}).ListenAndServe()\n}\n```\n\n\n
\n\n\n## License\n[MIT](./license)\n","has_starred","hub_user","immutable_tags_settings",{"_70":11,"_71":72},"enabled","rules",[73],".*","is_automated","permissions",{"_77":17,"_78":11,"_79":11},"read","write","admin","user","storage_size",18394256,"orgData",{"_85":86,"_87":88,"_89":90,"_91":28,"_92":28,"_93":94,"_95":28,"_96":94,"_97":98,"_99":94,"_100":94,"_101":94,"_102":17},"id","5eef3468869148f58d2520642ba02077","uuid","5eef3468-8691-48f5-8d25-20642ba02077","type","organization","orgname","full_name","location","","company","profile_url","date_joined","2019-05-07T08:11:57.87231Z","gravatar_url","gravatar_email","badge","is_active","recentTags",[105,141,151],{"_106":39,"_107":108,"_109":110,"_85":111,"_112":113,"_45":130,"_131":108,"_132":28,"_133":51,"_52":134,"_135":136,"_137":121,"_138":130,"_139":60,"_140":17},"content_type","creator",6266691,"full_size",7965495,54724242,"images",[114],{"_115":116,"_117":118,"_119":94,"_120":121,"_122":123,"_124":125,"_126":94,"_127":-5,"_128":110,"_58":60,"_129":-5},"architecture","amd64","digest","sha256:c6a88c6dbd2f86e7226b7af741e0afe474f47f93ffc223380f081015f7e10da5","features","last_pulled","2026-09-17T07:20:12.514414413Z","last_pushed","2019-05-07T09:13:53Z","os","linux","os_features","os_version","size","variant","2019-05-07T09:13:52.102296Z","last_updater","last_updater_username","media_type","latest","repository",7079995,"tag_last_pulled","tag_last_pushed","tag_status","v2",{"_106":39,"_107":108,"_109":142,"_85":143,"_112":144,"_45":149,"_131":108,"_132":28,"_133":51,"_52":150,"_135":136,"_137":147,"_138":149,"_139":60,"_140":17},7965505,54717315,[145],{"_115":116,"_117":146,"_119":94,"_120":147,"_122":148,"_124":125,"_126":94,"_127":-5,"_128":142,"_58":60,"_129":-5},"sha256:507ba70e13a878b2b5462bfaf2376d28325173b5bb84a000b1199336346e0dac","2026-09-14T08:03:45.227279941Z","2019-05-07T08:22:48Z","2019-05-07T09:34:38.807175Z","canary",{"_106":39,"_107":108,"_109":152,"_85":153,"_112":154,"_45":159,"_131":108,"_132":28,"_133":51,"_52":160,"_135":136,"_137":157,"_138":159,"_139":60,"_140":17},7965522,54725015,[155],{"_115":116,"_117":156,"_119":94,"_120":157,"_122":158,"_124":125,"_126":94,"_127":-5,"_128":152,"_58":60,"_129":-5},"sha256:475ae3f1d7fb4b0acd72a091da4d317d15825996f40b00cb3959de088c151417","2026-09-17T08:21:41.797439875Z","2019-05-07T09:20:08Z","2019-05-07T09:20:07.680446Z","1.3.5","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.builds",{"_26":11,"_31":-5},"actionData","errors"]