README
author Paul Crowley <paul@lshift.net>
Wed, 07 Sep 2011 11:44:31 +0100
changeset 331 aeafdd709c02
parent 324 36400dcefb67
child 350 bb7ee0a13ea9
child 357 bd8b83417548
permissions -rw-r--r--
Update NEWS and release checklists to reflect new way
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
36
b3237aabd0fe Change the name to mercurial-server
Paul Crowley <paul@lshift.net>
parents: 30
diff changeset
     1
mercurial-server
2
a69f7bea408c added a README to describe how this works.
Paul Crowley <paul@lshift.net>
parents:
diff changeset
     2
185
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
     3
mercurial-server gives your developers remote read/write access to
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
     4
centralized Mercurial repositories using SSH public key authentication; it
311
3cbde66305e4 Fix white space
Paul Crowley <paul@lshift.net>
parents: 263
diff changeset
     5
provides convenient and fine-grained key management and access control.
2
a69f7bea408c added a README to describe how this works.
Paul Crowley <paul@lshift.net>
parents:
diff changeset
     6
101
8b4cdc066967 Link to new mercurial-server website in README
Paul Crowley <paul@lshift.net>
parents: 100
diff changeset
     7
http://www.lshift.net/mercurial-server.html
82
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
     8
324
36400dcefb67 Update year in README, add to release checklist
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
     9
Copyright (C) 2008-2011 LShift Ltd.
82
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    10
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    11
    This program is free software; you can redistribute it and/or modify
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    12
    it under the terms of the GNU General Public License as published by
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    13
    the Free Software Foundation; either version 2 of the License, or
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    14
    (at your option) any later version.
2
a69f7bea408c added a README to describe how this works.
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    15
82
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    16
    This program is distributed in the hope that it will be useful,
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    17
    but WITHOUT ANY WARRANTY; without even the implied warranty of
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    18
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    19
    GNU General Public License for more details.
2
a69f7bea408c added a README to describe how this works.
Paul Crowley <paul@lshift.net>
parents:
diff changeset
    20
82
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    21
    You should have received a copy of the GNU General Public License along
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    22
    with this program; if not, write to the Free Software Foundation, Inc.,
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    23
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    24
185
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
    25
Though mercurial-server is currently targeted at Debian-based systems such
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
    26
as Ubuntu, other users have reported success getting it running on other
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
    27
Unix-based systems such as Red Hat. Running it on a non-Unix system such as
311
3cbde66305e4 Fix white space
Paul Crowley <paul@lshift.net>
parents: 263
diff changeset
    28
Windows is not supported. You will need root privileges to install it.
170
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    29
185
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
    30
The best way to install mercurial-server is using your package management
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
    31
system - there are pre-built .deb files on the website. However, there is
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
    32
some provision for installing it directly. On Debian based systems such as
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
    33
Ubuntu, use the command
170
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    34
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    35
    sudo make setup-adduser
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    36
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    37
On Red Hat and possibly other variants of Unix, try
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    38
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    39
    sudo make setup-useradd
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    40
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    41
See doc/manual.docbook for the rest of the documentation.
18
538d6b198f4a Big change to support file conditions; format of hg-ssh-access.conf
Paul Crowley <paul@lshift.net>
parents: 15
diff changeset
    42
324
36400dcefb67 Update year in README, add to release checklist
Paul Crowley <paul@lshift.net>
parents: 311
diff changeset
    43
Paul Crowley, paul@lshift.net, 2011