aboutsummaryrefslogtreecommitdiffstats
path: root/diy-dat.md
diff options
context:
space:
mode:
authorJoe Hand <joe@joeahand.com>2016-08-05 08:47:15 -0700
committerGitHub <noreply@github.com>2016-08-05 08:47:15 -0700
commitffb465bb3bcebb62c5e63cc3ed80d70274848deb (patch)
tree68203eafcf5b422464dbd4ebf53742e487735ad9 /diy-dat.md
parent2b6ddccb62e7c425ed2a88b8cd9f94322d31aaaa (diff)
downloaddat-docs-ffb465bb3bcebb62c5e63cc3ed80d70274848deb.tar.gz
dat-docs-ffb465bb3bcebb62c5e63cc3ed80d70274848deb.zip
Use ecosystem docs to add module readme docs (#12)
* organize for ecosystem docs and cleanup Signed-off-by: Joe Hand <joe@joeahand.com> * add ecosystem-docs commands, build file, docs * remove transform & fix content typo * upgrade minidocs
Diffstat (limited to 'diy-dat.md')
-rw-r--r--diy-dat.md73
1 files changed, 0 insertions, 73 deletions
diff --git a/diy-dat.md b/diy-dat.md
deleted file mode 100644
index f95eb11..0000000
--- a/diy-dat.md
+++ /dev/null
@@ -1,73 +0,0 @@
-# DIY Dat
-
-This document shows how to write your own compatible `dat` client using node modules.
-
-The three essential node modules are called [hyperdrive](https://npmjs.org/hyperdrive), [discovery-swarm](https://npmjs.org/discovery-swarm) and [level](https://npmjs.org/level). Hyperdrive does file synchronization and versioning, discovery-swarm does peer discovery over local networks and the Internet, and level provides a local LevelDB for storing metadata. More details are available in [How Dat Works](how-dat-works.md). The [dat](https://npmjs.org/dat) module itself is just some code that combines these modules and wraps them in a command-line API.
-
-Here's the minimal code needed to download data from a dat:
-
-```js
-var Swarm = require('discovery-swarm')
-var Hyperdrive = require('hyperdrive')
-var Level = require('level')
-
-// run this like: node thisfile.js 4c325f7874b4070blahblahetc
-// the dat link someone sent us, we want to download the data from it
-var link = new Buffer(process.argv[2], 'hex')
-
-// here is the default config dat uses
-// used for MDNS and also as the dns 'app name', you prob shouldnt change this
-var DAT_DOMAIN = 'dat.local'
-// dat will try this first and pick the first open port if its taken
-var DEFAULT_LOCAL_PORT = 3282
-// we run the servers below you can use if you want or run your own
-var DEFAULT_DISCOVERY = [
- 'discovery1.publicbits.org',
- 'discovery2.publicbits.org'
-]
-var DEFAULT_BOOTSTRAP = [
- 'bootstrap1.publicbits.org:6881',
- 'bootstrap2.publicbits.org:6881',
- 'bootstrap3.publicbits.org:6881',
- 'bootstrap4.publicbits.org:6881'
-]
-
-var db = Level('./dat.db')
-var drive = Hyperdrive(db)
-var swarm = Swarm({
- id: drive.core.id,
- dns: {server: DEFAULT_DISCOVERY, domain: DAT_DOMAIN},
- dht: {bootstrap: DEFAULT_BOOTSTRAP},
- stream: function () {
- // this is how the swarm and hyperdrive interface
- console.log('new peer stream')
- return drive.createPeerStream()
- }
-})
-
-swarm.once('listening', function () {
- console.log('joining', link)
- // join the swarm
- swarm.join(new Buffer(link, 'hex'))
- // tell hyperdrive to start downloading/uploading in ./data
- var archive = drive.get(link, process.cwd() + '/data')
- archive.ready(function (err) {
- console.log('archive ready')
- // a stream of all metadata. after retrieving each entry metadata will be cached locally
- // but the first time it has to fetch it from the swarm
- var metadata = archive.createEntryStream()
- // start downloading all entries, or choose your own filter logic to download specific entries
- // entries will be either files or directories
- metadata.on('data', function (entry) {
- var dl = archive.download(entry)
- console.log('downloading', entry.name, dl)
-
- dl.on('ready', function () {
- console.log('download started', entry.name, dl)
- })
- })
- })
-})
-
-swarm.listen(DEFAULT_LOCAL_PORT)
-```