doc/manual.docbook
author Paul Crowley <paul@lshift.net>
Fri, 24 Aug 2012 11:46:27 +0100
changeset 358 924bf9d4dbc0
parent 345 f06d9816272d
child 359 a14142919eb3
permissions -rw-r--r--
Added a para warning that an hg account will be created, as suggested in email
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
     1
<?xml version="1.0" encoding="utf-8"?>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
     2
<article xmlns="http://docbook.org/ns/docbook" version="5.0" xml:lang="en"
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
     3
  xmlns:xlink="http://www.w3.org/1999/xlink">
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
     4
<info>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
     5
  <title>Sharing Mercurial repositories with mercurial-server</title>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
     6
  <author><firstname>Paul</firstname><surname>Crowley</surname></author>
345
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
     7
  <copyright><year>2008-2011</year><holder>Paul Crowley, LShift Ltd</holder></copyright>
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
     8
</info>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
     9
<section>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    10
<title>About mercurial-server</title>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    11
<para>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    12
Home page: <link xlink:href="http://www.lshift.net/mercurial-server.html"/>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    13
</para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    14
<para>
133
a99ab5be891a Let next para do the work of discussing what OS it runs on
Paul Crowley <paul@lshift.net>
parents: 132
diff changeset
    15
mercurial-server gives your developers remote read/write access to
a99ab5be891a Let next para do the work of discussing what OS it runs on
Paul Crowley <paul@lshift.net>
parents: 132
diff changeset
    16
centralized <link xlink:href="http://hg-scm.org/">Mercurial</link>
a99ab5be891a Let next para do the work of discussing what OS it runs on
Paul Crowley <paul@lshift.net>
parents: 132
diff changeset
    17
repositories using SSH public key authentication; it provides convenient
a99ab5be891a Let next para do the work of discussing what OS it runs on
Paul Crowley <paul@lshift.net>
parents: 132
diff changeset
    18
and fine-grained key management and access control.
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    19
</para>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    20
<para>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    21
Though mercurial-server is currently targeted at Debian-based systems such
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    22
as Ubuntu, other users have reported success getting it running on other
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    23
Unix-based systems such as Red Hat. Running it on a non-Unix system such as
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    24
Windows is not supported. You will need root privileges to install it.
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    25
</para>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    26
</section>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    27
<section>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    28
<title>Step by step</title>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    29
<para>
134
525976d2827c Change the way we link to SSH tutorial
Paul Crowley <paul@lshift.net>
parents: 133
diff changeset
    30
mercurial-server authenticates users not using passwords but using SSH
525976d2827c Change the way we link to SSH tutorial
Paul Crowley <paul@lshift.net>
parents: 133
diff changeset
    31
public keys; everyone who wants access to a mercurial-server repository
131
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
    32
will need such a key. In combination with <command>ssh-agent</command> (or
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    33
equivalents such as the Windows program <link
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    34
xlink:href="http://the.earth.li/~sgtatham/putty/0.60/htmldoc/Chapter9.html#pageant">Pageant</link>),
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    35
this means that users will not need to type in a password to access the
134
525976d2827c Change the way we link to SSH tutorial
Paul Crowley <paul@lshift.net>
parents: 133
diff changeset
    36
repository. If you're not familiar with SSH public keys, the <link
525976d2827c Change the way we link to SSH tutorial
Paul Crowley <paul@lshift.net>
parents: 133
diff changeset
    37
xlink:href="http://sial.org/howto/openssh/publickey-auth/">OpenSSH Public
525976d2827c Change the way we link to SSH tutorial
Paul Crowley <paul@lshift.net>
parents: 133
diff changeset
    38
Key Authentication tutorial</link> may be helpful.
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    39
</para>
358
924bf9d4dbc0 Added a para warning that an hg account will be created, as suggested in email
Paul Crowley <paul@lshift.net>
parents: 345
diff changeset
    40
<para>
924bf9d4dbc0 Added a para warning that an hg account will be created, as suggested in email
Paul Crowley <paul@lshift.net>
parents: 345
diff changeset
    41
When mercurial-server is installed, a new user account called <systemitem
924bf9d4dbc0 Added a para warning that an hg account will be created, as suggested in email
Paul Crowley <paul@lshift.net>
parents: 345
diff changeset
    42
class="username">hg</systemitem> will be created; this user's home directory will be where all repositories will be stored, so you should ensure that it has enough space and suchlike.</para>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    43
<section>
185
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 179
diff changeset
    44
<title>Initial access to mercurial-server</title>
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    45
<para>
122
05b676684c7e Call the user jay rather than user, and use pat instead of other-user
Paul Crowley <paul@lshift.net>
parents: 121
diff changeset
    46
In what follows, we assume that your username is <systemitem
05b676684c7e Call the user jay rather than user, and use pat instead of other-user
Paul Crowley <paul@lshift.net>
parents: 121
diff changeset
    47
class="username">jay</systemitem>, that you usually sit at a machine called
185
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 179
diff changeset
    48
<systemitem class="systemname">spoon</systemitem> and you have
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 179
diff changeset
    49
installed mercurial-server on <systemitem
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 179
diff changeset
    50
class="systemname">jeeves</systemitem> using the package management system (see the README for more on installation). We assume that you have created your SSH public key, set up your SSH agent with this key, and that this key gives you access to <systemitem
311
3cbde66305e4 Fix white space
Paul Crowley <paul@lshift.net>
parents: 263
diff changeset
    51
