diff options
| author | Karissa McKelvey <krmckelv@gmail.com> | 2016-01-11 00:29:42 -0800 |
|---|---|---|
| committer | Karissa McKelvey <krmckelv@gmail.com> | 2016-01-11 00:29:42 -0800 |
| commit | ce225a4d59ca8713baf3c956179cb9783b30363c (patch) | |
| tree | e478be5bcc2b89d167dca93d055635cac4fbb491 | |
| parent | 8b98e2331d7d1f83a27db3753040d9382c357573 (diff) | |
| download | dat-docs-ce225a4d59ca8713baf3c956179cb9783b30363c.tar.gz dat-docs-ce225a4d59ca8713baf3c956179cb9783b30363c.zip | |
move tech docs to index
| -rw-r--r-- | README.md | 23 | ||||
| -rw-r--r-- | mkdocs.yml | 1 | ||||
| -rw-r--r-- | technical.md | 19 |
3 files changed, 23 insertions, 20 deletions
@@ -2,6 +2,28 @@ Documentation resources for upcoming [dat](https://github.com/maxogden/dat) 1.0 release and the surrounding ecosystem. +## Hosting + +By default, dat looks to host on port 3282, and if taken, will choose a random open port. + +## Hidden folder + +Dat stores its data in a hidden folder that is stored by default in the user's home directory. + +``` +~/.dat +``` + +Because of this, data is only ever downloaded once. That is, if you have multiple projects that use the same data (perhaps at different versions) on the same machine, dat will first check the global `.dat` folder. + +The global `.dat` folder has inside: + +``` +$ ls ~/.dat +db +config.json +``` + ## Dat dependency overview #### [hyperdrive](https://github.com/mafintosh/hyperdrive) @@ -11,3 +33,4 @@ The file sharing network dat uses to distribute files and data. A technical spec #### [discovery-channel](https://github.com/maxogden/discovery-channel) This is the module dat uses to find peers on the local network or the internet who are sharing the same files and data that you are. + @@ -2,7 +2,6 @@ site_name: Dat project theme: readthedocs pages: - Home: 'README.md' -- Technical Guide: 'technical.md' - Meta: - 'Changelog': 'meta/changelog.md' - 'Collaborators': 'meta/collaborators.md' diff --git a/technical.md b/technical.md deleted file mode 100644 index 3c68953..0000000 --- a/technical.md +++ /dev/null @@ -1,19 +0,0 @@ -## Hidden folder - -Dat stores its data in a hidden folder that is stored by default in the user's home directory. - -``` -~/.dat -``` - -Because of this, data is only ever downloaded once. That is, if you have multiple projects that use the same data (perhaps at different versions) on the same machine, dat will first check the global `.dat` folder to see if the data has already been downloaded before querying the network. - -The global `.dat` folder has: - -``` -$ ls ~/.dat -db -config -``` - -`dat` will first check `/root/.dat` and then `~/.dat`. So, if you want to have the .dat available globally, move the folder to `/root/.dat`. |