search

shamirlabs / diva-alpha-net

Diva alpha testnet
https://docs.shamirlabs.org/diva/testnet/intro
19 stars 17 forks source link

More guidance for env variables #38

Closed yorickdowne closed 1 year ago

yorickdowne commented 1 year ago

The dev-ports you just merged, on further thought, will break things for people who use -with-clients and the host IP, instead of names.

They'd need to add dev-ports-with-clients.yml to their COMPOSE_FILE or they can adjust so they use docker networking, which is arguably cleaner.

This PR gives more guidance inside .env.example as to how these variables work

pradavc commented 1 year ago

Yeah, that is why I mentioned in the previous PR that it was a change incompatible with previous versions. Still, one that is acceptable given that the testnet has been live only for a week and that it brings more benefits than issues.

Besides, take a look at the just uploaded scripts @yorickdowne . I think with those, we couldn't automatically inject the dev-ports file in the .env, without creating too many issues for the users. It would mean updating the "update-diva.sh" scripts, so when the users click on "Update Diva" it should update the .env automatically. We can also add more details in the docs about it for those that want to dig deeper and improve the tooling.

So my suggestion would be: more guidance is good, but improving the scripts to take into account this change would be even better because it means users with "with-clients" won't even have to bother about changing their config manually.