[PATCH v2] ksmbd-tools: update README

* [PATCH v2] ksmbd-tools: update README
@ 2021-10-14 15:08 Enzo Matsumiya
  2021-10-15  2:09 ` Namjae Jeon
  0 siblings, 1 reply; 2+ messages in thread
From: Enzo Matsumiya @ 2021-10-14 15:08 UTC (permalink / raw)
  To: linux-cifs; +Cc: linkinjeon

Prettify README with markdown and fix some typos/commands.

Signed-off-by: Enzo Matsumiya <ematsumiya@suse.de>
---
 README    | 98 -------------------------------------------------------
 README.md | 88 +++++++++++++++++++++++++++++++++++++++++++++++++
 2 files changed, 88 insertions(+), 98 deletions(-)
 delete mode 100644 README
 create mode 100644 README.md

diff --git a/README b/README
deleted file mode 100644
index 3dce3bb41c6e..000000000000
--- a/README
+++ /dev/null
@@ -1,98 +0,0 @@
-________________________
-BUILDING KSMBD TOOLS
-________________________
-
-Install preprequisite packages:
-	For Ubuntu:
-	sudo apt-get install autoconf libtool pkg-config libnl-3-dev \
-	libnl-genl-3-dev libglib2.0-dev
-
-	For Fedora, RHEL:
-	sudo yum install autoconf automake libtool glib2-devel libnl3-devel
-
-	For CentOS:
-	sudo yum install glib2-devel libnl3-devel
-
-Build steps:
-        - cd into the ksmbd-tools directory
-        - ./autogen.sh
-        - ./configure
-        - make
-        - make install
-
-_____________________
-USING KSMBD TOOLS
-_____________________
-
-Setup steps:
-	- install smbd kernel driver
-		modprobe ksmbd
-	- create user/password for SMB share
-		mkdir /etc/ksmbd/
-		ksmbd.adduser -a <Enter USERNAME for SMB share access>
-		Enter password for SMB share access
-	- create /etc/ksmbd/smb.conf file, add SMB share in smb.conf file
-		Refer smb.conf.example
-	- start smbd user space daemon
-		ksmbd.mountd
-	- access share from Windows or Linux using CIFS
-
-_____________________
-RESTART KSMBD
-_____________________
-
-steps:
-	- kill user and kernel space daemon
-		sudo ksmbd.control -s
-	- restart user space daemon
-		ksmbd.mountd
-
-_____________________
-Shutdown KSMBD
-_____________________
-
-steps:
-	- kill user and kernel space daemon
-		sudo ksmbd.control -s
-	- unload ksmbd module
-		rmmod ksmbd
-
-
-_____________________
-Enable debug prints
-_____________________
-
-steps:
-	- Enable all component prints
-		sudo ksmbd.control -d "all"
-	- Enable one of components(smb, auth, vfs, oplock, ipc, conn, rdma)
-		sudo ksmbd.control -d "smb"
-	- Disable prints:
-		If you try the selected component once more, It is disabled without brackets.
-
-
---------------------
-ADMIN TOOLS
---------------------
-
-- ksmbd.adduser
-	Adds, updates or removes (-a/-u/-d) a user from ksmbd pwd file.
-
-- ksmbd.addshare
-	Adds, updates or removes (-a/-u/-d) a net share from smb.conf file.
-
-Usage example:
-
-Creating a new share:
-
-ksmbd.addshare -a files -o "\
-		     path=/home/users/files \
-		     comment=exported files \
-		     writeable=yes \
-		     read only = no \
-		     "
-
-Note that share options (-o) must always be enquoted ("...").
-
-ksmbd.addshare tool does not modify [global] smb.conf section; only net
-share configs are supported at the moment.
diff --git a/README.md b/README.md
new file mode 100644
index 000000000000..7156c2e20dee
--- /dev/null
+++ b/README.md
@@ -0,0 +1,88 @@
+# ksmbd-tools
+
+### Building
+
+##### Install prerequisite packages:
+
+- For Ubuntu:
+  - `sudo apt-get install autoconf libtool pkg-config libnl-3-dev libnl-genl-3-dev libglib2.0-dev`
+
+- For Fedora, RHEL:
+  - `sudo yum install autoconf automake libtool glib2-devel libnl3-devel`
+
+- For CentOS:
+  - `sudo yum install glib2-devel libnl3-devel`
+
+- For openSUSE:
+  - `sudo zypper install glib2-devel libnl3-devel`
+
+##### Building:
+
+- clone this repository
+- `cd ksmbd-tools`
+- `./autogen.sh`
+- `./configure`
+- `make`
+- `make install`
+
+
+### Usage
+
+All administration tasks must be done as root.
+
+##### Setup:
+
+- Install ksmbd kernel driver
+	- `modprobe ksmbd`
+- Create user/password for SMB share
+	- `mkdir /etc/ksmbd`
+	- `ksmbd.adduser -a <username>`
+	- Enter password for SMB share access
+- Create `/etc/ksmbd/smb.conf` file
+	- Refer `smb.conf.example`
+- Add share to `smb.conf`
+	- This can be done manually or with `ksmbd.addshare`, e.g.:
+	- `ksmbd.addshare -a myshare -o "guest ok = yes, writable = yes, path = /mnt/data"`
+
+	- Note: share options (-o) must always be enclosed with double quotes ("...").
+- Start ksmbd user space daemon
+	- `ksmbd.mountd`
+- Access share from Windows or Linux using CIFS
+
+
+##### Stopping and restarting the daemon:
+
+First, kill user and kernel space daemon
+  - `ksmbd.control -s`
+
+Then, to restart the daemon, run:
+  - `ksmbd.mountd`
+
+Or to shut it down completely:
+  - `rmmod ksmbd`
+
+
+### Debugging
+
+- Enable all component prints
+  - `ksmbd.control -d "all"`
+- Enable a single component (see below)
+  - `ksmbd.control -d "smb"`
+- Run the command with the same component name again to disable it
+
+Currently available debug components:
+smb, auth, vfs, oplock, ipc, conn, rdma
+
+
+### More...
+
+- ksmbd.adduser
+  - Adds (-a), updates (-u), or deletes (-d) a user from user database.
+  - Default database file is `/etc/ksmbd/users.db`
+
+- ksmbd.addshare
+  - Adds (-a), updates (-u), or deletes (-d) a net share from config file.
+  - Default config file is `/etc/ksmbd/smb.conf`
+
+`ksmbd.addshare` does not modify `[global]` section in config file; only net
+share configs are supported at the moment.
-- 
2.33.0


^ permalink raw reply related	[flat|nested] 2+ messages in thread