diff options
Diffstat (limited to 'docs/terms.md')
| -rw-r--r-- | docs/terms.md | 90 |
1 files changed, 46 insertions, 44 deletions
diff --git a/docs/terms.md b/docs/terms.md index 7ce0ff4..a8aa52e 100644 --- a/docs/terms.md +++ b/docs/terms.md @@ -1,54 +1,56 @@ -## General Terminology +# Terminology -### Dat archive +## Dat Terms -A folder containing files of any type, which can be synced to other people on the distributed web. A Dat archive has content (files) and metadata, both shared to peers. +Terms specific to the Dat software. -A Dat archive has a Dat link used to share with other people. +### dat, Dat archive, archive -### Distributed Web +A dat, or Dat archive, is a set of files and dat metadata (see [SLEEP](#sleep)). A dat folder can contain files of any type, which can be synced to other users. A dat has a Dat link used to share with other people. -In a Distributed Web (P2P) model, those who are downloading the data are also providing some of the bandwidth and storage to run it. Instead of one server, we have many. The more people or organizations that are involved in the Distributed Web, the more redundant, safe, and fast it will become. +When you create a dat, you're creating a `.dat` folder to hold the metadata and the dat keys (a public and secret key). -Currently, the Web is centralized: if someone controls the hardware or the communication line, then they control all the uses of that website. [Read more here](http://brewster.kahle.org/2015/08/11/locking-the-web-open-a-call-for-a-distributed-web-2/). +### Dat Link or Dat Key -### Peer to Peer (P2P) +Identifier for a dat, e.g. `dat://ab3ed4f...`. These are 64 character hashes with the `dat://` protocol prefix. Anyone with the Dat link can download and re-share files in a dat. -A P2P software program searches for other connected computers on a P2P network to locate the desired content. The peers of such networks are end-user computer systems that are interconnected via the Internet. +### Secret Key -In Dat, peers only connect if they both have the same Dat link. +Dat links are the public part of a key pair. Users that have the secret key are able to write updates to a dat. -### Peer +With the Dat CLI and Desktop application, secret keys are stored in a dat folder in your home directory, `~/.dat/secret_keys`. It is important to back these up if you get a new computer. -Another user or server who has downloaded the data (or parts of it) and is uploading it to others in the Dat Swarm. +### Writer -### Swarm or Network +User who can write to a Dat archive. This user has the secret key, allowing them to write data. Currently, dats are single-writer. -A group of peers that want or have downloaded data for a Dat archive and are connected to each other over the Distributed Web. +### Collaborator -### Owner +User who are granted read access to a Dat archive by the owner. A collaborator can access a Dat archive if the owner or another collaborator sends the the Dat link. -User who owns a Dat archive. This user has the secret key on local machine allowing them to write data. +In the future, users will be able to grant collaborators write access to the Dat archive, allowing them to modify and create files in the archive. -### Collaborator +### Swarm or Network -User who are granted read access to a Dat archive by the owner. A collaborator can access a Dat archive if the owner or another collaborator sends the the Dat link. +A group of peers that want or have downloaded data for a Dat archive and are connected to each other over the Distributed Web. -In the future, owners will be able to grant collaborators write access to the Dat archive, allowing them to modify and create files in the archive. +## General Terms -### Secure Register +### Distributed Web -A [register]( https://gds.blog.gov.uk/2015/09/01/registers-authoritative-lists-you-can-trust/) is an authoritative list of information you can trust. We maintain an open register called [Dat Folder](https://datproject.org) which contains public data, and is open to everyone. +In a Distributed Web (P2P) model, those who are downloading the data also provide bandwidth and storage to share it. Instead of one server, we have many. The more people or organizations that are involved in the Distributed Web, the more redundant, safe, and fast it will become. -### Dat Link +Currently, the Web is centralized: if someone controls the hardware or the communication line, then they control all the uses of that website. [Read more here](http://brewster.kahle.org/2015/08/11/locking-the-web-open-a-call-for-a-distributed-web-2/). -Identifier for a Dat archive, e.g. `dat://ab3ed4f...`. These are 64 character hashes with the `dat://` protocol prefix. Anyone with the Dat link can download and re-share files in a Dat archive. +### Peer to Peer (P2P) -### Snapshot Archive +A P2P software program searches for other connected computers on a P2P network to locate the desired content. The peers of such networks are end-user computer systems that are interconnected via the Internet. -A snapshot archive uses a content-based hash as the Dat link. This means that the link is unique for that set of files and content. Once the content changes, the link will change. +In Dat, peers only connect if they both have the same Dat link. -Snapshot archives can be used as checkpoints or for publishing specific versions of datasets with guarantees that the content will not change. +### Secure Register + +A [register]( https://gds.blog.gov.uk/2015/09/01/registers-authoritative-lists-you-can-trust/) is an authoritative list of information you can trust. We maintain an open register called [Dat Folder](https://datproject.org) which contains public data, and is open to everyone. ### Beaker @@ -56,15 +58,13 @@ The [Beaker Browser](https://beakerbrowser.com/) is an experimental p2p browser ## Technical Terms -### Metadata - -Like an HTTP header, the metadata contains a pointer to the contents of Dat and the file list. +### SLEEP -The metadata is a hypercore feed. +SLEEP is the the on-disk format that Dat produces and uses. It is a set of 9 files that hold all of the metadata needed to list the contents of a Dat repository and verify the integrity of the data you receive. -### Content Feed +The acronym SLEEP is a slumber related pun on REST and stands for Syncable Lightweight Event Emitting Persistence. The Event Emitting part refers to how SLEEP files are append-only in nature, meaning they grow over time and new updates can be subscribed to as a realtime feed of events through the Dat protocol. -The content feed is a hypercore feed containing the file contents for a Dat archive. The content feed together with a metadata feed make a Dat archive. +Read the full [SLEEP specification](https://github.com/datproject/docs/blob/master/papers/dat-paper.md#3-sleep-specification) in the dat whitepaper. ### Key @@ -78,26 +78,28 @@ The public key is the key that is shared in the Dat Link. Messages are signed us The discovery key is a hashed public key. The discovery key is used to find peers on the public key without exposing the original public key to network. -### Feed / Core Feed +### Feed -A feed is a term we use interchangeably with the term "append-only log". It’s the lowest level component of Dat. +A feed is a term we use interchangeably with the term "append-only log". It’s the lowest level component of Dat. For each Dat, there are two feeds - the metadata and the content. -Feeds are created with hypercore. +Feeds are created with hypercore. -### Hyperdrive +### Metadata Feed -[Hyperdrive](https://github.com/mafintosh/hyperdrive) is peer to peer directories. We built hyperdrive to efficiently share scientific data in real time between research institutions. Hyperdrive handles the distribution of files while encrypting data transfer and ensuring content integrity. Hyperdrive creates append-only logs for file changes allow users to download partial datasets and to create versioned data. Hyperdrive is built on hypercore. +Like an HTTP header, the metadata contains a pointer to the contents of Dat and the file list. -Archives created with hyperdrive are made with two feeds, one for the metadata and one for the content. A hyperdrive instance can store any number of archives. +The metadata is a hypercore feed. The first entry in the metadata feed is the key for the content feed. -### Hypercore +### Content Feed -[Hypercore](https://github.com/mafintosh/hypercore) is a protocol and network for distributing and replicating feeds of binary data. This creates an efficient gossip network where latency is reduced to a minimum. Hypercore is an eventually consistent, highly available, partition tolerant system. +The content feed is a hypercore feed containing the file contents for a Dat archive. The content feed together with a metadata feed make a Dat archive. -Hypercore instances can contain any number of feeds. +### Hyperdrive -### Hyper- (modules) +[Hyperdrive](https://github.com/mafintosh/hyperdrive) is peer to peer directories. We built hyperdrive to efficiently share scientific data in real time between research institutions. Hyperdrive handles the distribution of files while encrypting data transfer and ensuring content integrity. Hyperdrive creates append-only logs for file changes allow users to download partial datasets and to create versioned data. Hyperdrive is built on hypercore. + +Archives created with hyperdrive are made with two feeds, one for the metadata and one for the content. -Modules that are use hyperdrive archives or hypercore feeds in a cross-compatible way, for example [hyperdiscovery](https://github.com/karissa/hyperdiscovery) or [hyperhealth](https://github.com/karissa/hyperhealth). +### Hypercore -If a module is only compatible with one one of hyperdrive or hypercore, they should be prefixed with that name, e.g. [hyperdrive-import-files](https://github.com/juliangruber/hyperdrive-import-files). +[Hypercore](https://github.com/mafintosh/hypercore) is a protocol and network for distributing and replicating feeds of binary data. This creates an efficient gossip network where latency is reduced to a minimum. Hypercore is an eventually consistent, highly available, partition tolerant system. |