README

   1 This is the release version of Samba, the free SMB and CIFS client and
   2 server and Domain Controller for UNIX and other operating
   3 systems. Samba is maintained by the Samba Team, who support the
   4 original author, Andrew Tridgell.
   5
   6 >>>> Please read THE WHOLE of this file as it gives important information
   7 >>>> about the configuration and use of Samba.
   8
   9 NOTE: Installation instructions may be found
  10       for the file/print server and domain member in:
  11       docs/htmldocs/Samba3-HOWTO/install.html
  12
  13       For the AD DC implementation a full HOWTO is provided at:
  14       https://wiki.samba.org/index.php/Samba4/HOWTO
  15
  16 This software is freely distributable under the GNU public license, a
  17 copy of which you should have received with this software (in a file
  18 called COPYING).
  19
  20
  21 WHAT IS SMB/CIFS?
  22 =================
  23
  24 This is a big question.
  25
  26 The very short answer is that it is the protocol by which a lot of
  27 PC-related machines share files and printers and other information
  28 such as lists of available files and printers. Operating systems that
  29 support this natively include Windows 9x, Windows NT (and derivatives),
  30 OS/2, Mac OS X and Linux.  Add on packages that achieve the same
  31 thing are available for DOS, Windows 3.1, VMS, Unix of all kinds,
  32 MVS, and more.  Some Web Browsers can speak this protocol as well
  33 (smb://).  Alternatives to SMB include Netware, NFS, Appletalk,
  34 Banyan Vines, Decnet etc; many of these have advantages but none are
  35 both public specifications and widely implemented in desktop machines
  36 by default.
  37
  38 The Common Internet File system (CIFS) is what the new SMB initiative
  39 is called. For details watch https://www.samba.org/cifs/.
  40
  41
  42 WHY DO PEOPLE WANT TO USE SMB?
  43 ==============================
  44
  45 1. Many people want to integrate their Microsoft desktop clients
  46    with their Unix servers.
  47
  48 2. Others want to integrate their Microsoft (etc) servers with Unix
  49    servers. This is a different problem to integrating desktop
  50    clients.
  51
  52 3. Others want to replace protocols like NFS, DecNet and Novell NCP,
  53    especially when used with PCs.
  54
  55
  56 WHAT CAN SAMBA DO?
  57 ==================
  58
  59 Please refer to the WHATSNEW.txt included with this README for
  60 a list of features in the latest Samba release.
  61
  62 Here is a very short list of what samba includes, and what it does.
  63 For many networks this can be simply summarized by "Samba provides
  64 a complete replacement for Windows NT, Warp, NFS or Netware servers."
  65
  66 - a SMB server, to provide Windows NT and LAN Manager-style file and print
  67   services to SMB clients such as Windows 95, Warp Server, smbfs and others.
  68
  69 - a Windows Domain Controller (NT4 and AD) replacement.
  70
  71 - a file/print server that can act as a member of a Windows NT 4.0
  72   or Active Directory domain.
  73
  74 - a NetBIOS (rfc1001/1002) nameserver, which amongst other things gives
  75   browsing support. Samba can be the master browser on your LAN if you wish.
  76
  77 - a ftp-like SMB client so you can access PC resources (disks and
  78   printers) from UNIX, Netware, and other operating systems
  79
  80 - a tar extension to the client for backing up PCs
  81
  82 - limited command-line tool that supports some of the NT administrative
  83   functionality, which can be used on Samba, NT workstation and NT server.
  84
  85 For a much better overview have a look at the web site at
  86 https://www.samba.org/samba/, and browse the user survey.
  87
  88 Related packages include:
  89
  90 - cifsvfs, an advanced Linux-only filesystem allowing you to mount
  91   remote SMB filesystems from PCs on your Linux box. This is included
  92   as standard with Linux 2.5 and later.
  93
  94 - smbfs, the previous Linux-only filesystem allowing you to mount remote SMB
  95   filesystems from PCs on your Linux box. This is included as standard with
  96   Linux 2.0 and later.
  97
  98
  99
 100 CONTRIBUTIONS
 101 =============
 102
 103 1. To contribute via GitHub
 104   - fork the official Samba team repository on GitHub
 105       * see https://github.com/samba-team/samba
 106   - become familiar with the coding standards as described in README.Coding
 107   - make sure you read the Samba copyright policy
 108       * see https://www.samba.org/samba/devel/copyright-policy.html
 109   - create a feature branch
 110   - make changes
 111   - when committing, be sure to add signed-off-by tags
 112       * see https://wiki.samba.org/index.php/CodeReview#commit_message_tags
 113   - send a pull request for your branch through GitHub
 114   - this will trigger an email to the samba-technical mailing list
 115   - discussion happens on the samba-technical mailing list as described below
 116   - more info on using Git for Samba development can be found on the Samba Wiki
 117       * see https://wiki.samba.org/index.php/Using_Git_for_Samba_Development
 118
 119 2. If you want to contribute to the development of the software then
 120 please join the mailing list. The Samba team accepts patches
 121 (preferably in "diff -u" format, see https://www.samba.org/samba/devel/
 122 for more details) and are always glad to receive feedback or
 123 suggestions to the address samba@lists.samba.org.  More information
 124 on the various Samba mailing lists can be found at https://lists.samba.org/.
 125
 126 You can also get the Samba sourcecode straight from the git repository - see
 127 https://wiki.samba.org/index.php/Using_Git_for_Samba_Development.
 128
 129 If you like a particular feature then look through the git change-log
 130 (on the web at https://gitweb.samba.org/?p=samba.git;a=summary) and see
 131 who added it, then send them an email.
 132
 133 Remember that free software of this kind lives or dies by the response
 134 we get. If no one tells us they like it then we'll probably move onto
 135 something else.
 136
 137 MORE INFO
 138 =========
 139
 140 DOCUMENTATION
 141 -------------
 142
 143 There is quite a bit of documentation included with the package,
 144 including man pages, and lots of .html files with hints and useful
 145 info. This is also available from the web page. There is a growing
 146 collection of information under docs/.
 147
 148 A list of Samba documentation in languages other than English is
 149 available on the web page.
 150
 151 If you would like to help with the documentation, please coordinate
 152 on the samba@samba.org mailing list.  See the next section for details
 153 on subscribing to samba mailing lists.
 154
 155
 156 MAILING LIST
 157 ------------
 158
 159 Please do NOT send subscription/unsubscription requests to the lists!
 160
 161 There is a mailing list for discussion of Samba.  For details go to
 162 <https://lists.samba.org/> or send mail to <samba-subscribe@lists.samba.org>
 163
 164 There is also an announcement mailing list where new versions are
 165 announced.  To subscribe go to <https://lists.samba.org/> or send mail
 166 to <samba-announce-subscribe@lists.samba.org>.  All announcements also
 167 go to the samba list, so you only need to be on one.
 168
 169 For details of other Samba mailing lists and for access to archives, see
 170 <https://lists.samba.org/>
 171
 172
 173 MAILING LIST ETIQUETTE
 174 ----------------------
 175
 176 A few tips when submitting to this or any mailing list.
 177
 178 1. Make your subject short and descriptive. Avoid the words "help" or
 179    "Samba" in the subject. The readers of this list already know that
 180    a) you need help, and b) you are writing about samba (of course,
 181    you may need to distinguish between Samba PDC and other file
 182    sharing software). Avoid phrases such as "what is" and "how do
 183    i". Some good subject lines might look like "Slow response with
 184    Excel files" or "Migrating from Samba PDC to NT PDC".
 185
 186 2. If you include the original message in your reply, trim it so that
 187    only the relevant lines, enough to establish context, are
 188    included. Chances are (since this is a mailing list) we've already
 189    read the original message.
 190
 191 3. Trim irrelevant headers from the original message in your
 192    reply. All we need to see is a) From, b) Date, and c) Subject. We
 193    don't even really need the Subject, if you haven't changed
 194    it. Better yet is to just preface the original message with "On
 195    [date] [someone] wrote:".
 196
 197 4. Please don't reply to or argue about spam, spam filters or viruses
 198    on any Samba lists. We do have a spam filtering system that is
 199    working quite well thank you very much but occasionally unwanted
 200    messages slip through. Deal with it.
 201
 202 5. Never say "Me too." It doesn't help anyone solve the
 203    problem. Instead, if you ARE having the same problem, give more
 204    information. Have you seen something that the other writer hasn't
 205    mentioned, which may be helpful?
 206
 207 6. If you ask about a problem, then come up with the solution on your
 208    own or through another source, by all means post it. Someone else
 209    may have the same problem and is waiting for an answer, but never
 210    hears of it.
 211
 212 7. Give as much *relevant* information as possible such as Samba
 213    release number, OS, kernel version, etc...
 214
 215 8. RTFM. Google. groups.google.com.
 216
 217
 218 WEB SITE
 219 --------
 220
 221 A Samba WWW site has been setup with lots of useful info. Connect to:
 222
 223 https://www.samba.org/
 224
 225 As well as general information and documentation, this also has searchable
 226 archives of the mailing list and a user survey that shows who else is using
 227 this package.
 228