Lotus Seal Worker documentation needs updating

Hello Filecoin Team,

Based on my understanding from reading the document and the current version of lotus-seal-workder as of 2020-06-26, this following page needs updating to reflect the latest version of lotus-seal-worker:

https://docs.lotu.sh/en+lotus-seal-worker

If there is any misunderstanding on my part which results in incorrect suggestions below, please feel free to correct me and scratch the incorrect suggestion(s).

Suggestions for updates:

  • there is no mention of how the new “–address” option works for “lotus-seal-worker run”
  • the screen output examples given to " check that the remote worker count has increased." does not showing any “remote worker”
why@computer ~/lotus> lotus-storage-miner workers list
Worker 0, host computer
        CPU:  [                                                                ] 0 core(s) in use
        RAM:  [||||||||||||||||||                                              ] 28% 18.1 GiB/62.7 GiB
        VMEM: [||||||||||||||||||                                              ] 28% 18.1 GiB/62.7 GiB
        GPU: GeForce RTX 2080, not used
Worker 1, host computer
        CPU:  [                                                                ] 0 core(s) in use
        RAM:  [||||||||||||||||||                                              ] 28% 18.1 GiB/62.7 GiB
        VMEM: [||||||||||||||||||                                              ] 28% 18.1 GiB/62.7 GiB
        GPU: GeForce RTX 2080, not used
  • under the “Running Over the Network” section, there should be no need to differentiate the IP addresses in the ListenAddress and RemoteListenAddress parameters because they would most often be same, which would be easier for people to understand. In addition, the following sentence should be removed because it will cause confusion/problem when people follow the instructions later about setting the STORAGE_NODE_MULTIADDR string for the STORAGE_API_INFO environment variable (i.e. simply the multiaddr string from the ListenAddress parameter in the config.toml.

remove:

A more permissive and less secure option is to change it to 0.0.0.0 .

  • “Running alongside Storage Minder” section’s instruction does not apply to the current miner and seal-worker operations. “lotus-seal-worker run” does not simply run and work with the locally running miner instance.

  • An example should be given for “Running Over the Network” section, with the miner server’s IP and seal-worker’s IP and the associated configuration and environment variables.

e.g. Miner IP: 192.168.0.1, Seal-worker (with a GPU) IP: 192.168.0.2

[For the Miner]

$LOTUS_STORAGE_PATH/config.toml:

[API]
ListenAddress = “/ip4/192.168.0.1/tcp/2345/http”
RemoteListenAddress = “192.168.0.1:2345”

generate the auth token for the remote seal-worker: this is to be used in seal-worker’s $STORAGE_API_INFO environment variable:

lotus-storage-miner auth create-token --perm admin

[For the Seal-worker]
Seal-worker’s environment:

obtain from the ‘auth’ the command run in the miner above, set the STORAGE_API_INFO env

e.g.
export STORAGE_API_INFO=eyJhbGciOiJIUzI2NiIsInR7cCI6IkpXVCJ9.eyJBbGxvdyI6WyJyZWFkIiwid3JpdGUiLCJzaWduIiwiYTWtbW4iXX0.CwVcYYTnxjlR7vRdSqqjuFZWoEbNAxfuJG7WSPijm1c:/ip4/192.168.0.1/tcp/2345/http

start the seal-worker

lotus-seal-worker run