X-Git-Url: https://gerrit.fd.io/r/gitweb?a=blobdiff_plain;f=adapter%2Fsocketclient%2Fdoc.go;h=cbb00a21bd83be88a567f685a35f8a1ff4e4b293;hb=280b1c6c83b676ef4e592f4ecf60cb5b54b6a753;hp=0f93c56a583d549250d45ca7adc0df3e9e67f315;hpb=f049390060630c0085fe4ad683c83a4a14a47ffb;p=govpp.git diff --git a/adapter/socketclient/doc.go b/adapter/socketclient/doc.go index 0f93c56..cbb00a2 100644 --- a/adapter/socketclient/doc.go +++ b/adapter/socketclient/doc.go @@ -21,13 +21,18 @@ // // Requirements // -// The socketclient will connect to /run/vpp-api.sock by default. However this -// is not enabled in VPP configuration by default. +// The socketclient connects to unix domain socket defined in VPP configuration. // -// To enable the socket in VPP, add following section to VPP config. +// It is enabled by default at /run/vpp/api.sock by the following config section: // // socksvr { -// default +// socket-name default +// } +// +// If you want to use custom socket path: +// +// socksvr { +// socket-name /run/vpp/api.sock // } // package socketclient