contrib/subversion/subversion/svnserve/svnserve.conf.5

   1 .\"
   2 .\"
   3 .\"     Licensed to the Apache Software Foundation (ASF) under one
   4 .\"     or more contributor license agreements.  See the NOTICE file
   5 .\"     distributed with this work for additional information
   6 .\"     regarding copyright ownership.  The ASF licenses this file
   7 .\"     to you under the Apache License, Version 2.0 (the
   8 .\"     "License"); you may not use this file except in compliance
   9 .\"     with the License.  You may obtain a copy of the License at
  10 .\"
  11 .\"       http://www.apache.org/licenses/LICENSE-2.0
  12 .\"
  13 .\"     Unless required by applicable law or agreed to in writing,
  14 .\"     software distributed under the License is distributed on an
  15 .\"     "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
  16 .\"     KIND, either express or implied.  See the License for the
  17 .\"     specific language governing permissions and limitations
  18 .\"     under the License.
  19 .\"
  20 .\"
  21 .\" You can view this file with:
  22 .\" nroff -man [filename]
  23 .\"
  24 .TH svnserve.conf 5
  25 .SH NAME
  26 svnserve.conf \- Repository configuration file for svnserve
  27 .SH SYNOPSIS
  28 .TP
  29 \fIrepository-path\fP\fB/conf/svnserve.conf\fP
  30 .SH DESCRIPTION
  31 \fBsvnserve.conf\fP controls the behavior of the \fBsvnserve\fP daemon
  32 on a per-repository basis.  It is located in the \fBconf\fP
  33 subdirectory of the repository.
  34 .PP
  35 The overall structure of the file is the same as the structure of
  36 Subversion user configuration files.  At the top level are sections,
  37 which are specified by words in square brackets; inside each section
  38 are variable definitions of the form "variable = value".  Lines
  39 beginning with '#' are ignored.  \fBsvnserve.conf\fP currently uses
  40 only one section named "general", and supports the following
  41 variables:
  42 .PP
  43 .TP 5
  44 \fBanon-access\fP = \fBnone\fP|\fBread\fP|\fBwrite\fP
  45 Determines the access level for unauthenticated users.  \fBwrite\fP
  46 access allows all repository operations.  \fBread\fP access allows all
  47 operations except committing and changing revision properties.
  48 \fBnone\fP access allows no access.  The default level is \fBread\fP.
  49 .PP
  50 .TP 5
  51 \fBauth-access\fP = \fBnone\fP|\fBread\fP|\fBwrite\fP
  52 Determines the access level for authenticated users, using the same
  53 access levels as above.  The default level is \fBwrite\fP.
  54 .PP
  55 .TP 5
  56 \fBpassword-db\fP = \fIfilename\fP
  57 Sets the location of the password database.  \fIfilename\fP may be
  58 relative to the repository conf directory.  There is no default value.
  59 The password database has the same overall format as this file.  It
  60 uses only one section "users"; each variable within the section is a
  61 username, and each value is a password.
  62 .PP
  63 .TP 5
  64 \fBauthz-db\fP = \fIpath\fP
  65 The authz-db option controls the location of the authorization
  66 rules for path-based access control.  \fIpath\fP may be
  67 relative to the repository conf directory.  \fIpath\fP may be a repository
  68 relative URL (^/) or absolute file:// URL to a text file in a Subversion
  69 repository.  There is no default value.  If you don't specify an authz-db,
  70 no path-based access control is done.
  71 .PP
  72 .TP 5
  73 \fBrealm\fP = \fIrealm\-name\fP
  74 Sets the authentication realm of the repository.  If two repositories
  75 have the same password database, they should have the same realm, and
  76 vice versa; this association allows clients to use a single cached
  77 password for several repositories.  The default realm value is the
  78 repository's uuid.
  79 .SH EXAMPLE
  80 The following example \fBsvnserve.conf\fP allows read access for
  81 authenticated users, no access for anonymous users, points to a passwd
  82 database in the same directory, and defines a realm name.
  83 .PP
  84 .nf
  85  [general]
  86  anon-access = none
  87  auth-access = read
  88  password-db = passwd
  89  realm = My First Repository
  90 .fi
  91 .PP
  92 The file "passwd" would look like:
  93 .PP
  94 .nf
  95  [users]
  96  joeuser = joepassword
  97  jayrandom = randomjay
  98 .fi
  99 .SH SEE ALSO
 100 .BR svnserve (8)