selftest: Add new dfs share (with widelinks enabled)
[Samba.git] / README.md
blobcf55b03bdfdb44523808c5226707ec22769edf7e
1 About Samba
2 ===========
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.
16 For the AD DC implementation a full HOWTO is provided at:
17       https://wiki.samba.org/index.php/Samba4/HOWTO
19 Community guidelines can be read at:
20       https://wiki.samba.org/index.php/How_to_do_Samba:_Nicely
22 This software is freely distributable under the GNU public license, a
23 copy of which you should have received with this software (in a file
24 called COPYING).
28 CONTRIBUTIONS
29 =============
31 Please see https://wiki.samba.org/index.php/Contribute
32 for detailed set-by-step instructions on how to submit a patch
33 for Samba via GitLab.
35 Samba's GitLab mirror is at https://gitlab.com/samba-team/samba
37 OUR CONTRIBUTORS
38 ================
40 See https://www.samba.org/samba/team/ for details of the Samba Team,
41 as well as details of all those currently active in Samba development.
43 If you like a particular feature then look through the git change-log
44 (on the web at https://gitweb.samba.org/?p=samba.git;a=summary) and see
45 who added it, then send them an email.
47 Remember that free software of this kind lives or dies by the response
48 we get. If no one tells us they like it then we'll probably move onto
49 something else.
52 MORE INFO
53 =========
55 DOCUMENTATION
56 -------------
58 There is quite a bit of documentation included with the package,
59 including man pages and the wiki at https://wiki.samba.org
61 If you would like to help with our documentation, please contribute
62 that improved content to the wiki, we are moving as much content there
63 as possible.
66 MAILING LIST
67 ------------
69 Please do NOT send subscription/unsubscription requests to the lists!
71 There is a mailing list for discussion of Samba.  For details go to
72 <https://lists.samba.org/> or send mail to <samba-subscribe@lists.samba.org>
74 There is also an announcement mailing list where new versions are
75 announced.  To subscribe go to <https://lists.samba.org/> or send mail
76 to <samba-announce-subscribe@lists.samba.org>.  All announcements also
77 go to the samba list, so you only need to be on one.
79 For details of other Samba mailing lists and for access to archives, see
80 <https://lists.samba.org/>
83 MAILING LIST ETIQUETTE
84 ----------------------
86 A few tips when submitting to this or any mailing list.
88 1. Make your subject short and descriptive. Avoid the words "help" or
89    "Samba" in the subject. The readers of this list already know that
90    a) you need help, and b) you are writing about samba (of course,
91    you may need to distinguish between Samba PDC and other file
92    sharing software). Avoid phrases such as "what is" and "how do
93    i". Some good subject lines might look like "Slow response with
94    Excel files" or "Migrating from Samba PDC to NT PDC".
96 2. If you include the original message in your reply, trim it so that
97    only the relevant lines, enough to establish context, are
98    included. Chances are (since this is a mailing list) we've already
99    read the original message.
101 3. Trim irrelevant headers from the original message in your
102    reply. All we need to see is a) From, b) Date, and c) Subject. We
103    don't even really need the Subject, if you haven't changed
104    it. Better yet is to just preface the original message with "On
105    [date] [someone] wrote:".
107 4. Please don't reply to or argue about spam, spam filters or viruses
108    on any Samba lists. We do have a spam filtering system that is
109    working quite well thank you very much but occasionally unwanted
110    messages slip through. Deal with it.
112 5. Never say "Me too." It doesn't help anyone solve the
113    problem. Instead, if you ARE having the same problem, give more
114    information. Have you seen something that the other writer hasn't
115    mentioned, which may be helpful?
117 6. If you ask about a problem, then come up with the solution on your
118    own or through another source, by all means post it. Someone else
119    may have the same problem and is waiting for an answer, but never
120    hears of it.
122 7. Give as much *relevant* information as possible such as Samba
123    release number, OS, kernel version, etc...
125 8. RTFM. Google.
128 WEBSITE
129 -------
131 A Samba website has been setup with lots of useful info. Connect to:
133 https://www.samba.org/
135 As well as general information and documentation, this also has searchable
136 archives of the mailing list and links to other useful resources such as
137 the wiki.