README.md

   1 About Samba
   2 ===========
   3
   4 Samba is the standard Windows interoperability suite of
   5 programs for Linux and Unix.
   6 Samba is Free Software licensed under the GNU General Public License and
   7 the Samba project is a member of the Software Freedom Conservancy.
   8 Since 1992, Samba has provided secure, stable and fast file and print services
   9 for all clients using the SMB/CIFS protocol, such as all versions of DOS
  10 and Windows, OS/2, Linux and many others.
  11 Samba is an important component to seamlessly integrate Linux/Unix Servers and
  12 Desktops into Active Directory environments. It can function both as a
  13 domain controller or as a regular domain member.
  14
  15
  16 NOTE: Installation instructions may be found
  17       for the file/print server and domain member in:
  18       docs/htmldocs/Samba3-HOWTO/install.html
  19
  20 For the AD DC implementation a full HOWTO is provided at:
  21       https://wiki.samba.org/index.php/Samba4/HOWTO
  22
  23 Community guidelines can be read at:
  24       https://wiki.samba.org/index.php/How_to_do_Samba:_Nicely
  25
  26 This software is freely distributable under the GNU public license, a
  27 copy of which you should have received with this software (in a file
  28 called COPYING).
  29
  30
  31
  32 CONTRIBUTIONS
  33 =============
  34
  35 1. To contribute via GitLab
  36   - fork the official Samba team repository on GitLab
  37       * see https://gitlab.com/samba-team/samba
  38   - become familiar with the coding standards as described in README.Coding
  39   - make sure you read the Samba copyright policy
  40       * see https://www.samba.org/samba/devel/copyright-policy.html
  41   - create a feature branch
  42   - make changes
  43   - when committing, be sure to add signed-off-by tags
  44       * see https://wiki.samba.org/index.php/CodeReview#commit_message_tags
  45   - send a merge request for your branch through GitLab
  46   - this will send an email to everyone registered on GitLab
  47   - discussion happens on the samba-technical mailing list as described below
  48   - more info on using Git for Samba development can be found on the Samba Wiki
  49       * see https://wiki.samba.org/index.php/Using_Git_for_Samba_Development
  50
  51 2. If you want to contribute to the development of the software then
  52 please join the mailing list. The Samba team accepts patches
  53 (preferably in "diff -u" format, see https://www.samba.org/samba/devel/
  54 for more details) and are always glad to receive feedback or
  55 suggestions to the address samba@lists.samba.org.  More information
  56 on the various Samba mailing lists can be found at https://lists.samba.org/.
  57
  58 You can also get the Samba sourcecode straight from the git repository - see
  59 https://wiki.samba.org/index.php/Using_Git_for_Samba_Development.
  60
  61 If you like a particular feature then look through the git change-log
  62 (on the web at https://gitweb.samba.org/?p=samba.git;a=summary) and see
  63 who added it, then send them an email.
  64
  65 Remember that free software of this kind lives or dies by the response
  66 we get. If no one tells us they like it then we'll probably move onto
  67 something else.
  68
  69
  70 MORE INFO
  71 =========
  72
  73 DOCUMENTATION
  74 -------------
  75
  76 There is quite a bit of documentation included with the package,
  77 including man pages, and lots of .html files with hints and useful
  78 info. This is also available from the webpage. There is a growing
  79 collection of information under docs/.
  80
  81 A list of Samba documentation in languages other than English is
  82 available on the webpage.
  83
  84 If you would like to help with the documentation, please coordinate
  85 on the samba@lists.samba.org mailing list.  See the next section for details
  86 on subscribing to samba mailing lists.
  87
  88
  89 MAILING LIST
  90 ------------
  91
  92 Please do NOT send subscription/unsubscription requests to the lists!
  93
  94 There is a mailing list for discussion of Samba.  For details go to
  95 <https://lists.samba.org/> or send mail to <samba-subscribe@lists.samba.org>
  96
  97 There is also an announcement mailing list where new versions are
  98 announced.  To subscribe go to <https://lists.samba.org/> or send mail
  99 to <samba-announce-subscribe@lists.samba.org>.  All announcements also
 100 go to the samba list, so you only need to be on one.
 101
 102 For details of other Samba mailing lists and for access to archives, see
 103 <https://lists.samba.org/>
 104
 105
 106 MAILING LIST ETIQUETTE
 107 ----------------------
 108
 109 A few tips when submitting to this or any mailing list.
 110
 111 1. Make your subject short and descriptive. Avoid the words "help" or
 112    "Samba" in the subject. The readers of this list already know that
 113    a) you need help, and b) you are writing about samba (of course,
 114    you may need to distinguish between Samba PDC and other file
 115    sharing software). Avoid phrases such as "what is" and "how do
 116    i". Some good subject lines might look like "Slow response with
 117    Excel files" or "Migrating from Samba PDC to NT PDC".
 118
 119 2. If you include the original message in your reply, trim it so that
 120    only the relevant lines, enough to establish context, are
 121    included. Chances are (since this is a mailing list) we've already
 122    read the original message.
 123
 124 3. Trim irrelevant headers from the original message in your
 125    reply. All we need to see is a) From, b) Date, and c) Subject. We
 126    don't even really need the Subject, if you haven't changed
 127    it. Better yet is to just preface the original message with "On
 128    [date] [someone] wrote:".
 129
 130 4. Please don't reply to or argue about spam, spam filters or viruses
 131    on any Samba lists. We do have a spam filtering system that is
 132    working quite well thank you very much but occasionally unwanted
 133    messages slip through. Deal with it.
 134
 135 5. Never say "Me too." It doesn't help anyone solve the
 136    problem. Instead, if you ARE having the same problem, give more
 137    information. Have you seen something that the other writer hasn't
 138    mentioned, which may be helpful?
 139
 140 6. If you ask about a problem, then come up with the solution on your
 141    own or through another source, by all means post it. Someone else
 142    may have the same problem and is waiting for an answer, but never
 143    hears of it.
 144
 145 7. Give as much *relevant* information as possible such as Samba
 146    release number, OS, kernel version, etc...
 147
 148 8. RTFM. Google.
 149
 150
 151 WEBSITE
 152 -------
 153
 154 A Samba website has been setup with lots of useful info. Connect to:
 155
 156 https://www.samba.org/
 157
 158 As well as general information and documentation, this also has searchable
 159 archives of the mailing list and links to other useful resources such as
 160 the wiki.