README.md
author David Ireland <david@lshift.net>
Mon, 22 Dec 2014 09:07:48 +0000
branchphases
changeset 370 aea2b3c90605
parent 369 c359a85eef93
permissions -rw-r--r--
Adding branch for phases
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
369
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
     1
# mercurial-server
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
     2
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
     3
mercurial-server gives your developers remote read/write access to
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
     4
centralized Mercurial repositories using SSH public key authentication; it
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
     5
provides convenient and fine-grained key management and access control.
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
     6
It was written by Paul Crowley at LShift Ltd.
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
     7
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
     8
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
     9
## Installing
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    10
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    11
Though mercurial-server is currently targeted at Debian-based systems such
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    12
as Ubuntu, other users have reported success getting it running on other
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    13
Unix-based systems such as Red Hat. Running it on a non-Unix system such as
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    14
Windows is not supported. You will need root privileges to install it.
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    15
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    16
The best way to install mercurial-server is using your package management
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    17
system - there are pre-built .deb files on the website. However, there is
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    18
some provision for installing it directly. On Debian based systems such as
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    19
Ubuntu, use the command
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    20
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    21
    sudo make setup-adduser
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    22
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    23
On Red Hat and possibly other variants of Unix, try
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    24
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    25
    sudo make setup-useradd
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    26
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    27
See doc/manual.docbook for the rest of the documentation.
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    28
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    29
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    30
## License
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    31
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    32
Copyright (C) 2008-2012 LShift Ltd.
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    33
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    34
    This program is free software; you can redistribute it and/or modify
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    35
    it under the terms of the GNU General Public License as published by
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    36
    the Free Software Foundation; either version 2 of the License, or
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    37
    (at your option) any later version.
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    38
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    39
    This program is distributed in the hope that it will be useful,
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    40
    but WITHOUT ANY WARRANTY; without even the implied warranty of
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    41
    MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    42
    GNU General Public License for more details.
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    43
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    44
    You should have received a copy of the GNU General Public License along
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    45
    with this program; if not, write to the Free Software Foundation, Inc.,
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    46
    51 Franklin Street, Fifth Floor, Boston, MA 02110-1301 USA.
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    47
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    48
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    49
## More info
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    50
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    51
Please see [the website](http://www.lshift.net/mercurial-server.html) or
c359a85eef93 README.md edited online with Bitbucket
Ashley Hewson <ash@lshift.net>
parents: 368
diff changeset
    52
[contact us](mailto:opensource@lshift.net).