view docs/usage/locking.rst @ 5981:3fff45b4c8ed

tests: set EMAIL for Git commit test_push_on_locked_repo_by_other_user_git - it _is_ necessary on some machines 7db1bcf1d95b too aggressively removed setting EMAIL (which was set in a way that didn't work on Windows). On some machines the git commit in _add_files_and_push would fail with 'Please tell me who you are' and the actual test check of "Repository %s locked by user" would fail. On other machines - also without any local git configuration - it works fine. https://git-scm.com/book/en/v2/Git-Internals-Environment-Variables#Committing suggests that it might be a good idea to set it ... so let's do it. (Patch modified by Mads Kiilerich)
author domruf <dominikruf@gmail.com>
date Thu, 16 Jun 2016 23:33:36 +0200
parents 5ae8e644aa88
children
line wrap: on
line source

.. _locking:

==================
Repository locking
==================

Kallithea has a *repository locking* feature, disabled by default. When
enabled, every initial clone and every pull gives users (with write permission)
the exclusive right to do a push.

When repository locking is enabled, repositories get a ``locked`` flag.
The hg/git commands ``hg/git clone``, ``hg/git pull``,
and ``hg/git push`` influence this state:

- A ``clone`` or ``pull`` action locks the target repository
  if the user has write/admin permissions on this repository.

- Kallithea will remember the user who locked the repository so only this
  specific user can unlock the repo by performing a ``push``
  command.

- Every other command on a locked repository from this user and every command
  from any other user will result in an HTTP return code 423 (Locked).
  Additionally, the HTTP error will mention the user that locked the repository
  (e.g., “repository <repo> locked by user <user>”).

Each repository can be manually unlocked by an administrator from the
repository settings menu.