Filesystem

In order to keep the configuration required to run tau as minimal as possible, we’ve adopted a convention-based approach. In this section, we’ll discuss the filesystem conventions we employ.

Taubyte Root

Taubyte-related files, apart from system-related items such as systemd configuration, are self-contained within the /tb folder. If, for some reason, you need to alter this location, you can use mount --bind command.

Below is a snapshot of what this directory typically looks like:

/tb
├── bin
│   └── tau
├── cache
├── config
│   ├── all.yaml
│   ├── elders.yaml
│   └── keys
│       ├── dv.key
│       ├── dv.pem
│       └── swarm.key
└── storage

bin

This folder contains the tau binary along with any related tools.

config

This folder contains configuration files. Each shape will have an associated YAML file.

An example of a shape configuration file is shown below:

privatekey: CAES...qvfnyaJY=
swarmkey: /tb/config/keys/swarm.key
protocols:
    - tns
    - node
    - seer
addresses:
    - 1.2.3.4
ports:
    ipfs: 4288
    lite: 4244
    main: 4224
location:
    lat: 22
    long: 33
peers:
    - /ip4/1.2.3.5/tcp/4242/p2p/12D3KooWQ...kkMamCAed
    - /ip4/1.2.3.6/tcp/4242/p2p/12D3KooWG...mchUM1SNY
    - /ip4/1.2.3.7/tcp/4242/p2p/12D3KooWM...o7kcDxP3S
http-listen: 0.0.0.0:443
network-url: cod3.gg
domains:
    key:
        private: /tb/config/keys/dv.key
        public: /tb/config/keys/dv.pem
    whitelist:
        postfix: []
        regex: []
    services: ^[^.]+\.tau\.cod3\.gg
    generated: g.cod3.gg

cache

This directory is used for caching compiled webassembly modules, build objects, etc.

storage

Each shape is associated with an tau instance. If you’re using systemd, the default instance name is tau@<shape-name>. Each shape stores its data under its respective folder in the storage directory.

Plugins

All plugins are stored in the /tb/plugins directory. This centralized storage makes it easier to manage and locate the various plugins that you might use with tau.