https://github.com/tv42/gitosis

software for hosting git repositories
https://github.com/tv42/gitosis

Last synced: about 4 hours ago
JSON representation

software for hosting git repositories

• Host: GitHub
• URL: https://github.com/tv42/gitosis
• Owner: tv42
• License: gpl-2.0
• Created: 2010-12-02T16:45:59.000Z (about 14 years ago)
• Default Branch: master
• Last Pushed: 2021-10-31T11:14:20.000Z (about 3 years ago)
• Last Synced: 2024-12-15T14:08:16.026Z (7 days ago)
• Language: Python
• Homepage:
• Size: 320 KB
• Stars: 414
• Watchers: 32
• Forks: 99
• Open Issues: 9
• Metadata Files:
  • Readme: README.rst
  • License: COPYING

Awesome Lists containing this project

README

        
==========================================================

 ``gitosis`` -- software for hosting ``git`` repositories

==========================================================

	Manage ``git`` repositories, provide access to them over SSH,

	with tight access control and not needing shell accounts.

.. note::

	Documentation is still lacking, and non-default configurations

	(e.g. config file, repositories, installing in a location that

	is not in ``PATH``) basically have not been tested at all.

	Basic usage should be very reliable -- the project has been

	hosting itself for a long time. Any help is welcome.

``gitosis`` aims to make hosting ``git`` repos easier and safer. It

manages multiple repositories under one user account, using SSH keys

to identify users. End users do not need shell accounts on the server,

they will talk to one shared account that will not let them run

arbitrary commands.

``gitosis`` is licensed under the GPL, see the file ``COPYING`` for

more information.

You can get ``gitosis`` via ``git`` by saying::

    git clone https://github.com/tv42/gitosis.git

And install it via::

    python setup.py install

Though you may want to use e.g. ``--prefix=``.

Setting up

==========

First, we will create the user that will own the repositories. This is

usually called ``git``, but any name will work, and you can have more

than one per system if you really want to. The user does not need a

password, but does need a valid shell (otherwise, SSH will refuse to

work). Don't use an existing account unless you know what you're

doing.

I usually store ``git`` repositories in the subtree

``/srv/example.com/git`` (replace ``example.com`` with your own

domain). You may choose another location. Adjust to suit and run::

	sudo adduser \

	    --system \

	    --shell /bin/sh \

	    --gecos 'git version control' \

	    --group \

	    --disabled-password \

	    --home /srv/example.com/git \

	    git

This command is known to work in Debian and Ubuntu. Your mileage may

vary.

You will need an SSH public key to continue. If you don't have one,

you need to generate one. See the man page for ``ssh-keygen``, and you

may also be interested in ``ssh-agent``. Create it on your personal

computer, and protect the *private* key well -- that includes not

transferring it over the network.

Next, we need to set things up for this newly-created user. The

following command will create a ``~/repositories`` that will hold the

``git`` repositories, a ``~/.gitosis.conf`` that will be a symlink to

the actual configuration file, and it will add the SSH public key to

``~/.ssh/authorized_keys`` with a ``command=`` option that restricts

it to running ``gitosis-serve``. Run::

	sudo -H -u git gitosis-init