[{"_1":2,"_177":-5,"_178":-5},"loaderData",{"_3":4,"_13":14,"_21":22,"_156":157},"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,"_20":17},"username","isAskGordonEnabled",true,"isUsingNewTemplate","showMinimalLanding","showHoneypotTrap","routes/_layout.r.$namespace.$reponame",{"_23":24,"_25":-5,"_26":11,"_27":11,"_28":29,"_30":31,"_32":-5,"_33":11,"_34":35,"_85":86,"_109":110,"_147":-5,"_148":11,"_149":17,"_150":11,"_151":-5,"_152":11,"_153":-5,"_154":155},"canonicalUrl","https://hub.docker.com/r/gundb/gun/tags","mcpServer","canSeeDockerfile","canSeeAutobuilds","namespace","gundb","reponame","gun","cloudBuildSource","isAutobuildsAvailable","repo",{"_36":37,"_38":39,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":51,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":65,"_66":67,"_68":11,"_69":29,"_70":71,"_76":11,"_77":78,"_82":29,"_83":84},"categories",[],"content_types",[40],"image","date_registered","2020-08-26T21:10:38.465713Z","description","","is_private","last_updated","2021-03-01T19:11:05.898725Z","last_modified","2024-10-16T13:48:34.145251Z","media_types",[52],"application/vnd.docker.container.image.v1+json","name","pull_count",94563,"repository_type","star_count",3,"status",1,"status_description","active","source","collaborator_count",0,"full_description","

\r\n\r\n[![](https://data.jsdelivr.com/v1/package/npm/gun/badge?style=rounded)](https://www.jsdelivr.com/package/npm/gun)\r\n[![Travis](https://img.shields.io/travis/amark/gun/master.svg)](https://travis-ci.org/amark/gun)\r\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Famark%2Fgun.svg?size=shield)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Famark%2Fgun?ref=badge_shield)\r\n[![Gitter](https://img.shields.io/gitter/room/amark/gun.js.svg)](https://gitter.im/amark/gun)\r\n\r\n**GUN** is an _ecosystem_ of tools that let you build [community run](https://www.nbcnews.com/tech/tech-news/these-technologists-think-internet-broken-so-they-re-building-another-n1030136) and [encrypted applications](https://gun.eco/docs/Cartoon-Cryptography).\r\n\r\nCurrently, [Internet Archive](https://news.ycombinator.com/item?id=17685682) and [HackerNoon](https://www.coindesk.com/hacker-noon-is-storing-content-on-a-blockchain-after-ditching-medium) run GUN in production.\r\n\r\nDecentralized alternatives to [Zoom](https://www.zdnet.com/article/era-hatches-meething-an-open-source-browser-based-video-conferencing-system/), [Reddit](https://notabug.io/t/whatever/comments/36588a16b9008da4e3f15663c2225e949eca4a15/gpu-bot-test), [Slack](https://iris.to/), [YouTube](https://d.tube/), [Wikipedia](https://news.ycombinator.com/item?id=17685682), etc. have already pushed terabytes of daily P2P traffic on GUN. We are a [friendly community](http://chat.gun.eco/) creating a [free fun future for freedom](https://youtu.be/1HJdrBk3BlE):\r\n\r\n\r\n\r\n $\"3D$ \r\n $\"AI/ML\"/$ \r\n $\"GPS\"/$ \r\n\r\n\r\n $\"Data$ \r\n $\"P2P\"/$ \r\n $\"IoT\"/$ \r\n\r\n\r\n $\"VR$ \r\n $\"AR\"/$ \r\n $\"Video$ \r\n\r\n

\r\n\r\nThe ecosystem is one nice stack of technologies that looks like this: (names -> use case)\r\n\r\n

\r\n

\r\n\r\nFor now, it is best to start with GUN and _just use it_ to learn the basics, since it is _**so easy**_: (**or** want to read more? Skip ahead to the \"[What is GUN?](#what-is-gun)\" section.)\r\n\r\n## Quickstart\r\n\r\n - Try the [interactive tutorial](https://gun.eco/docs/Todo-Dapp) in the browser (**5min** ~ average developer).\r\n - Or `npm install gun` and run the examples with `cd node_modules/gun && npm start` (**5min** ~ average developer).\r\n\r\n> **Note:** If you don't have [node](http://nodejs.org/) or [npm](https://www.npmjs.com/), read [this](https://github.com/amark/gun/blob/master/examples/install.sh) first.\r\n> If the `npm` command line didn't work, you may need to `mkdir node_modules` first or use `sudo`.\r\n\r\n- An online demo of the examples are available here: http://gunjs.herokuapp.com/\r\n- Or write a quick app: ([try now in jsbin](http://jsbin.com/sovihaveso/edit?js,console))\r\n```html\r\n\r\n\r\n```\r\n- Or try something **mind blowing**, like saving circular references to a table of documents! ([play](http://jsbin.com/wefozepume/edit?js,console))\r\n```javascript\r\nvar cat = {name: \"Fluffy\", species: \"kitty\"};\r\nvar mark = {boss: cat};\r\ncat.slave = mark;\r\n\r\n// partial updates merge with existing data!\r\ngun.get('mark').put(mark);\r\n\r\n// access the data as if it is a document.\r\ngun.get('mark').get('boss').get('name').once(function(data, key){\r\n // `val` grabs the data once, no subscriptions.\r\n console.log(\"Mark's boss is\", data);\r\n});\r\n\r\n// traverse a graph of circular references!\r\ngun.get('mark').get('boss').get('slave').once(function(data, key){\r\n console.log(\"Mark is the slave!\", data);\r\n});\r\n\r\n// add both of them to a table!\r\ngun.get('list').set(gun.get('mark').get('boss'));\r\ngun.get('list').set(gun.get('mark'));\r\n\r\n// grab each item once from the table, continuously:\r\ngun.get('list').map().once(function(data, key){\r\n console.log(\"Item:\", data);\r\n});\r\n\r\n// live update the table!\r\ngun.get('list').set({type: \"cucumber\", goal: \"scare cat\"});\r\n```\r\n\r\nWant to keep building more? **Jump to [THE DOCUMENTATION](#documentation)!**\r\n\r\n# What is GUN?\r\n\r\nFirst & foremost, GUN is **a community of the nicest and most helpful people** out there. So [I want to invite you](https://gitter.im/amark/gun) to come tell us about what **you** are working on & wanting to build (new or old school alike! Just be nice as well.) and ask us your questions directly. :)\r\n\r\nOn that note, let's get some official shout outs covered first:\r\n\r\n### Support\r\n\r\n

\r\nThanks to:\r\n \r\n

\r\n\r\n\r\n

\r\n\r\nRobert Heessels,\r\nLorenzo Mangani,\r\nNLnet Foundation,\r\nSam Liu,\r\nDaniel Dombrowsky,\r\nVincent Woo,\r\nAJ ONeal,\r\nBill Ottman,\r\nMike Lange,\r\nSean Matheson,\r\nAlan Mimms,\r\nDário Freire,\r\nJohn Williamson,\r\nRobin Bron,\r\nElie Makhoul,\r\nMike Staub,\r\nBradley Matusiak\r\n

\r\n\r\n - Join others in sponsoring code: https://www.patreon.com/gunDB !\r\n - Ask questions: http://stackoverflow.com/questions/tagged/gun ?\r\n - Found a bug? Report at: https://github.com/amark/gun/issues ;\r\n - **Need help**? Chat with us: https://gitter.im/amark/gun .\r\n\r\n### History\r\n\r\n[GUN](https://gun.eco) was created by [Mark Nadal](https://twitter.com/marknadal) in 2014 after he had spent 4 years trying to get his collaborative web app to scale up with traditional databases.\r\n\r\n $\"pain$ After he realized [Master-Slave database architecture causes one big bottleneck](https://gun.eco/distributed/matters.html), he (as a complete newbie outsider) naively decided **to question the status quo** and shake things up with controversial, heretical, and contrarian experiments:\r\n\r\n**The NoDB** - no master, no servers, no \"single source of truth\", not built with a real programming language or real hardware, no DevOps, no locking, not *just* SQL or NoSQL but both (**all** - graphs, documents, tables, key/value).\r\n\r\nThe goal was to build a P2P database that could survive living inside **any** browser, and could correctly sync data between **any** device after assuming **any** offline-first activity.\r\n\r\n $\"comparison$ \r\n\r\nTechnically, **GUN is a graph synchronization protocol** with a *lightweight embedded engine*, capable of doing *[20M+ API ops/sec](https://gun.eco/docs/Performance)* in **just ~9KB gzipped size**.\r\n\r\n## Documentation\r\n\r\n\r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n \r\n

API reference	Tutorials	Examples
GraphQL	Electron	React & Native
Vue	Svelte	Webcomponents
CAP Theorem Tradeoffs	How Data Sync Works	How GUN is Built
Crypto Auth	Modules	Roadmap

\r\n\r\nThis would not be possible without **community contributors**, big shout out to:\r\n\r\n**[ajmeyghani](https://github.com/ajmeyghani) ([Learn GUN Basics with Diagrams](https://medium.com/@ajmeyghani/gundb-a-graph-database-in-javascript-3860a08d873c))**; **[anywhichway](https://github.com/anywhichway) ([Block Storage](https://github.com/anywhichway/gun-block))**; **[beebase](https://github.com/beebase) ([Quasar](https://github.com/beebase/gun-vuex-quasar))**; **[BrockAtkinson](https://github.com/BrockAtkinson) ([brunch config](https://github.com/BrockAtkinson/brunch-gun))**; **[Brysgo](https://github.com/brysgo) ([GraphQL](https://github.com/brysgo/graphql-gun))**; **[d3x0r](https://github.com/d3x0r) ([SQLite](https://github.com/d3x0r/gun-db))**; **[forrestjt](https://github.com/forrestjt) ([file.js](https://github.com/amark/gun/blob/master/lib/file.js))**; **[hillct](https://github.com/hillct) (Docker)**; **[JosePedroDias](https://github.com/josepedrodias) ([graph visualizer](http://acor.sl.pt:9966))**; **[JuniperChicago](https://github.com/JuniperChicago) ([cycle.js bindings](https://github.com/JuniperChicago/cycle-gun))**; **[jveres](https://github.com/jveres) ([todoMVC](https://github.com/jveres/todomvc))**; **[kristianmandrup](https://github.com/kristianmandrup) ([edge](https://github.com/kristianmandrup/gun-edge))**; **[Lightnet](https://github.com/Lightnet)** ([Awesome Vue User Examples](https://glitch.com/edit/#!/jsvuegunui?path=README.md:1:0) & [User Kitchen Sink Playground](https://gdb-auth-vue-node.glitch.me/)); **[lmangani](https://github.com/lmangani) ([Cytoscape Visualizer](https://github.com/lmangani/gun-scape), [Cassandra](https://github.com/lmangani/gun-cassandra), [Fastify](https://github.com/lmangani/fastify-gundb), [LetsEncrypt](https://github.com/lmangani/polyGun-letsencrypt))**; **[mhelander](https://github.com/mhelander) ([SEA](https://github.com/amark/gun/blob/master/sea.js))**; [omarzion](https://github.com/omarzion) ([Sticky Note App](https://github.com/omarzion/stickies)); [PsychoLlama](https://github.com/PsychoLlama) ([LevelDB](https://github.com/PsychoLlama/gun-level)); **[RangerMauve](https://github.com/RangerMauve) ([schema](https://github.com/gundb/gun-schema))**; **[robertheessels](https://github.com/swifty) ([gun-p2p-auth](https://github.com/swifty/gun-p2p-auth))**; **[rogowski](https://github.com/rogowski) (AXE)**; [sbeleidy](https://github.com/sbeleidy); **[sbiaudet](https://github.com/sbiaudet) ([C# Port](https://github.com/sbiaudet/cs-gun))**; **[Sean Matheson](https://github.com/ctrlplusb) ([Observable/RxJS/Most.js bindings](https://github.com/ctrlplusb/gun-most))**; **[Shadyzpop](https://github.com/Shadyzpop) ([React Native example](https://github.com/amark/gun/tree/master/examples/react-native))**; **[sjones6](https://github.com/sjones6) ([Flint](https://github.com/sjones6/gun-flint))**; **[Stefdv](https://github.com/stefdv) (Polymer/web components)**; **[zrrrzzt](https://github.com/zrrrzzt) ([JWT Auth](https://gist.github.com/zrrrzzt/6f88dc3cedee4ee18588236756d2cfce))**; **[xmonader](https://github.com/xmonader) ([Python Port](https://github.com/xmonader/pygundb))**; \r\n\r\nI am missing many others, apologies, will be adding them soon! This list is infintiely old & way out of date, if you want to be listed in it please make a PR! :)\r\n\r\n## Testing\r\n\r\nTests may be run with `npm test`. Tests will trigger persistent writes to the DB, so subsequent runs of the test will fail. You must clear the DB before running the tests again. This can be done by running the following command in the project directory.\r\n\r\n```bash\r\nrm -rf *data*\r\n```\r\n\r\n### Additional Cryptography Libraries\r\n\r\n > These are only needed for NodeJS & React Native, they shim the native Browser WebCrypto API.\r\n\r\nIf you want to use [SEA](https://gun.eco/docs/SEA) for `User` auth and security, you will need to install:\r\n\r\n`npm install text-encoding @peculiar/webcrypto --save`\r\n\r\nPlease see [our React Native docs](https://gun.eco/docs/React-Native) for installation instructions!\r\n\r\nThen you can require [SEA](https://gun.eco/docs/SEA) without an error:\r\n\r\n```javascript\r\nvar GUN = require('gun/gun');\r\nvar SEA = require('gun/sea');\r\n```\r\n\r\n## Deploy\r\n\r\n > Note: The default examples that get auto-deployed on `npm start` CDN-ify all GUN files, modules, & storage.\r\n\r\nTo quickly spin up a GUN relay peer for your development team, utilize either [Heroku](http://heroku.com), [Docker](http://docker.com), any variant thereof [Dokku](http://dokku.viewdocs.io/dokku/), [Flynn.io](http://flynn.io), [now.sh](https://zeit.co/now), etc. ! Or use all of them so your relays are decentralized too!\r\n\r\n### [Heroku](https://www.heroku.com/)\r\n\r\n[![Deploy](https://www.herokucdn.com/deploy/button.svg)](https://heroku.com/deploy?template=https://github.com/amark/gun)\r\n\r\n > Heroku deletes your data every 15 minutes, one way to fix this is by adding [cheap storage](https://gun.eco/docs/Using-Amazon-S3-for-Storage).\r\n\r\nOr:\r\n\r\n```bash\r\ngit clone https://github.com/amark/gun.git\r\ncd gun\r\nheroku create\r\ngit push -f heroku HEAD:master\r\n```\r\n\r\nThen visit the URL in the output of the 'heroku create' step, in a browser.\r\n\r\n### [Now.sh](https://zeit.co/now/)\r\n\r\n```bash\r\nnpm install -g now\r\nnow --npm amark/gun\r\n```\r\n\r\nThen visit the URL in the output of the 'now --npm' step, in your browser.\r\n\r\n### [Unubo](https://unubo.app/)\r\n\r\nFork this GUN repo (Unubo only deploys from your own GitHub repo's). \r\nAdd a Node.js app, select your GUN fork, set `npm start` start as the command and deploy. \r\n\r\nFrom the experience of [genderev](https://github.com/genderev), this only works if you set your country to the United States.\r\n\r\nVisit the deployed app by following the 'view app' button, in your browser.\r\n\r\n### [Docker](https://www.docker.com/)\r\n\r\n > Warning: Docker image is community contributed and may be old with missing security updates, please check version numbers to compare.\r\n\r\n[![Docker Automated buil](https://img.shields.io/docker/automated/gundb/gun.svg)](https://hub.docker.com/r/gundb/gun/) [![](https://images.microbadger.com/badges/image/gundb/gun.svg)](https://microbadger.com/images/gundb/gun \"Get your own image badge on microbadger.com\") [![Docker Pulls](https://img.shields.io/docker/pulls/gundb/gun.svg)](https://hub.docker.com/r/gundb/gun/) [![Docker Stars](https://img.shields.io/docker/stars/gundb/gun.svg)](https://hub.docker.com/r/gundb/gun/)\r\n\r\nPull from the [Docker Hub](https://hub.docker.com/r/gundb/gun/) [![](https://images.microbadger.com/badges/commit/gundb/gun.svg)](https://microbadger.com/images/gundb/gun). Or:\r\n\r\n```bash\r\ndocker run -p 8765:8765 gundb/gun\r\n```\r\n\r\nOr build the [Docker](https://docs.docker.com/engine/installation/) image locally:\r\n\r\n```bash\r\ngit clone https://github.com/amark/gun.git\r\ncd gun\r\ndocker build -t myrepo/gundb:v1 .\r\ndocker run -p 8765:8765 myrepo/gundb:v1\r\n```\r\n\r\nOr, if you prefer your Docker image with metadata labels (Linux/Mac only):\r\n\r\n```bash\r\nnpm run docker\r\ndocker run -p 8765:8765 username/gun:git\r\n```\r\n\r\nThen visit [http://localhost:8765](http://localhost:8765) in your browser.\r\n\r\n## License\r\n\r\nDesigned with ♥ by Mark Nadal, the GUN team, and many amazing contributors.\r\n\r\nOpenly licensed under [Zlib / MIT / Apache 2.0](https://github.com/amark/gun/blob/master/LICENSE.md).\r\n\r\n[![FOSSA Status](https://app.fossa.io/api/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Famark%2Fgun.svg?size=large)](https://app.fossa.io/projects/git%2Bhttps%3A%2F%2Fgithub.com%2Famark%2Fgun?ref=badge_large)\r\n\r\n[YouTube](https://www.youtube.com/channel/UCQAtpf-zi9Pp4__2nToOM8g) . [Twitter](https://twitter.com/marknadal)\r\n","has_starred","hub_user","immutable_tags_settings",{"_72":11,"_73":74},"enabled","rules",[75],".*","is_automated","permissions",{"_79":17,"_80":11,"_81":11},"read","write","admin","user","storage_size",90874707,"orgData",{"_87":88,"_89":90,"_91":92,"_93":29,"_94":95,"_96":97,"_98":99,"_100":101,"_102":103,"_104":105,"_106":44,"_107":44,"_108":17},"id","7f485f08042949c5abeed1b0fab53a33","uuid","7f485f08-0429-49c5-abee-d1b0fab53a33","type","organization","orgname","full_name","GUN","location","SF, CA, USA","company","ERA","profile_url","https://gun.eco","date_joined","2016-11-29T18:11:54.220097Z","gravatar_url","https://www.gravatar.com/avatar/6d58634502eb9083eb0b27b664ae0ff1?s=80&r=g&d=mm","gravatar_email","badge","is_active","recentTags",[111],{"_112":40,"_113":114,"_115":116,"_87":117,"_118":119,"_46":136,"_137":114,"_138":29,"_139":52,"_53":140,"_141":142,"_143":127,"_144":136,"_145":62,"_146":17},"content_type","creator",1288505,"full_size",25056830,114866815,"images",[120],{"_121":122,"_123":124,"_125":44,"_126":127,"_128":129,"_130":131,"_132":44,"_133":-5,"_134":116,"_59":62,"_135":-5},"architecture","amd64","digest","sha256:2412e28280316e9992e187df083a9b57202f37a827e5e45a5ac8b3bec7682287","features","last_pulled","2026-09-29T04:37:32.703247481Z","last_pushed","2021-03-01T19:11:06Z","os","linux","os_features","os_version","size","variant","2021-03-01T19:11:05.626567Z","last_updater","last_updater_username","media_type","latest","repository",9711519,"tag_last_pulled","tag_last_pushed","tag_status","v2","sbxKitMetadata","isPotentialSpam","isHubSbxKitsEnabled","showSbxLogoOverride","sbxTrademarkText","displaySecurityMetadata","tagAttestations","tagsHaveAttestations",[],"routes/_layout.r.$namespace.$reponame.tags",{"_34":158,"_165":166,"_154":175,"_176":11},{"_36":159,"_38":160,"_41":42,"_43":44,"_45":11,"_46":47,"_48":49,"_50":161,"_53":31,"_28":29,"_54":55,"_56":40,"_57":58,"_59":60,"_61":62,"_63":-5,"_64":65,"_66":67,"_68":11,"_69":29,"_70":162,"_76":11,"_77":164,"_82":29,"_83":84},[],[40],[52],{"_72":11,"_73":163},[75],{"_79":17,"_80":11,"_81":11},"tags",{"_167":60,"_168":-5,"_169":-5,"_170":171},"count","next","previous","results",[172],{"_112":40,"_113":114,"_115":116,"_87":117,"_118":173,"_46":136,"_137":114,"_138":29,"_139":52,"_53":140,"_141":142,"_143":127,"_144":136,"_145":62,"_146":17},[174],{"_121":122,"_123":124,"_125":44,"_126":127,"_128":129,"_130":131,"_132":44,"_133":-5,"_134":116,"_59":62,"_135":-5},[],"canDeleteTags","actionData","errors"]

gundb/gun

Tags for gundb/gun