Re: [PATCH v3] ksmbd: update documentation

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

 



2022-09-14 4:02 GMT+09:00, Tom Talpey <tom@xxxxxxxxxx>:
> On 9/12/2022 4:54 PM, Namjae Jeon wrote:
>> 2022-09-13 8:38 GMT+09:00, Tom Talpey <tom@xxxxxxxxxx>:
>>> On 9/9/2022 5:25 AM, Namjae Jeon wrote:
>>>> configuration.txt in ksmbd-tools moved to ksmbd.conf manpage.
>>>> update it and more detailed ksmbd-tools build method.
>>>>
>>>> Reviewed-by: Sergey Senozhatsky <senozhatsky@xxxxxxxxxxxx>
>>>> Signed-off-by: Namjae Jeon <linkinjeon@xxxxxxxxxx>
>>>> ---
>>>>    v3:
>>>>      - replace CIFS with SMB3 clients.
>>>>      - update ksmbd built-in case.
>>>>      - replace smb.conf leftover with ksmbd.conf.
>>>>      - use full name of utils in ksmbd-tools instead of <foo>.
>>>>      - fix the warnings from make htlmdocs build reported by kernel
>>>> test
>>>>        robot.
>>>>    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 | 40
>>>> +++++++++++++++++-------
>>>>    1 file changed, 29 insertions(+), 11 deletions(-)
>>>>
>>>> diff --git a/Documentation/filesystems/cifs/ksmbd.rst
>>>> b/Documentation/filesystems/cifs/ksmbd.rst
>>>> index 1af600db2e70..4284341c89f3 100644
>>>> --- a/Documentation/filesystems/cifs/ksmbd.rst
>>>> +++ b/Documentation/filesystems/cifs/ksmbd.rst
>>>> @@ -118,26 +118,44 @@ 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.mountd/adduser/addshare/control utils
>>>> +
>>>> +     $ ./autogen.sh
>>>> +     $ ./configure --with-rundir=/run
>>>> +     $ make && sudo make install
>>>>
>>>>    2. Create user/password for SMB share.
>>>>
>>>> -	# mkdir /etc/ksmbd/
>>>> -	# ksmbd.adduser -a <Enter USERNAME for SMB share access>
>>>> +   - See ksmbd.adduser manpage.
>>>> +
>>>> +     $ man ksmbd.adduser
>>>> +     $ sudo ksmbd.adduser -a <Enter USERNAME for SMB share access>
>>>> +
>>>> +3. Create /usr/local/etc/ksmbd/ksmbd.conf file, add SMB share in
>>>> ksmbd.conf file.
>>>
>>> I missed this in the v2 match - are you intentionally moving the
>>> ksmbd.conf file to /usr/local/etc? That seems a very mysterious
>>> location. Nothing on my vanilla installed system places anything
>>> in there.
>> To avoid conflicts with the existing distribution package, the default
>> location as far as I know is /usr/local/etc. And it can be changed
>> with --sysconfdir. It is same with samba.
>
> I totally disagree with this. The kernel server is part of, well,
> the kernel, and loading the kernel should not depend on a path like
> /usr/local/etc.
You should consider ksmbd-tools included ksmbd.mountd also.
To start running ksmbd server, ksmbd.mountd should be launched.
> Also, nothing I know, including Samba, is deployed
> with such a directory in my experience. I find smb.conf in /etc/samba.
If you build samba by default, it is installed into /usr/local.
/etc/samba/ location you are saying is installed by package manager.

>
> Where are the ksmbd.<foo> helpers installed by default? /usr/local/sbin?
> On my standard Ubuntu install (and presumably Debian?) they are in
> /sbin.
I think that you are confusing binary of ksmbd-tools which installed
by package manager.
make & make install in ksmbd-tools directory and can see them in
/usr/local/sbin/ .

>
> Tom.
>
>>> Also, doesn't this file need to exist before step 2??
>> Ah, Yes. Will switch them.
>>
>> Thanks for your review!
>>>
>>> Tom.
>>>
>>>
>>>> -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
>>>> +   - Refer ksmbd.conf.example in ksmbd-utils, See ksmbd.conf manpage
>>>> +     for details to configure shares.
>>>>
>>>> -4. Insert ksmbd.ko module
>>>> +        $ man ksmbd.conf
>>>>
>>>> -	# insmod ksmbd.ko
>>>> +4. Insert ksmbd.ko module after build your kernel. No need to load
>>>> module
>>>> +   if ksmbd is built into the kernel.
>>>> +
>>>> +   - Set ksmbd in menuconfig(e.g. $ make menuconfig)
>>>> +       [*] Network File Systems  --->
>>>> +           <M> SMB3 server support (EXPERIMENTAL)
>>>> +
>>>> +	$ sudo modprobe ksmbd.ko
>>>>
>>>>    5. Start ksmbd user space daemon
>>>> -	# ksmbd.mountd
>>>>
>>>> -6. Access share from Windows or Linux using CIFS
>>>> +	$ sudo ksmbd.mountd
>>>> +
>>>> +6. Access share from Windows or Linux SMB3 clients (cifs.ko or
>>>> smbclient
>>>> of samba)
>>>>
>>>>    Shutdown KSMBD
>>>>    ==============
>>>
>>
>



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

  Powered by Linux