class="systemname">jeeves</systemitem>.
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    52
</para>
185
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 179
diff changeset
    53
<screen><computeroutput>jay@spoon:~$ </computeroutput><userinput>ssh -A jeeves</userinput>
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 179
diff changeset
    54
<computeroutput>jay@jeeves:~$ </computeroutput><userinput>ssh-add -L > my-key</userinput>
158
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
    55
<computeroutput>jay@jeeves:~$ </computeroutput><userinput>sudo mkdir -p /etc/mercurial-server/keys/root/jay</userinput>
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
    56
<computeroutput>jay@jeeves:~$ </computeroutput><userinput>sudo cp my-key /etc/mercurial-server/keys/root/jay/spoon</userinput>
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
    57
<computeroutput>jay@jeeves:~$ </computeroutput><userinput>sudo -u hg /usr/share/mercurial-server/refresh-auth</userinput>
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
    58
<computeroutput>jay@jeeves:~$ </computeroutput><userinput>exit</userinput>
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
    59
<computeroutput>Connection to jeeves closed.
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
    60
jay@spoon:~$ </computeroutput></screen>
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    61
<para>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    62
You can now create repositories on the remote machine and have complete
131
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
    63
read-write access to all of them.
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    64
</para>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    65
</section>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    66
<section>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    67
<title>Creating repositories</title>
131
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
    68
<para>
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
    69
To store a repository on the server, clone it over.
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
    70
</para>
345
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    71
<screen><computeroutput>jay@spoon:~$ </computeroutput><userinput>hg init myproj</userinput>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    72
<computeroutput>jay@spoon:~$ </computeroutput><userinput>cd myproj</userinput>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    73
<computeroutput>jay@spoon:~/myproj$ </computeroutput><userinput>editor program.c</userinput> <lineannotation>...create project files here...</lineannotation>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    74
<computeroutput>jay@spoon:~/myproj$ </computeroutput><userinput>hg add</userinput>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    75
<computeroutput>adding program.c
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    76
jay@spoon:~/myproj$ </computeroutput><userinput>hg commit -m "Initial checkin"</userinput>
160
72cb7a42650a Use shorter remote repo name
Paul Crowley <paul@lshift.net>
parents: 159
diff changeset
    77
<computeroutput>jay@spoon:~/myproj$ </computeroutput><userinput>hg clone . ssh://hg@jeeves/jays/project</userinput>
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    78
<computeroutput>searching for changes
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    79
remote: adding changesets
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    80
remote: adding manifests
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    81
remote: adding file changes
345
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    82
remote: added 1 changesets with 1 changes to 1 files
160
72cb7a42650a Use shorter remote repo name
Paul Crowley <paul@lshift.net>
parents: 159
diff changeset
    83
jay@spoon:~/myproj$ </computeroutput><userinput>hg pull ssh://hg@jeeves/jays/project</userinput>
72cb7a42650a Use shorter remote repo name
Paul Crowley <paul@lshift.net>
parents: 159
diff changeset
    84
<computeroutput>pulling from ssh://hg@jeeves/jays/project
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    85
searching for changes
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    86
no changes found
345
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    87
jay@spoon:~/myproj$ </computeroutput><userinput>cd ..</userinput>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    88
<computeroutput>jay@spoon:~$ </computeroutput></screen>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    89
</section>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    90
<section>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    91
<title>Adding other users</title>
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    92
<para>
145
bc2b93fa662d tiny reword
Paul Crowley <paul@lshift.net>
parents: 144
diff changeset
    93
At this stage, no-one but you has any access to any repositories you
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    94
create on this system. In order to give anyone else access, you'll need a
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
    95
copy of their SSH public key; we'll assume you have that key in
161
475a05ed5f0e Sam's machine is called saucer
Paul Crowley <paul@lshift.net>
parents: 160
diff changeset
    96
<filename>~/sam-saucer-key.pub</filename>.  To manage access, you make changes to the special <filename
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
    97
class='directory'>hgadmin</filename> repository.
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    98
</para>
158
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
    99
<screen><computeroutput>jay@spoon:~$ </computeroutput><userinput>hg clone ssh://hg@jeeves/hgadmin</userinput>
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   100
<computeroutput>destination directory: hgadmin
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   101
no changes found
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   102
updating working directory
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   103
0 files updated, 0 files merged, 0 files removed, 0 files unresolved
158
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
   104
jay@spoon:~$ </computeroutput><userinput>cd hgadmin</userinput>
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
   105
<computeroutput>jay@spoon:~/hgadmin$ </computeroutput><userinput>mkdir -p keys/users/sam</userinput>
161
475a05ed5f0e Sam's machine is called saucer
Paul Crowley <paul@lshift.net>
parents: 160
diff changeset
   106
<computeroutput>jay@spoon:~/hgadmin$ </computeroutput><userinput>cp ~/sam-saucer-key.pub keys/users/sam/saucer</userinput>
158
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
   107
<computeroutput>jay@spoon:~/hgadmin$ </computeroutput><userinput>hg add</userinput>
161
475a05ed5f0e Sam's machine is called saucer
Paul Crowley <paul@lshift.net>
parents: 160
diff changeset
   108
<computeroutput>adding keys/users/sam/saucer
162
1c0bc7d33648 Remove stray apostrophe
Paul Crowley <paul@lshift.net>
parents: 161
diff changeset
   109
jay@spoon:~/hgadmin$ </computeroutput><userinput>hg commit -m "Add Sam's key"</userinput>
158
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
   110
