History

Masih H. Derkani d044e30e12 Infer index provider topic from network name by default Index provider integration uses a gossipsub topic to announce changes to the advertised content. The topic name was fixed to the default topic which is `/indexer/ingest/mainnet`. In the case of lotus, the gossipsub validators enforce a list of topics the instance is permitted to join by setting subscription filter option when `PubSub` instance is constructed via DI. Having the fixed topic name meant that any SP starting up a node on a network other than `mainnet` would have to override the default config to avoid the node crashing when index provider is enabled. Instead of a fixed default, the changes here infer the allowed indexer topic name from network name automatically if the topic configuration is left empty. Fixes #8510		2022-04-22 02:46:05 +02:00
..
architecture	segregate chain and state blockstores.	2021-02-28 22:49:44 +00:00
.glossary.json	Delete most docs. Update about page with links to docs.filecoin.io	2020-09-17 20:35:19 +02:00
.library.json	Delete most docs. Update about page with links to docs.filecoin.io	2020-09-17 20:35:19 +02:00
about.md	Delete most docs. Update about page with links to docs.filecoin.io	2020-09-17 20:35:19 +02:00
api-v0-methods-miner.md	feat: miner: API/CLI to compute window-post	2022-03-28 17:06:51 -04:00
api-v0-methods-worker.md	Merge remote-tracking branch 'origin/master' into feat/post-worker	2022-03-09 16:27:03 +01:00
api-v0-methods.md	Merge branch 'feat/net-ping' of github.com:ychiaoli18/lotus into feat/net-ping	2022-03-21 13:06:11 +01:00
api-v1-unstable-methods.md	feat: cli: lotus client list-asks --protocols	2022-04-11 19:49:52 +02:00
block-validation.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00
cli-lotus-miner.md	v1.15.2-rc1	2022-04-13 19:11:02 +02:00
cli-lotus-worker.md	v1.15.2-rc1	2022-04-13 19:11:02 +02:00
cli-lotus.md	v1.15.2-rc1	2022-04-13 19:11:02 +02:00
create-miner.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00
default-lotus-config.toml	feat: config: Persistent subsystem log level config	2022-03-10 14:44:56 +01:00
default-lotus-miner-config.toml	Infer index provider topic from network name by default	2022-04-22 02:46:05 +02:00
dev-tools-pond-ui.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00
jaeger-tracing.md	update jaeger documentation	2021-05-25 23:53:08 -07:00
README.md	Add README to documentation/en with explanations	2020-09-29 14:45:55 +02:00
sealing-procs.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00
WIP-arch-complementary-notes.md	Move unclassified docs back to the docs root	2020-09-21 19:05:49 +02:00

README.md

Lotus documentation

This folder contains some Lotus documentation mostly intended for Lotus developers.

User documentation (including documentation for miners) has been moved to specific Lotus sections in https://docs.filecoin.io:

The Lotu.sh site

The https://lotu.sh and https://docs.lotu.sh sites are generated from this folder based on the index provided by .library.json. This is done at the lotus-docs repository, which contains Lotus as a git submodule.

To update the site, the lotus-docs repository should be updated with the desired version for the lotus git submodule. Once pushed to master, it will be auto-deployed.