gravitl / netmaker

Netmaker makes networks with WireGuard. Netmaker automates fast, secure, and distributed virtual networks.
https://netmaker.io
Other
9.5k stars 552 forks source link

[Bug]: Out-of-date client documentation #962

Closed domeniqo closed 2 years ago

domeniqo commented 2 years ago

Contact Details

dominik.mlynka@gmail.com

What happened?

MINOR ISSUE WITH DOCUMENTATION

There is an inconsistency between documentation for CLI reference of netclient program and actual implementation. https://docs.netmaker.org/client-installation.html#cli-reference

It's quite confusing to update configuration of the netclient using this documentation, because either filepaths does not fit (/etc/netconfig- does not exist), nor netclient commands are implemented as presented (netclient checkin, netclient push does not exist in v0.11.1 or v0.12.0 for both Windows and Linux platforms).

Actual netclient commands: image

Later in the text is also mentioned how to make the changes what seems to be valid for the current versions (https://docs.netmaker.org/client-installation.html#making-updates), but I couldn't make it work anyway, because I cannot find any reference or settings for checkin interval and it does not update settings automatically according to the updated configuration files at /etc/netclient/config/netconfig-.

Version

v0.11.1

What OS are you using?

Linux, Windows

Relevant log output

No response

Contributing guidelines

afeiszli commented 2 years ago

@domeniqo please open this issue on the netmaker-docs repo (moved as of last release): https://github.com/gravitl/netmaker-docs

domeniqo commented 2 years ago

Thanks, done (https://github.com/gravitl/netmaker-docs/issues/3)