Open
Description
Hi, I would like to add some suggestions to improve the documentation based on some shortcomings I have seen (also from reports from other users) and some needs I have had (which I couldn't find an answer to in the documentation)
- add to idp doc use of new NETBIRD_MGMT_IDP_SIGNKEY_REFRESH added after I had the issue with google idp and I also saw many users had same problem with differents idp
- extend the doc on how relay connections works, see question about multiple coturn servers in selfhosted netbird#1286 (comment)
- specify what might hinder P2P connections. for example based on what I know I wrote a list here. It might also be useful to add any advice on debugging and possible resolution.
- specify on selfhosted server if is possibile and how migrate to another server maintaining the data. It seems possible but I haven't tried it yet. specify that change idp is not possible as don't store/link the users email but the id; they told me that it should be possible by manually changing the id of all users in the store.json, I will have to do it but I haven't done it yet (to confirm if is working)
- add codespell workflow also in this repository: Add codespell job netbird#1281
- specify that is possibile to manually set multiple coturn servers, already supported in management.json
- mention https://webrtc.github.io/samples/src/content/peerconnection/trickle-ice/ for test coturn server and connection to it (from clients) if needed
- additional debug log for try to debug disconnect issue:
on linux:sudo bash -c "NB_LOG_LEVEL=debug PION_LOG_TRACE=all netbird service run" | tee disconnect.logs
on windows, working ICE debug method on Windows, thanks to @mlsmaycon :- download psexec: https://learn.microsoft.com/en-us/sysinternals/downloads/psexec
- add PION_LOG_TRACE=all as system environment variables
- stop netbird:
netbird service stop
- run the following in a privileged PowerShell session:
.\PsExec64.exe -s cmd.exe /c "netbird service run --log-level debug --log-file console > c:\windows\temp\netbird.out.log 2>&1"
- So the netbird.out.log will contain netbird debug log and ICE trace logs
When I think of anything else I will add to the list.
I am not good enough at English and at explaining to do it myself, in some cases I may not even have the necessary knowledge to create good documentation, so I added this suggestion list.
Metadata
Metadata
Assignees
Labels
No labels