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