<computeroutput>jay@spoon:~/hgadmin$ </computeroutput><userinput>hg push</userinput>
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
   111
<computeroutput>pushing to ssh://hg@jeeves/hgadmin
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   112
searching for changes
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   113
remote: adding changesets
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   114
remote: adding manifests
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   115
remote: adding file changes
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   116
remote: added 1 changesets with 1 changes to 1 files
158
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
   117
jay@spoon:~/hgadmin$ </computeroutput></screen>
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   118
<para>
123
20b54500a618 Call the other user "Sam"
Paul Crowley <paul@lshift.net>
parents: 122
diff changeset
   119
Sam can now read and write to your
160
72cb7a42650a Use shorter remote repo name
Paul Crowley <paul@lshift.net>
parents: 159
diff changeset
   120
<uri>ssh://hg@jeeves/jays/project</uri> repository.
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   121
Most other changes to access control can be made simply by making and
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   122
pushing changes to <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   123
class='directory'>hgadmin</filename>, and you can use Mercurial to
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   124
cooperate with other root users in the normal way.
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   125
</para>
131
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
   126
<para>
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
   127
If you prefer, you could give them access by
158
713c6cccbc2f Use short meaningless hostnames
Paul Crowley <paul@lshift.net>
parents: 157
diff changeset
   128
logging into <systemitem class="systemname">jeeves</systemitem>,
131
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
   129
putting the key in the right place under <filename
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
   130
class='directory'>/etc/mercurial-server/keys</filename>, and re-running
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
   131
<userinput>sudo -u hg /usr/share/mercurial-server/refresh-auth</userinput>.
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   132
However, using <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   133
class='directory'>hgadmin</filename> is usually more convenient if you need to make more than a very few changes; it also makes it easier to share administration with others and provides a log of all changes.
131
e8bf13d06582 Assume they have SSH set up; talk about hgadmin first
Paul Crowley <paul@lshift.net>
parents: 130
diff changeset
   134
</para>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   135
</section>
132
a5850a63390f Move basic access control to the start of access control
Paul Crowley <paul@lshift.net>
parents: 131
diff changeset
   136
</section>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   137
<section>
132
a5850a63390f Move basic access control to the start of access control
Paul Crowley <paul@lshift.net>
parents: 131
diff changeset
   138
<title>Access control</title>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   139
<para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   140
Out of the box, mercurial-server supports two kinds of users: "root" users and normal users.  If you followed the steps above, you are a "root" user because your key is under <filename class='directory'>keys/root</filename>, while the other user you gave access to is a normal user since their key is under <filename class='directory'>keys/users</filename>.  Keys that are not in either of these directories will by default have no access to anything.
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   141
</para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   142
<para>
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   143
Root users can edit <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   144
class='directory'>hgadmin</filename>, create new repositories and read and write to existing ones.  Normal users cannot access <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   145
class='directory'>hgadmin</filename> or create new repositories, but they can read and write to any other repository.
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   146
</para>
132
a5850a63390f Move basic access control to the start of access control
Paul Crowley <paul@lshift.net>
parents: 131
diff changeset
   147
<section>
a5850a63390f Move basic access control to the start of access control
Paul Crowley <paul@lshift.net>
parents: 131
diff changeset
   148
<title>Using access.conf</title>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   149
<para>
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   150
mercurial-server offers much more fine-grained access control than this division into two classes of users.  Let's suppose you wish to give Pat access to the <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   151
class='directory'>widget</filename> repository, but no other.  We first copy Pat's SSH public key into the <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   152
class='directory'>keys/pat</filename> directory in <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   153
class='directory'>hgadmin</filename>.  This tells mercurial-server about Pat's key, but gives Pat no access to anything because the key is not under either <filename
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   154
class='directory'>keys/root</filename> or <filename
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   155
class='directory'>keys/users</filename>.  To grant this key access, we must give mercurial-server a new access rule, so we create a file in <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   156
class='directory'>hgadmin</filename> called <filename>access.conf</filename>, with the following contents:</para>
146
04e74d4b3822 Simplify Pat story
Paul Crowley <paul@lshift.net>
parents: 145
diff changeset
   157
<programlisting># Give Pat access to the "widget" repository
238
4747f2920666 Use wildcard in rule to match instructions
Paul Crowley <paul@lshift.net>
parents: 221
diff changeset
   158
