Followup to r29625: fix getopt tests.
[svn.git] / subversion / svnserve / svnserve.conf.5
blobaa4eb675717c0cb0de7f6b398f97fc802bd98ba3
1 .\" You can view this file with:
2 .\" nroff -man [filename]
3 .\"
4 .TH svnserve.conf 5
5 .SH NAME
6 svnserve.conf \- Repository configuration file for svnserve
7 .SH SYNOPSIS
8 .TP
9 \fIrepository-path\fP\fB/conf/svnserve.conf\fP
10 .SH DESCRIPTION
11 \fBsvnserve.conf\fP controls the behavior of the \fBsvnserve\fP daemon
12 on a per-repository basis.  It is located in the \fBconf\fP
13 subdirectory of the repository.
14 .PP
15 The overall structure of the file is the same as the structure of
16 Subversion user configuration files.  At the top level are sections,
17 which are specified by words in square brackets; inside each section
18 are variable definitions of the form "variable = value".  Lines
19 beginning with '#' are ignored.  \fBsvnserve.conf\fP currently uses
20 only one section named "general", and supports the following
21 variables:
22 .PP
23 .TP 5
24 \fBanon-access\fP = \fBnone\fP|\fBread\fP|\fBwrite\fP
25 Determines the access level for unauthenticated users.  \fBwrite\fP
26 access allows all repository operations.  \fBread\fP access allows all
27 operations except committing and changing revision properties.
28 \fBnone\fP access allows no access.  The default level is \fBread\fP.
29 .PP
30 .TP 5
31 \fBauth-access\fP = \fBnone\fP|\fBread\fP|\fBwrite\fP
32 Determines the access level for authenticated users, using the same
33 access levels as above.  The default level is \fBwrite\fP.
34 .PP
35 .TP 5
36 \fBpassword-db\fP = \fIfilename\fP
37 Sets the location of the password database.  \fIfilename\fP may be
38 relative to the repository conf directory.  There is no default value.
39 The password database has the same overall format as this file.  It
40 uses only one section "users"; each variable within the section is a
41 username, and each value is a password.
42 .PP
43 .TP 5
44 \fBauthz-db\fP = \fIfilename\fP
45 The authz-db option controls the location of the authorization
46 rules for path-based access control.  \fIfilename\fP may be 
47 relative to the repository conf directory.  There is no default value.
48 If you don't specify an authz-db, no path-based access control is done.
49 .PP
50 .TP 5
51 \fBrealm\fP = \fIrealm\-name\fP
52 Sets the authentication realm of the repository.  If two repositories
53 have the same password database, they should have the same realm, and
54 vice versa; this association allows clients to use a single cached
55 password for several repositories.  The default realm value is the
56 repository's uuid.
57 .SH EXAMPLE
58 The following example \fBsvnserve.conf\fP allows read access for
59 authenticated users, no access for anonymous users, points to a passwd
60 database in the same directory, and defines a realm name.
61 .PP
62 .nf
63  [general]
64  anon-access = none
65  auth-access = read
66  password-db = passwd
67  realm = My First Repository
68 .fi
69 .PP
70 The file "passwd" would look like:
71 .PP
72 .nf
73  [users]
74  joeuser = joepassword
75  jayrandom = randomjay
76 .fi
77 .SH SEE ALSO
78 .BR svnserve (8)