11_Volume_Specs.md

Volume Specs

WebFS volumes are specified by JSON configuration files in the filesystem with names ending in .webfs

WebFS volumes consist of a cell, a store, and a salt. The salt is only used when adding files.

Every volume spec should look something like this

{
    "cell": {
        ...
    },
    "store" : {
        ...
    },
    "salt": "hJYTuuOky0Q4w25olAF+UY894bnNgRkXO2OIyeRd+yE="
}

Cells

file

e.g.

{
   "cell": {
        "file": "path/to/cell"
    }
    ...
}

http

e.g.

{
   "cell": {
        "http": {
            "url": "http://example.com/cells/1234",
            "headers": {
                "X-My-Header": "header-value",
            }
        }
    }
    ...
}

aead

e.g.

{
   "cell": {
        "aead": {
            "inner": {
                ...
            },
            "algo": "chacha20poly1305",
            "secret": "hJYTuuOky0Q4w25olAF+UY894bnNgRkXO2OIyeRd+yE="
        }
    }
    ...
}

got_branch

e.g.

{
   "cell": {
        "got_branch": {
            "inner": {
                ...
            }, 
        }
    }
    ...
}

Stores

fs

e.g.

{
    "store": {
        "fs": "path/to/dir",
    }
    ...
}

http

e.g.

{
    "store": {
        "http": "path/to/dir",
    }
    ...
}

blobcache

e.g.

{
    "store": {
        "blobcache": {}
    }
    ...
}

ipfs

e.g.

{
    "store": {
        "ipfs": {},
    }
    ...
}