Documentation on replication tasks too easily misunderstood
In the FreeNAS User Guide section Troubleshooting Replication (as at http://doc.freenas.org/9.10/freenas_storage.html#troubleshooting-replication ), the first paragraph gives an ssh command to try manually to test if authentication using the replication key works.
It doesn't, however, explicitly say what user to run that command as.
It does say "open Shell"; in this manual that has to mean "open the Shell window in the GUI", and if you do that you're running as root, and if you're running as root I think the ssh command given is a valid test, BUT..."open Shell" is very very close to "open the shell", and the second is a phrase used utterly routinely giving debugging instructions to people working on servers. Note I do NOT say the existing doc is wrong -- just that it's too easy for people to misread it.
I suggest changing the second sentence of the first paragraph to:
On Push, open the Shell window in the GUI and try to ssh into PULL.
You could use yet more words to offer the alternative of an ssh connection and running as root, but people who think at that level will mostly see the implications of the GUI Shell window mostly.
(I misread it myself last time I tried to get replication working, and eventually gave up; and just now figured it out on my next attempt, after getting it wrong a few times.)
#2 Updated by Dru Lavigne over 5 years ago
- Status changed from Screened to Resolved