Re: [PATCH v2] ksmbd: update documentation

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

 



On 9/5/2022 9:58 PM, Namjae Jeon wrote:
configuration.txt in ksmbd-tools moved to ksmb.conf manpage.
update it and more detailed ksmbd-tools build method.

Signed-off-by: Namjae Jeon <linkinjeon@xxxxxxxxxx>
---
  v2:
    - rename smb.conf to ksmbd.conf.
    - add how to set ksmbd module in menuconfig
    - remove --syscondir option for configure, instead change ksmbd
      directory to /usr/local/etc/ksmbd.
    - change the prompt to '$'.

  Documentation/filesystems/cifs/ksmbd.rst | 32 ++++++++++++++++--------
  1 file changed, 22 insertions(+), 10 deletions(-)

diff --git a/Documentation/filesystems/cifs/ksmbd.rst b/Documentation/filesystems/cifs/ksmbd.rst
index 1af600db2e70..69d4a4c3313b 100644
--- a/Documentation/filesystems/cifs/ksmbd.rst
+++ b/Documentation/filesystems/cifs/ksmbd.rst
@@ -118,24 +118,36 @@ ksmbd/nfsd interoperability    Planned for future. The features that ksmbd
  How to run
  ==========
-1. Download ksmbd-tools and compile them.
-	- https://github.com/cifsd-team/ksmbd-tools
+1. Download ksmbd-tools(https://github.com/cifsd-team/ksmbd-tools/releases) and compile them.
+   - Refer README(https://github.com/cifsd-team/ksmbd-tools/blob/master/README.md)
+     to know how to use ksmbd.<foo> utils

I suggest typing out "<foo>" to include mountd, adduser and addshare.

+
+     $ ./autogen.sh
+     $ ./configure --with-rundir=/run
+     $ make && sudo make install
2. Create user/password for SMB share.
+   - See ksmbd.adduser manpage.
+
+     $ man ksmbd.adduser
+     $ sudo ksmbd.adduser -a <Enter USERNAME for SMB share access>
- # mkdir /etc/ksmbd/
-	# ksmbd.adduser -a <Enter USERNAME for SMB share access>
+3. Create /usr/local/etc/ksmbd/ksmbd.conf file, add SMB share in smb.conf file.

Typo - "ksmbd.conf" -------------------------------------------------^

Wouldn't the ksmbd.addshare command be a safer way to do this?

+   - Refer ksmbd.conf.example in ksmbd-utils, See ksmbd.conf manpage
+     for details to configure shares.

This way is fine too, but as an alternative for power users.

-3. Create /etc/ksmbd/smb.conf file, add SMB share in smb.conf file
-	- Refer smb.conf.example and
-          https://github.com/cifsd-team/ksmbd-tools/blob/master/Documentation/configuration.txt
+        $ man ksmbd.conf
-4. Insert ksmbd.ko module
+4. Insert ksmbd.ko module after build your kernel.

Can't ksmbd be built-in as well?

+   - Set ksmbd in menuconfig(e.g. $ make menuconfig)
+       [*] Network File Systems  --->
+           <M> SMB server support
- # insmod ksmbd.ko
+	$ sudo insmod ksmbd.ko
5. Start ksmbd user space daemon
-	# ksmbd.mountd
+
+	$ sudo ksmbd.mountd
6. Access share from Windows or Linux using CIFS

"SMB2 or SMB3" ----------------------------------^

Tom.



[Linux USB Devel]     [Video for Linux]     [Linux Audio Users]     [Yosemite News]     [Linux Kernel]     [Linux SCSI]

  Powered by Linux