r21023: Brad Henry pointed out some typos.
[jra/samba/.git] / README
1 Samba 4 is the ambitious next version of the Samba suite that is being
2 developed in parallel to the stable 3.0 series. The main emphasis in
3 this branch is support for the Active Directory logon protocols used
4 by Windows 2000 and above.
5
6 While we welcome your interest in Samba 4, we don't want you to run your network with it quite yet. Please note the WARNINGS below, and the STATUS file,
7 which aims to document what should and should not work.
8
9 With 4 years of development under our belt since Tridge first proposed
10 a new Virtual File System (VFS) layer for Samba3 (a project which
11 eventually lead to our Active Directory efforts), we felt that we
12 should create something we could 'show off' to our users.  This is a
13 Technology Preview (TP), aimed at allowing you, our users, managers and
14 developers to see how we have progressed, and to invite your feedback and
15 support.
16
17 WARNINGS
18 ========
19
20 Samba4 TP is currently a pre-alpha technology.  That is more a
21 reference to Samba4's lack of the features we expect you will need
22 than a statement of code quality, but clearly it hasn't seen a broad
23 deployment yet.  If you were to upgrade Samba3 (or indeed Windows) to
24 Samba4, you would find many things work, but that other key features
25 you may have relied on simply are not there yet.
26
27 For example, while Samba 3.0 is an excellent member of a Active
28 Directory domain, Samba4 is happier as a domain controller: (This is
29 where we have done most of the research and development).
30
31 While Samba4 is subjected to an awesome battery of tests on an
32 automated basis, and we have found Samba4 to be very stable in it's
33 behaviour, we have to recommend against upgrading production servers
34 from Samba 3 to Samba 4 at this stage.  If you are upgrading an
35 experimental server, or looking to develop and test Samba, you should
36 backup all configuration and data.
37
38 As we research the needs of Active Directory integration more closely,
39 we may need to change the format of the user database, in particular
40 as we begin to understand how the attributes are generated and stored.
41 At a worst case, we expect users will be able to extract the stored
42 data as LDIF and hand munge it, but until we make an alpha release, we
43 won't do this automatically.  Indeed, many module changes are simply
44 easier to cope with if you just re-provision after the upgrade.
45
46 We value the security of your computers, and so we must warn you that
47 Samba 4 Technology Preview includes basic Access Control List (ACL)
48 protection on the main user database, but due to time constraints,
49 none on the registry at this stage.  We also do not currently have
50 ACLs on the SWAT web-based management tool. This means that Samba 4
51 Technology Preview is not secure, and should not be exposed to
52 untrusted networks.
53
54 Within the above proviso, file system access should occur as the
55 logged in user, much as Samba3 does.
56
57 As such, we must strongly recommend against using Samba4 in a
58 production environment at this stage.
59
60 NEW FEATURES
61 ============
62
63 Samba4 supports the server-side of the Active Directory logon environment
64 used by Windows 2000 and later, so we can do full domain join
65 and domain logon operations with these clients.
66
67 Our Domain Controller (DC) implementation includes our own built-in
68 LDAP server and Kerberos Key Distribution Centre (KDC) as well as the
69 Samba3-like logon services provided over CIFS.  We correctly generate
70 the infamous Kerberos PAC, and include it with the Kerberos tickets we
71 issue.
72
73 SWAT is now integrated into Samba 4 as the user-friendly interface to
74 Samba server management. SWAT provides easy access to our
75 setup and migration tools.  Using SWAT, you can migrate windows
76 domains in Samba 4, allowing easy setup of initial user databases, and
77 upgrades from Samba 3.
78
79 The new VFS features in Samba 4 adapts the file-system on the server to
80 match the Windows client semantics, allowing Samba 4 to better match
81 windows behaviour and application expectations.  This includes file
82 annotation information (in streams) and NT ACLs in particular.  The
83 VFS is backed with an extensive automated test suite.
84
85 A new scripting interface has been added to Samba 4, allowing
86 JavaScript programs to interface to Samba's internals.
87
88 The Samba 4 architecture is based around an LDAP-like database that
89 can use a range of modular backends.  One of the backends supports
90 standards compliant LDAP servers (including OpenLDAP), and we are
91 working on modules to map between AD-like behaviours and this back-end.
92 We are aiming for Samba 4 to be powerful front-end to large
93 directories.
94
95 CHANGES
96 =======
97
98 Those familiar with Samba 3 can find a list of user-visible changes
99 since that release series in the NEWS file.
100
101  - An optional password is no longer supported as the second argument to 
102    smbclient.
103
104  - The default location of smb.conf in non-FHS builds has changed from the 
105    PREFIX/lib directory to the PREFIX/etc directory.
106
107 KNOWN ISSUES
108 ============
109
110 - Standalone server and domain member roles are not currently
111   supported.  While we have much of the infrastructure required, we
112   have not collected these pieces together. 
113
114 - There is no printing support in the current release.
115
116 - SWAT can be painful with <TAB> and forms.  Just use the mouse, as
117   the JavaScript layer doing this will change.
118
119 RUNNING Samba4
120 ==============
121
122 A short guide to setting up Samba 4 can be found in the howto.txt file
123 in root of the tarball.
124
125 DEVELOPMENT and FEEDBACK
126 ========================
127 Bugs can be filed at https://bugzilla.samba.org/. Please
128 look at the STATUS file before filing a bug to see if a particular
129 is supposed to work yet.
130
131 Development and general discussion about Samba 4 happens mainly on
132 the #samba-technical IRC channel (on irc.freenode.net) and
133 the samba-technical mailing list (see http://lists.samba.org/ for
134 details).
135
136