Skip to content

Remarks on the tutorial "Run a new lister"

I'm trying to follow the tutorial "Run a new lister" (https://docs.softwareheritage.org/devel/swh-lister/run_a_new_lister.html) and i'm encountering some issues.

In the para 1., i have to "edit" the file docker-compose-override.yml but i was not able to find this file. I think I have to create it in the swh-docker-dev repository. Then, it seems to me the first code block is not correct: is the identation of swh-listers correct?

In the para 2., it's not easy to follow instructions of the README of swh-lister:

  • from where comes the tool createdb?
  • how can i deploy a postgres database?
  • how to get the python module swh.lister.cli?

I think I have to use swh-environment and/or swh-docker-dev repositories, but it's not clear to me!

Actually, it would be really nice have this kind of tutorial on a hello-world example, with all required steps explained on the same page. Of course, i understand this is time consuming and boring to do ;) But, i would be happy to help you improving such kind of tutorial by being a beta tester!


Migrated from T1979 (view on Phabricator)

Edited by Phabricator Migration user
To upload designs, you'll need to enable LFS and have an admin enable hashed storage. More information