README.md
author Ashley Hewson <ash@lshift.net>
Wed, 23 Jul 2014 15:30:49 +0100
changeset 368 52bf7edf46ba
parent 357 README@bd8b83417548
child 369 c359a85eef93
permissions -rw-r--r--
update README
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
368
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
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.
368
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
     6
It was written by Paul Crowley at LShift Ltd.
82
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
     7
2
a69f7bea408c added a README to describe how this works.
Paul Crowley <paul@lshift.net>
parents:
diff changeset
     8
368
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
     9
## Installing
82
7369ff737684 License properly
Paul Crowley <paul@lshift.net>
parents: 81
diff changeset
    10
185
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
    11
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
    12
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
    13
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
    14
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
    15
185
f8f8b4018381 Remove all installation talk from docbook
Paul Crowley <paul@lshift.net>
parents: 170
diff changeset
    16
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
    17
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
    18
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
    19
Ubuntu, use the command
170
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    20
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    21
    sudo make setup-adduser
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    22
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    23
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
    24
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    25
    sudo make setup-useradd
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    26
0f5e30c85fc3 Update README to cover using the makefile
Paul Crowley <paul@lshift.net>
parents: 163
diff changeset
    27
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
    28
368
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    29
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    30
## License
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    31
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    32
Copyright (C) 2008-2012 LShift Ltd.
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    33
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    34
    This program is free software; you can redistribute it and/or modify
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    35
    it under the terms of the GNU General Public License as published by
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    36
    the Free Software Foundation; either version 2 of the License, or
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    37
    (at your option) any later version.
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    38
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    39
    This program is distributed in the hope that it will be useful,
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    40
    but WITHOUT ANY WARRANTY; without even the implied warranty of
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    41
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    42
    GNU General Public License for more details.
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    43
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    44
    You should have received a copy of the GNU General Public License along
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    45
    with this program; if not, write to the Free Software Foundation, Inc.,
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    46
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    47
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    48
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    49
## More info
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    50
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    51
Please see [the website] (http://www.lshift.net/mercurial-server.html) or
52bf7edf46ba update README
Ashley Hewson <ash@lshift.net>
parents: 357
diff changeset
    52
[contact us] (mailto:opensource@lshift.net).