Docs on upgrading from v0.15 to v0.16

Questions
1

Your question

I successfully upgraded from v0.15 to v0.16, thanks for the thorough guide.
I’d suggest some improvements to the guide though:

  1. mention the need for stalwart-cli beforehand. I had to go downloading and setting it up while under time pressure - easy situation to avoid;
  2. bash scripts should be easily copy-pastable(GH conveniently even provides button), which prepending "$ " in the beginning of each of the commands nullifies.
  3. Docker command for starting the recovery could use --rm - it’s ephemeral and will then be cleaned up automatically.

I was going to create a PR off of my branch but saw your Contributing Guidelines only allowing vouched devs. I’ve had other suggestions while setting up and using 0.16 and I’d happily rather make PRs with suggestions (even if they are not accepted) than report smaller ones.

I understand that topics in this category are triaged by a bot first but a human reply will follow up. If I’d prefer a human-only reply, I’ll add the no-ai tag to my topic.

on

2

Hi @rauno56 ! Seems I’m not the only one who would like to see the docs improved.

In fact, stalwart-cli can be run from docker, if that’s an option for you ( Upgrading docs (v0_16.md) for docker deployment when no stalwart-cli available ), but the official guide doesn’t mention it.

3

I guessed that there might be a docker image with the CLI somewhere, but it was easier for me to run it locally. Thanks for the hint!

4

All three make sense. The CLI belongs in a prerequisites list before the downtime window starts, and @voffch’s thread covers getting it on Docker. The prompts do break copy and paste, and with --rm on the recovery container, step 6 shrinks to a plain docker stop.

5

Next steps?

I wrongly assumed I was now a approved developer: Upgrade docs - Pull Request #3328 - stalwartlabs/stalwart - GitHub