ipfs / fs-repo-migrations

Migrations for the filesystem repository of ipfs clients
MIT License
57 stars 42 forks source link

run.md unclear communication for container users. #187

Open kiriakos opened 10 months ago

kiriakos commented 10 months ago

When running the official kubo container, if you have configuration scripts in /container-init.d executing ipfs config and similar, the container will fall on its face if a migration is needed. The output then is:

Error: ipfs repo needs migration, please run migration tool. See https://github.com/ipfs/fs-repo-migrations/blob/master/run.md Sorry for the inconvenience. In the future, these will run automatically.

Going to run.md you find the mention:

Note that running migrations is a task automatically performed by the ipfs when.... so you would normally not need to run the fs-repo-migrations tool.

Even though this is word by word correct it doesn't address the fact that a containerized setup most probably will have some sort of "declarative" configuration happening in /container-init.d/ scripts before the ipfs daemon command is run. So in this case you actually have to force the manual update before doing config, making it less of an edge case as it is being made out to be.

Can we address this somehow in the documentation?