e0e4cd
Samba is a free SMB and CIFS client and server and Domain Controller for UNIX
e0e4cd
and other operating systems. It is maintained by the Samba Team, who support the
e0e4cd
original author, Andrew Tridgell.
e0e4cd
e0e4cd
This software is freely distributable under the GNU public license, a copy of
e0e4cd
which you should have received with this software (in a file called COPYING).
e0e4cd
e0e4cd
# WHAT IS SMB/CIFS?
e0e4cd
This is a big question.
e0e4cd
e0e4cd
The very short answer is that it is the protocol by which a lot of PC-related
e0e4cd
machines share files and printers and other information such as lists of
e0e4cd
available files and printers. Operating systems that support this natively
e0e4cd
include Windows 9x, Windows NT (and derivatives), OS/2, Mac OS X and Linux. Add
e0e4cd
on packages that achieve the same thing are available for DOS, Windows 3.1, VMS,
e0e4cd
Unix of all kinds, MVS, and more.  Some Web Browsers can speak this protocol as
e0e4cd
well (smb://).  Alternatives to SMB include Netware, NFS, Appletalk, Banyan
e0e4cd
Vines, Decnet etc; many of these have advantages but none are both public
e0e4cd
specifications and widely implemented in desktop machines by default.
e0e4cd
e0e4cd
The Common Internet File system (CIFS) is what the new SMB initiative is called.
e0e4cd
For details watch [here](https://samba.org/cifs)
e0e4cd
e0e4cd
# WHY DO PEOPLE WANT TO USE SMB?
e0e4cd
* Many people want to integrate their Microsoft desktop clients with their Unix
e0e4cd
servers.
e0e4cd
e0e4cd
* Others want to integrate their Microsoft (etc) servers with Unix servers. This
e0e4cd
is a different problem to integrating desktop clients.
e0e4cd
e0e4cd
* Others want to replace protocols like NFS, DecNet and Novell NCP, especially
e0e4cd
when used with PCs.
e0e4cd
e0e4cd
# WHAT CAN SAMBA DO?
e0e4cd
Please refer to the WHATSNEW.txt included with this README for a list of
e0e4cd
features in the latest Samba release.
e0e4cd
e0e4cd
Here is a very short list of what samba includes, and what it does. For many
e0e4cd
networks this can be simply summarized by "Samba provides a complete replacement
e0e4cd
for Windows NT, Warp, NFS or Netware servers."
e0e4cd
* a SMB server, to provide Windows NT and LAN Manager-style file and print
e0e4cd
services to SMB clients such as Windows 95, Warp Server, smbfs and others.
e0e4cd
e0e4cd
* a Windows Domain Controller (NT4 and AD) replacement.
e0e4cd
e0e4cd
* a file/print server that can act as a member of a Windows NT 4.0 or Active
e0e4cd
Directory domain.
e0e4cd
e0e4cd
* a NetBIOS (rfc1001/1002) nameserver, which amongst other things gives browsing
e0e4cd
support. Samba can be the master browser on your LAN if you wish.
e0e4cd
e0e4cd
* a ftp-like SMB client so you can access PC resources (disks and printers) from
e0e4cd
UNIX, Netware, and other operating systems
e0e4cd
e0e4cd
* a tar extension to the client for backing up PCs
e0e4cd
e0e4cd
* limited command-line tool that supports some of the NT administrative
e0e4cd
functionality, which can be used on Samba, NT workstation and NT server.
e0e4cd
e0e4cd
For a much better overview have a look at the [web site](http://samba.org/samba)
e0e4cd
and browse the user survey.
e0e4cd
e0e4cd
#### Related packages include:
e0e4cd
* cifsvfs, an advanced Linux-only filesystem allowing you to mount remote SMB
e0e4cd
filesystems from PCs on your Linux box. This is included as standard with Linux
e0e4cd
2.5 and later.
e0e4cd
e0e4cd
* smbfs, the previous Linux-only filesystem allowing you to mount remote SMB
e0e4cd
filesystems from PCs on your Linux box. This is included as standard with Linux
e0e4cd
2.0 and later.
e0e4cd
e0e4cd
# CONTRIBUTIONS
e0e4cd
e0e4cd
### To contribute via GitHub
e0e4cd
  * fork the official Samba team repository on GitHub
e0e4cd
    -- see [GitHub](https://github.com/samba-team/samba)
e0e4cd
e0e4cd
  * become familiar with the coding standards as described in README.Coding
e0e4cd
e0e4cd
  * make sure you read the Samba copyright policy
e0e4cd
    -- see [Copyright Policy](https://www.samba.org/samba/devel/copyright-policy.html)
e0e4cd
e0e4cd
  * create a feature branch
e0e4cd
e0e4cd
  * make changes
e0e4cd
e0e4cd
  * when committing, be sure to add signed-off-by tags
e0e4cd
    -- see [Commit message tags](https://wiki.samba.org/index.php/CodeReview#commit_message_tags)
e0e4cd
e0e4cd
  * send a pull request for your branch through GitHub
e0e4cd
e0e4cd
  * this will trigger an email to the samba-technical mailing list
e0e4cd
e0e4cd
  * discussion happens on the samba-technical mailing list as described below
e0e4cd
e0e4cd
  * more info on using Git for Samba development can be found on Samba Wiki
e0e4cd
    -- see [Using Git for Samba](https://wiki.samba.org/index.php/Using_Git_for_Samba_Development)
e0e4cd
e0e4cd
### To contribute via mailing lists
e0e4cd
Join the mailing list. The Samba team accepts patches (preferably in "diff -u"
e0e4cd
format, see [here](https://samba.org/samba/devel) for more details) and are
e0e4cd
always glad to receive feedback or suggestions to the address
e0e4cd
samba@lists.samba.org. More information on the various Samba mailing lists can
e0e4cd
be found at [mailman](http://lists.samba.org).
e0e4cd
e0e4cd
You can also get the Samba sourcecode straight from the [git repository](http://wiki.samba.org/index.php/Using_Git_for_Samba_Development).
e0e4cd
e0e4cd
If you like a particular feature then look through the git change-log on the
e0e4cd
[web](https://git.samba.org/?p=samba.git;a=summary) and see who added it, then
e0e4cd
send them an email.
e0e4cd
e0e4cd
Remember that free software of this kind lives or dies by the response we get.
e0e4cd
If no one tells us they like it then we'll probably move onto something else.
e0e4cd
e0e4cd
e0e4cd
# MORE INFO
e0e4cd
e0e4cd
### DOCUMENTATION
e0e4cd
There is quite a bit of documentation included with the package, including man
e0e4cd
pages, and lots of .html files with hints and useful info. This is also
e0e4cd
available from the web page. There is a growing collection of information under
e0e4cd
docs/.
e0e4cd
e0e4cd
A list of Samba documentation in languages other than English is available on
e0e4cd
the web page.
e0e4cd
e0e4cd
If you would like to help with the documentation, please coordinate on the
e0e4cd
samba@lists.samba.org mailing list. See the next section for details on
e0e4cd
subscribing to samba mailing lists.
e0e4cd
e0e4cd
### MAILING LIST
e0e4cd
Please do NOT send subscription/unsubscription requests to the lists!
e0e4cd
e0e4cd
There is a mailing list for discussion of Samba.  For details go to [mailman](https://lists.samba.org)
e0e4cd
or send mail to <samba-subscribe@lists.samba.org>.
e0e4cd
e0e4cd
There is also an announcement mailing list where new versions are announced. To
e0e4cd
subscribe go to [mailman](http://lists.samba.org) or send mail to
e0e4cd
<samba-announce-subscribe@lists.samba.org>. All announcements also go to the
e0e4cd
samba list, so you only need to be on one.
e0e4cd
e0e4cd
For details of other Samba mailing lists and for access to archives, see
e0e4cd
[mailman](
e0e4cd
e0e4cd
### MAILING LIST ETIQUETTE
e0e4cd
e0e4cd
A few tips when submitting to this or any mailing list.
e0e4cd
 - Make your subject short and descriptive. Avoid the words "help" or "Samba" in
e0e4cd
the subject. The readers of this list already know that a) you need help, and b)
e0e4cd
you are writing about samba (of course, you may need to distinguish between
e0e4cd
Samba PDC and other file sharing software). Avoid phrases such as "what is" and
e0e4cd
"how do i". Some good subject lines might look like "Slow response with Excel
e0e4cd
files" or "Migrating from Samba PDC to NT PDC".
e0e4cd
e0e4cd
- If you include the original message in your reply, trim it so that only the
e0e4cd
relevant lines, enough to establish context, are included. Chances are (since
e0e4cd
this is a mailing list) we've already read the original message.
e0e4cd
e0e4cd
- Trim irrelevant headers from the original message in your reply. All we need
e0e4cd
to see is a) From, b) Date, and c) Subject. We don't even really need the
e0e4cd
Subject, if you haven't changed it. Better yet is to just preface the original
e0e4cd
message with "On [date] [someone] wrote:".
e0e4cd
e0e4cd
- Please don't reply to or argue about spam, spam filters or viruses on any
e0e4cd
Samba lists. We do have a spam filtering system that is working quite well thank
e0e4cd
you very much but occasionally unwanted messages slip through. Deal with it.
e0e4cd
e0e4cd
- Never say "Me too." It doesn't help anyone solve the problem. Instead, if you
e0e4cd
ARE having the same problem, give more information. Have you seen something that
e0e4cd
the other writer hasn't mentioned, which may be helpful?
e0e4cd
e0e4cd
- If you ask about a problem, then come up with the solution on your own or
e0e4cd
through another source, by all means post it. Someone else may have the same
e0e4cd
problem and is waiting for an answer, but never hears of it.
e0e4cd
e0e4cd
- Give as much *relevant* information as possible such as Samba release number,
e0e4cd
OS, kernel version, etc...
e0e4cd
e0e4cd
- RTFM. Google.
e0e4cd
e0e4cd
### WEB SITE
e0e4cd
A Samba WWW [site](https://samba.org) has been setup with lots of useful info.
e0e4cd
e0e4cd
As well as general information and documentation, this also has searchable
e0e4cd
archives of the mailing list and a user survey that shows who else is using this
e0e4cd
package.