DocsCommunity

The database for
freedom fighters

Get started

Get ready to disrupt Big Tech

GUN gives you the most powerful weapons of the internet — and — to reclaim the web and make it truly free and open.

GUN au­thor Mark Nadal on why he is build­ing a de­cen­tral­ized web, and what it looks like.
Mark Nadal at Nordic.js 2017 - The De­sign and Evo­lu­tion of Event-Dri­ven Data­bas­es

Powerful and flexible

GUN is a data­base en­gine that runs every­where JavaScript does — browsers, mo­bile de­vices and servers, al­low­ing you to build ex­act­ly the data sys­tem you want.

Learn how to add GUN to an existing React oder Svelte appBuild a distributed & fault tolerant data delivery system

20 Million monthly downloads

GUN is pow­er­ing de­cen­tral­ized plat­forms with mil­lions of users and vast­ly dif­fer­ent re­quire­ments on a shoe­string bud­get.

See how HackerNoon handles ~4M users on $0 server costsDecentralizing the Internet Archive with lots of GUNs

Decentralized auth built-in

GUN's se­cu­ri­ty mod­ule is built on strong en­cryp­tion stan­dards and works com­plete­ly de­cen­tral­ized. In oth­er words — real pri­va­cy with no sin­gle point of fail­ure.

Learn how to securely store and exchange user dataBuild a multi-user chat with e2e encryption
const Me = gun.user()
const Barry = gun.user(barrys_pub_key)

Me.auth('Larry', 'h4x0r-Llama-123', ret => {
  if(ret.err)
    return console.error('auth failed: ', ret.err)
  // let Barry read what I want for my birthday
  Me.get('secret-birthday-wish').grant(Barry)
})
Read more about SEA, GUN's built-in module for Security, Encryption and Authentication
const Larry = gun.get('larry').put({name: 'Larry'})
const Barry = gun.get('barry').put({name: 'Barry'})

Larry.get('bff').put(Barry)
Barry.get('bff').put(Larry)

// goin from Larry to his BFF's BFF
Larry.path('bff.bff.name').once(name => {
  console.log(name) // -> Larry
})
Learn how to create, traverse, index and query linked data in GUN

Graph data for the win

GUN's graph data mod­el al­lows you to use in­tu­itive data struc­tures and queries, while still be­ing ca­pa­ble of do­ing 20M+ API ops/sec in just ~9KB gzipped size.

Read more about GUN's graph data structureQuery a GUN database with GraphQL

Respond in real-time

Any re­mote up­dates to the data you sub­scribe to will be au­to­mat­i­cal­ly prop­a­gat­ed through the net­work, so you can re­act to changes as they hap­pen.

Learn how GUN peers find and talk to each otherWatch GUN's author implement its sync algorithm from scratch
// on your device
navigator.geolocation.watchPosition(position => {
  gun.get('coords').put(position.coords)
})

// in your app
gun.get('coords').on(coords => {
    map.dot.move(coords.latitude, coords.longitude)
})
Learn how to set up a fault-tolerant distributed GUN network to transfer live data around the world

GUN in 5 minutes

(click the boxes to copy the text)

  1. Add the GUN library. GUN runs in browsers, in Node.js, Elec­tron, and even Re­act Na­tive. In­stall it from npm, use a CDN, or down­load it here.

    <!-- To get going, add GUN to your website from a CDN -->
<script src="https://cdn.jsdelivr.net/npm/gun/gun.js"></script>

  2. Play around with your data. GUN's core API is de­lib­er­ate­ly small but pow­er­ful. For more, check out GUN's many use­ful ex­ten­sions or ex­plore its wider ecosys­tem

    As an ex­am­­ple, run the fol­low­ing snip­pets in the con­­soles of two sep­a­rate tabs or browsers:

    // Connect to as many peers as you want
const gun = Gun({ peers: ['http://localhost:8765/gun', 'http://gunjs.herokuapp.com/gun'] })

// Then make the browser regularly update the db
setInterval(() => {
  gun.get('bob').get('heartbeat').put(Date.now())
}, 1000)
    // Browsers will discover each other automatically through one of the many peers
const gun = Gun({ peers: ['http://localhost:8765/gun', 'http://gunjs.herokuapp.com/gun'] })

// And listen to the heartbeat updates in real-time
gun.get('bob').get('heartbeat').on(heartbeat => {
  const diff = Date.now() - heartbeat
  console.log(`Bob's heartbeat traveled ${diff} ms`)
})

  3. Run a GUN relay. (op­tion­al) A re­lay can run on your lap­top or in the cloud, they are used as fall­backs when We­bRTC fails. You can de­ploy one to heroku, spin it up in dock­er, use the node.js API di­rect­ly, or start one with GUN's cli like this:

    #  Assuming you have node.js and npm installed, run this in your command line
npx gun-cli --host 127.0.0.1

Nice, right?

But we've bare­ly scratched the sur­face. Start the tu­to­r­i­al or check out the doc­u­men­ta­tion to see what else you can do with GUN!

Jump straight to GUN's DocumentationTutorial: Create a distributed multi-user todo app