isle/docs/operator/contributing-storage.md
Brian Picciano b35a3d6574 First public commit
There has been over 1 year of commit history leading up to this point,
but almost all of that has had some kind network configuration or
secrets built into the code. As of today all of that has been removed,
and the codebase can finally be published!

I am keeping a private copy of the previous commit history, though it's
unclear if it will ever be able to be published.
2022-07-04 15:18:55 -06:00

2.0 KiB

Contributing Storage

If your host machine can be reasonably sure of being online most, if not all, of the time, and has 100GB or more of unused drive space you'd like to contribute to the network, then this document is for you.

Create daemon.yml

First, if you haven't already, create a daemon.yml file. This will be used to configure your cryptic-net daemon process with the storage locations and capacities you want to contribute.

Edit daemon.yml

Open your daemon.yml file in a text editor, and find the storage.allocations section.

Each allocation in the allocations list describes the space being contributed from a single physical drive. If you only have one drive then you will only need one allocation listed.

The comments in the file should be self-explanatory, but ask your admin if you need any clarification.

Here are an example set of allocations for a host which is contributing space from two separate drives:

storage:
  allocations:

    # 1.2 TB are being shared from drive1
    - data_path: /mnt/drive1/cryptic-net/data
      meta_path: /mnt/drive1/cryptic-net/meta
      capacity: 1200
      api_port: 3900
      rpc_port: 3901
      web_port: 3902

    # 100 GB (the minimum) are being shared from drive2
    - data_path: /mnt/drive2/cryptic-net/data
      meta_path: /mnt/drive2/cryptic-net/meta
      capacity: 100
      api_port: 3910
      rpc_port: 3911
      web_port: 3912

Setup Firewall

You will need to configure your hosts's firewall to allow traffic from cryptic-net IPs on the ports you specified in your allocations.

Restart the Daemon

With the daemon.yml configured, you should restart your cryptic-net daemon process.

Further Reading

cryptic-net uses the garage project for its storage system. See the Managing Garage document for more information on how to interact directly with the garage instance being run by cryptic-net.