write repo=widget user=pat/*
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   159
</programlisting>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   160
<para>
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   161
Pat will have read and write access to the <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   162
class='directory'>widget</filename> repository as soon as we add, commit, and push these files.
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   163
</para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   164
<para>
345
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   165
Placing the same key in multiple directories will <emphasis>not</emphasis>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   166
grant that user multiple powers.  One of the locations will be used for
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   167
all permission checks, while any others will be ignored.  Instead, put each
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   168
key under the keys directory only once, and use
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   169
<filename>access.conf</filename> to give permissions to the key.
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   170
</para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   171
<para>
124
6836769f5134 Forgot a filename tag
Paul Crowley <paul@lshift.net>
parents: 123
diff changeset
   172
Each line of <filename>access.conf</filename> has the following syntax:
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   173
</para>
144
2dbaddde1fd5 programlisting also needs no initial blank lines
Paul Crowley <paul@lshift.net>
parents: 143
diff changeset
   174
<programlisting><replaceable>rule</replaceable> <replaceable>condition</replaceable> <replaceable>condition...</replaceable>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   175
</programlisting>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   176
<para>
157
bb53f3b9c411 Use markup, not quote marks
Paul Crowley <paul@lshift.net>
parents: 156
diff changeset
   177
Blank lines and lines that start with <code>#</code> are ignored. Rule is
bb53f3b9c411 Use markup, not quote marks
Paul Crowley <paul@lshift.net>
parents: 156
diff changeset
   178
one of
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   179
</para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   180
<itemizedlist>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   181
<listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   182
<literal>init</literal>: allow reads, writes, and the creation of new repositories
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   183
</listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   184
<listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   185
<literal>write</literal>: allow reads and writes
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   186
</listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   187
<listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   188
<literal>read</literal>: allow only read operations
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   189
</listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   190
<listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   191
<literal>deny</literal>: deny all requests
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   192
</listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   193
</itemizedlist>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   194
<para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   195
A condition is a globpattern matched against a relative path. The two most
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   196
important conditions are
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   197
</para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   198
<itemizedlist>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   199
<listitem>
156
34925ee06f90 Silly to use literal inside code
Paul Crowley <paul@lshift.net>
parents: 155
diff changeset
   200
<code>user=<replaceable>globpattern</replaceable></code>: path to the user's key
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   201
</listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   202
<listitem>
156
34925ee06f90 Silly to use literal inside code
Paul Crowley <paul@lshift.net>
parents: 155
diff changeset
   203
<code>repo=<replaceable>globpattern</replaceable></code>: path to the repository
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   204
</listitem>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   205
</itemizedlist>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   206
<para>
157
bb53f3b9c411 Use markup, not quote marks
Paul Crowley <paul@lshift.net>
parents: 156
diff changeset
   207
<code>*</code> only matches one directory level, where <code>**</code>
bb53f3b9c411 Use markup, not quote marks
Paul Crowley <paul@lshift.net>
parents: 156
diff changeset
   208
matches as many as you want. More precisely, <code>*</code> matches zero or
bb53f3b9c411 Use markup, not quote marks
Paul Crowley <paul@lshift.net>
parents: 156
diff changeset
   209
more characters not including <code>/</code> while <code>**</code> matches
bb53f3b9c411 Use markup, not quote marks
Paul Crowley <paul@lshift.net>
parents: 156
diff changeset
   210
zero or more characters including <code>/</code>. So
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   211
<code>projects/*</code> matches <filename
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   212
class='directory'>projects/foo</filename> but not <filename
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   213
class='directory'>projects/foo/bar</filename>, while
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   214
<code>projects/**</code> matches both.
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   215
</para>
147
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   216
<para>
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   217
When considering a request, mercurial-server steps through all the rules in
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   218
<filename>/etc/mercurial-server/access.conf</filename> and then all the
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   219
rules in <filename>access.conf</filename> in <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   220
class='directory'>hgadmin</filename>
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   221
looking for a rule which matches on every condition. The first match
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   222
determines whether the request will be allowed; if there is no match in
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   223
either file, the request will be denied.
147
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   224
</para>
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   225
<para>
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   226
By default, <filename>/etc/mercurial-server/access.conf</filename> has the
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   227
following rules:
147
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   228
</para>
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   229
<programlisting>init user=root/**
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   230
deny repo=hgadmin
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   231
write user=users/**
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   232
</programlisting>
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   233
<para>
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   234
These rules ensure that root users can do any operation on any repository,
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   235
that no other users can access the <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   236
class='directory'>hgadmin</filename> repository,
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   237
and that those with keys in <filename
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   238
class='directory'>keys/users</filename> can read or write to any repository
153
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   239
but not create repositories.  Some examples of how these rules work:
147
b29a7088b132 Move conditions next to rules
Paul Crowley <paul@lshift.net>
parents: 146
diff changeset
   240
</para>
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   241
<itemizedlist>
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   242
<listitem>
153
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   243
User <filename class='directory'>root/jay</filename> creates a repository
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   244
<filename class='directory'>foo/bar/baz</filename>. This matches the first
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   245
rule and so will be allowed.
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   246
</listitem>
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   247
<listitem>
153
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   248
User <filename class='directory'>root/jay</filename> changes repository
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   249
<filename class='directory'>hgadmin</filename>. Again, this matches the
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   250
first rule and so will be allowed; later rules have no effect.
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   251
</listitem>
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   252
<listitem>
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   253
User <filename class='directory'>users/sam</filename> tries to read
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   254
repository <filename class='directory'>hgadmin</filename>. This does not
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   255
match the first rule, but matches the second, and so will be denied.
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   256
</listitem>
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   257
<listitem>
153
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   258
User <filename class='directory'>users/sam</filename> tries to create
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   259
repository <filename class='directory'>sams-project</filename>. This does
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   260
not match the first two rules, but matches the third; this is a
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   261
<literal>write</literal> rule, which doesn't grant the privilege to create
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   262
repositories, so the request will be denied.
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   263
</listitem>
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   264
<listitem>
153
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   265
User <filename class='directory'>users/sam</filename> writes to existing
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   266
repository <filename class='directory'>projects/main</filename>. Again,
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   267
this matches the third rule, which allows the request.
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   268
</listitem>
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   269
<listitem>
153
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   270
User <filename class='directory'>pat</filename> tries to write to existing
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   271
repository <filename class='directory'>widget</filename>. Until we change
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   272
the <filename>access.conf</filename> file in <filename
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   273
class='directory'>hgadmin</filename>, this will match no rule, and so will
aa57f48c7585 replace generalities with specific examples
Paul Crowley <paul@lshift.net>
parents: 152
diff changeset
   274
be denied.
152
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   275
</listitem>
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   276
<listitem>
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   277
Any request from a user whose key not under the <filename
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   278
class='directory'>keys</filename> directory at all will always be denied,
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   279
no matter what rules are in effect; because of the way SSH authentication
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   280
works, they will be prompted to enter a password, but no password will
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   281
work. This can't be changed.
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   282
</listitem>
f4688940fe15 Improvements to access.conf documentation
Paul Crowley <paul@lshift.net>
parents: 151
diff changeset
   283
</itemizedlist>
132
a5850a63390f Move basic access control to the start of access control
Paul Crowley <paul@lshift.net>
parents: 131
diff changeset
   284
</section>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   285
<section>
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   286
<title>/etc/mercurial-server and hgadmin</title>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   287
<para>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   288
mercurial-server consults two distinct locations to collect information about what to allow: <filename
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   289
class='directory'>/etc/mercurial-server</filename> and its own <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   290
class='directory'>hgadmin</filename> repository.  This is useful for several reasons:
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   291
</para>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   292
<itemizedlist>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   293
<listitem>
148
5da43b596bac Fixes to /etc/mercurial-server discussion
Paul Crowley <paul@lshift.net>
parents: 147
diff changeset
   294
Some users may not need the convenience of access control via mercurial; for these users updating <filename
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   295
class='directory'>/etc/mercurial-server</filename> may offer a simpler route.
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   296
</listitem>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   297
<listitem>
148
5da43b596bac Fixes to /etc/mercurial-server discussion
Paul Crowley <paul@lshift.net>
parents: 147
diff changeset
   298
<filename class='directory'>/etc/mercurial-server</filename> is suitable
5da43b596bac Fixes to /etc/mercurial-server discussion
Paul Crowley <paul@lshift.net>
parents: 147
diff changeset
   299
for management with tools such as <link
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   300
xlink:href="http://reductivelabs.com/products/puppet">Puppet</link>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   301
</listitem>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   302
<listitem>
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   303
If a change to <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   304
class='directory'>hgadmin</filename> leaves you "locked out", <filename
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   305
class='directory'>/etc/mercurial-server</filename> allows you a way back in.
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   306
</listitem>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   307
<listitem>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   308
At install time, all users are "locked out", and so some mechanism to allow some users in is needed.
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   309
</listitem>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   310
</itemizedlist>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   311
<para>
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   312
Rules in <filename>/etc/mercurial-server/access.conf</filename> are checked before those in <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   313
class='directory'>hgadmin</filename>, and keys in <filename class='directory'>/etc/mercurial-server/keys</filename> will be present no matter how <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   314
class='directory'>hgadmin</filename> changes.
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   315
</para>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   316
<para>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   317
We anticipate that once mercurial-server is successfully installed and
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   318
working you will usually want to use <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   319
class='directory'>hgadmin</filename> for most
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   320
access control tasks. Once you have the right keys and
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   321
<filename>access.conf</filename> set up in <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   322
class='directory'>hgadmin</filename>, you
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   323
can delete <filename>/etc/mercurial-server/access.conf</filename> and all
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   324
of <filename class='directory'>/etc/mercurial-server/keys</filename>,
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   325
turning control entirely over to <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   326
class='directory'>hgadmin</filename>.
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   327
</para>
127
3262c0a53b59 Talk about remote-hgrc
Paul Crowley <paul@lshift.net>
parents: 126
diff changeset
   328
<para>
221
c4c3facf5d6b Switch to remote-hgrc.d
Paul Crowley <paul@lshift.net>
parents: 185
diff changeset
   329
<filename>/etc/mercurial-server/remote-hgrc.d</filename> is in the
127
3262c0a53b59 Talk about remote-hgrc
Paul Crowley <paul@lshift.net>
parents: 126
diff changeset
   330
<systemitem>HGRCPATH</systemitem> for all remote access to mercurial-server
221
c4c3facf5d6b Switch to remote-hgrc.d
Paul Crowley <paul@lshift.net>
parents: 185
diff changeset
   331
repositories. This directory contains the hooks that mercurial-server uses for
c4c3facf5d6b Switch to remote-hgrc.d
Paul Crowley <paul@lshift.net>
parents: 185
diff changeset
   332
access control and logging. You can add hooks to this directory, but obviously
127
3262c0a53b59 Talk about remote-hgrc
Paul Crowley <paul@lshift.net>
parents: 126
diff changeset
   333
breaking the existing hooks will disable the relevant functionality and
3262c0a53b59 Talk about remote-hgrc
Paul Crowley <paul@lshift.net>
parents: 126
diff changeset
   334
isn't advisable.
3262c0a53b59 Talk about remote-hgrc
Paul Crowley <paul@lshift.net>
parents: 126
diff changeset
   335
</para>
125
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   336
</section>
fc5b8fc1040e Explain why we configure access twice
Paul Crowley <paul@lshift.net>
parents: 124
diff changeset
   337
<section>
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   338
<title>File and branch conditions</title>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   339
<para>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   340
mercurial-server supports file and branch conditions, which restrict an
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   341
operation depending on what files it modifies and what branch the work is
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   342
on. </para>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   343
<caution>
128
b1610de4b6b1 Reword caution
Paul Crowley <paul@lshift.net>
parents: 127
diff changeset
   344
The way these conditions work is subtle and can be counterintuitive. Unless
b1610de4b6b1 Reword caution
Paul Crowley <paul@lshift.net>
parents: 127
diff changeset
   345
you need what they provide, ignore this section, stick to user and repo
140
0f79d1bea07e Beef up the caution
Paul Crowley <paul@lshift.net>
parents: 139
diff changeset
   346
conditions, and then things are likely to work the way you would expect. If
0f79d1bea07e Beef up the caution
Paul Crowley <paul@lshift.net>
parents: 139
diff changeset
   347
you do need what they provide, read what follows very carefully.
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   348
</caution>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   349
<para>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   350
File and branch conditions are added to the conditions against which a rule
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   351
matches, just like user and repo conditions; they have this form:
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   352
</para>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   353
<itemizedlist>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   354
<listitem>
156
34925ee06f90 Silly to use literal inside code
Paul Crowley <paul@lshift.net>
parents: 155
diff changeset
   355
<code>file=<replaceable>globpattern</replaceable></code>: file within the repo
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   356
</listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   357
<listitem>
156
34925ee06f90 Silly to use literal inside code
Paul Crowley <paul@lshift.net>
parents: 155
diff changeset
   358
<code>branch=<replaceable>globpattern</replaceable></code>: Mercurial branch name
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   359
</listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   360
</itemizedlist>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   361
<para>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   362
However, in order to understand what effect adding these conditions will
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   363
have, it helps to understand how and when these rules are applied.
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   364
</para>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   365
<para>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   366
The rules file is used to make three decisions:
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   367
</para>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   368
<itemizedlist>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   369
<listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   370
Whether to allow a repository to be created
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   371
</listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   372
<listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   373
Whether to allow any access to a repository
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   374
</listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   375
<listitem>
139
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   376
Whether to allow a changeset
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   377
</listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   378
</itemizedlist>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   379
<para>
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   380
When the first two of these decisions are being made, nothing is known
139
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   381
about any changsets that might be pushed, and so all file and branch
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   382
conditions automatically succeed for the purpose of such decisions. For the
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   383
third condition, every file changed in the changeset must be allowed by a
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   384
<literal>write</literal> or <literal>init</literal> rule for the changeset
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   385
to be allowed.
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   386
</para>
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   387
<para>
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   388
This means that doing tricky things with file conditions can have
b7e78f9705e6 There are only three decisions, honest
Paul Crowley <paul@lshift.net>
parents: 138
diff changeset
   389
counterintuitive consequences:
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   390
</para>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   391
<itemizedlist>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   392
<listitem>
149
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   393
<para>You cannot limit read access to a subset of a repository with a <literal>read</literal>
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   394
rule and a file condition: any user who has access to a repository can read
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   395
all of it and its full history. Such a rule can only have the effect of
149
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   396
masking a later <literal>write</literal> rule, as in this example:</para>
144
2dbaddde1fd5 programlisting also needs no initial blank lines
Paul Crowley <paul@lshift.net>
parents: 143
diff changeset
   397
<programlisting>read repo=specialrepo file=dontwritethis
2dbaddde1fd5 programlisting also needs no initial blank lines
Paul Crowley <paul@lshift.net>
parents: 143
diff changeset
   398
write repo=specialrepo
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   399
</programlisting>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   400
<para>
149
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   401
allows all users to read <literal>specialrepo</literal>, and to write to all files
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   402
<emphasis>except</emphasis> that any changeset which writes to
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   403
<filename>dontwritethis</filename> will be rejected.
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   404
</para>
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   405
</listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   406
<listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   407
For similar reasons, don't give <literal>init</literal> rules file conditions.
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   408
</listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   409
<listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   410
<para>Don't try to deny write access to a particular file on a particular
149
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   411
branch&#x2014;a developer can write to the file on another branch and then merge
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   412
it in. Either deny all writes to the branch from that user, or allow them
149
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   413
to write to all the files they can write to on any branch.
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   414
</para>
144
2dbaddde1fd5 programlisting also needs no initial blank lines
Paul Crowley <paul@lshift.net>
parents: 143
diff changeset
   415
<programlisting>write user=docs/* branch=docs file=docs/*
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   416
</programlisting>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   417
<para>
149
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   418
This rule grants users whose keys are in the <filename
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   419
class='directory'>docs</filename> subdirectory the power to push changesets
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   420
into any repository only if those changesets are on the
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   421
<literal>docs</literal> branch and they affect only those files directly
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   422
under the <filename class='directory'>docs</filename> directory. However,
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   423
the rules below have more counterintuitive consequences.
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   424
</para>
144
2dbaddde1fd5 programlisting also needs no initial blank lines
Paul Crowley <paul@lshift.net>
parents: 143
diff changeset
   425
<programlisting>write user=docs/* branch=docs
2dbaddde1fd5 programlisting also needs no initial blank lines
Paul Crowley <paul@lshift.net>
parents: 143
diff changeset
   426
write user=docs/* file=docs/*
2dbaddde1fd5 programlisting also needs no initial blank lines
Paul Crowley <paul@lshift.net>
parents: 143
diff changeset
   427
read user=docs/*
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   428
</programlisting>
149
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   429
<para>
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   430
These rules grant users whose keys are in the <filename
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   431
class='directory'>docs</filename> subdirectory the power to change any file directly under the <filename class='directory'>docs</filename> directory, or any file at all in the <literal>docs</literal> branch.  Indirectly, however, this adds up to the power to change any file on any branch, simply by making the change on the docs branch and then merging the change into another branch.
dc4ed4edb458 Improvements to file conditions section
Paul Crowley <paul@lshift.net>
parents: 148
diff changeset
   432
</para>
121
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   433
</listitem>
62185dc7d0c9 Document file and branch conditions in Docbook
Paul Crowley <paul@lshift.net>
parents: 120
diff changeset
   434
</itemizedlist>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   435
</section>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   436
</section>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   437
<section>
263
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   438
<title>In detail</title>
252
75acaf1b1216 Add section on logging, merge later sections
Paul Crowley <paul@lshift.net>
parents: 238
diff changeset
   439
<section>
126
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   440
<title>How mercurial-server works</title>
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   441
<para>
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   442
All of the repositories controlled by mercurial-server are owned by a
151
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   443
single user, the <systemitem
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   444
class="username">hg</systemitem> user, which is why all URLs for
155
3bff97f72a33 ssh:// is the start of a URI
Paul Crowley <paul@lshift.net>
parents: 154
diff changeset
   445
mercurial-server repositories start with <uri>ssh://hg@...</uri>.
126
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   446
Each SSH key that has access to the repository has an entry in
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   447
<filename>~hg/.ssh/authorized_keys</filename>; this is how the SSH daemon
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   448
knows to give that key access. When the user connects over SSH, their
150
02b464a6b433 Improvements to how it works section
Paul Crowley <paul@lshift.net>
parents: 149
diff changeset
   449
commands are run in a custom restricted shell; this shell knows which key
02b464a6b433 Improvements to how it works section
Paul Crowley <paul@lshift.net>
parents: 149
diff changeset
   450
was used to connect, determines what the user is trying to do, checks the
02b464a6b433 Improvements to how it works section
Paul Crowley <paul@lshift.net>
parents: 149
diff changeset
   451
access rules to decide whether to allow it, and if allowed invokes
02b464a6b433 Improvements to how it works section
Paul Crowley <paul@lshift.net>
parents: 149
diff changeset
   452
Mercurial internally, without forking.
126
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   453
</para>
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   454
<para>
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   455
This restricted shell also ensures that certain Mercurial extensions are
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   456
loaded when the user acts on a repository; these extensions check the
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   457
access control rules for any changeset that the user tries to commit, and
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   458
log all pushes and pulls into a per-repository access log.
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   459
</para>
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   460
<para>
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   461
<command>refresh-auth</command> recurses through the <filename
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   462
class='directory'>/etc/mercurial-server/keys</filename> and the <filename
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   463
class='directory'>keys</filename> directory in the
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   464
<filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   465
class='directory'>hgadmin</filename> repository, creating an entry in
126
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   466
<filename>~hg/.ssh/authorized_keys</filename> for each one. This is redone
154
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   467
automatically whenever a change is pushed to <filename
45dac87ae794 Repository names are directories
Paul Crowley <paul@lshift.net>
parents: 153
diff changeset
   468
class='directory'>hgadmin</filename>.
126
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   469
</para>
263
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   470
</section>
126
fd7ebe95d8e5 Move how it works section later
Paul Crowley <paul@lshift.net>
parents: 125
diff changeset
   471
<section>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   472
<title>Security</title>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   473
<para>
151
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   474
mercurial-server relies entirely on <command>sshd</command> to grant access to remote users.
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   475
As a result, it runs no daemons, installs no setuid programs, and no part
151
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   476
of it runs as <systemitem
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   477
class="username">root</systemitem> except the install process: all programs run as the user
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   478
<systemitem
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   479
class="username">hg</systemitem>. Any attack on mercurial-server can only be started if the attacker
137
5bcd5a5e4220 Tweak security para
Paul Crowley <paul@lshift.net>
parents: 136
diff changeset
   480
already has a public key in <filename>~hg/.ssh/authorized_keys</filename>,
151
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   481
otherwise <command>sshd</command> will bar the way.
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   482
</para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   483
<para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   484
No matter what command the user tries to run on the remote system via SSH,
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   485
mercurial-server is run. It parses the command line the user asked for, and
151
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   486
interprets and runs the corresponding operation itself if access is
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   487
allowed, so users can only read and add to history within repositories;
151
5758cf47ff43 cleanups to the security section
Paul Crowley <paul@lshift.net>
parents: 150
diff changeset
   488
they cannot run any other command. In addition, every push and pull is
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   489
logged with a datestamp, changeset ID and the key that performed the
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   490
operation.
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   491
</para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   492
<para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   493
However, while the first paragraph holds no matter what bugs
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   494
mercurial-server contains, the second depends on the relevant code being
263
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   495
correct; though the entire codebase is short, like all software mercurial-server may harbour bugs. Backups are essential!
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   496
</para>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   497
</section>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   498
<section>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   499
<title>Logging</title>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   500
<para>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   501
Every successful access is logged in a file called
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   502
<filename>~hg/repos/<replaceable>repository</replaceable>/.hg/mercurial-server.log</filename>. This file is in YAML format for easy parsing, but if you don't like YAML, simply treat each line as a JSON data structure prepended with <code>- </code>. The log records the time as a
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   503
UTC ISO 8601 time, the operation ("push" or "pull"), the path to the key as
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   504
used in the access rules, the SSH connection information (including the source IP address), and the hex changeset IDs.
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   505
</para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   506
</section>
263
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   507
<section>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   508
<title>Paths and configuration</title>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   509
<para>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   510
For security reasons, all mercurial-server code runs as the <systemitem
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   511
class="username">hg</systemitem> user.  The first thing this code reads when it starts is <filename>~hg/.mercurial-server</filename>; if this file is absent or corrupt the code won't run.  This file specifies all of the file paths that mercurial-server uses.  In particular, it specifies that mercurial-server always uses <code>HGRCPATH = /etc/mercurial-server/remote-hgrc.d</code> for remote operations, overriding any system <code>HGRCPATH</code>.
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   512
</para>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   513
<para>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   514
By creating such a file with suitable entries, you can run mercurial-server as a user other than <systemitem
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   515
class="username">hg</systemitem>, or install it without root privileges; however I strongly recommend that if you need to do this, you use a user account that is used for no other purpose, and take the time to thoroughly understand how mercurial-server works before you attempt it.
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   516
</para>
345
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   517
<para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   518
At install time the following <filename>~hg/.mercurial-server</filename> file is used:
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   519
</para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   520
<programlisting># WARNING: a .mercurial-server file in your home directory means
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   521
# that refresh-auth can and will trash your ~/.ssh/authorized_keys file.
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   522
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   523
[paths]
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   524
repos = ~/repos
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   525
authorized_keys = ~/.ssh/authorized_keys
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   526
keys = /etc/mercurial-server/keys:~/repos/hgadmin/keys
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   527
access = /etc/mercurial-server/access.conf:~/repos/hgadmin/access.conf
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   528
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   529
[exceptions]
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   530
# Allow the creation of mq repositories by default
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   531
allowdots = .hg/patches
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   532
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   533
[env]
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   534
# Use a different hgrc for remote pulls - this way you can set
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   535
# up access.py for everything at once without affecting local operations
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   536
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   537
HGRCPATH = /etc/mercurial-server/remote-hgrc.d
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   538
</programlisting>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   539
<para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   540
The meaning of the entries are:
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   541
</para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   542
<itemizedlist>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   543
<listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   544
<para><literal>[paths]</literal></para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   545
<itemizedlist>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   546
<listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   547
<para><literal>repos</literal>: directory under which all repositories are
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   548
found. No remote user can reference any repo not under this directory.
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   549
Here and throughout this section, where a path begins with
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   550
<literal>~/</literal> the home directory is substituted - ie the
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   551
directory in which the <filename>.mercurial-server</filename> file
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   552
was found.</para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   553
</listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   554
<listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   555
<para><literal>authorized_keys</literal>: this is the file that will be rewritten
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   556
by refresh-auth, or whenever a checkin to the <literal>hgadmin</literal> repository is pushed.</para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   557
</listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   558
<listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   559
<para><literal>keys</literal>: directories to scan for keys when rewriting
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   560
<filename>authorized_keys</filename>.</para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   561
</listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   562
<listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   563
<para><literal>access</literal>: files to read to determine the access rules.
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   564
The files are effectively concatenated together in the order given.</para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   565
</listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   566
</itemizedlist>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   567
</listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   568
<listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   569
<para><literal>[exceptions]</literal></para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   570
<itemizedlist>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   571
<listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   572
<para><literal>allowdots</literal>: paths to allow even though they
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   573
begin with dots.  Dots at the start of a pathname component are
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   574
disallowed unless they exactly match one of the tails given in this
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   575
colon-separated list.  The given exception allows MQ repositories
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   576
to be pushed.</para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   577
</listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   578
</itemizedlist>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   579
</listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   580
<listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   581
<para><literal>[env]</literal>: all entries in here are added to the Unix environment
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   582
when users connect.  The keys are converted to all-upper-case. </para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   583
<itemizedlist>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   584
<listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   585
<para><literal>HGRCPATH</literal>: set the path that Mercurial uses to search for
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   586
configuration files.  At install time config files are placed on this path
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   587
which set up access control and logging.</para>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   588
</listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   589
</itemizedlist>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   590
</listitem>
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   591
</itemizedlist>
252
75acaf1b1216 Add section on logging, merge later sections
Paul Crowley <paul@lshift.net>
parents: 238
diff changeset
   592
</section>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   593
<section>
263
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   594
<title>License</title>
129
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   595
<para>
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   596
This program is free software; you can redistribute it and/or modify it
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   597
under the terms of the GNU General Public License as published by the Free
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   598
Software Foundation; either version 2 of the License, or (at your option)
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   599
any later version.
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   600
</para>
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   601
<para>
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   602
This program is distributed in the hope that it will be useful, but
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   603
WITHOUT ANY WARRANTY; without even the implied warranty of MERCHANTABILITY
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   604
or FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License for
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   605
more details.
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   606
</para>
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   607
<para>
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   608
You should have received a copy of the GNU General Public License along
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   609
with this program; if not, write to the Free Software Foundation, Inc., 51
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   610
Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
4d261ae3ba4f move legalese to the bottom
Paul Crowley <paul@lshift.net>
parents: 128
diff changeset
   611
</para>
263
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   612
</section>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   613
<section>
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   614
<title>Thanks</title>
120
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   615
<para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   616
Thanks for reading this far. If you use mercurial-server, please tell me about
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   617
it.
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   618
</para>
16056a9015f3 Huge update to docbook docs
Paul Crowley <paul@lshift.net>
parents: 119
diff changeset
   619
<para>
345
f06d9816272d Documentation update
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
   620
Paul Crowley, <email>paul@lshift.net</email>, 2011
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   621
</para>
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   622
</section>
263
9f7ad3a71c90 Bump version number to 1.1; big documentation update; correct dates;
Paul Crowley <paul@lshift.net>
parents: 252
diff changeset
   623
</section>
119
40a287c95661 Start work on a docbook manual
Paul Crowley <paul@lshift.net>
parents:
diff changeset
   624
</article>