kallithea Files · docs/usage/locking.rst

Files @ 67e561f832b2

Branch filter:

Location: kallithea/docs/usage/locking.rst

67e561f832b2 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

email templates: align word to indicate branches: at / branch

Some email templates use '<repo> at <branch>' while others use
'<repo> branch <branch>'. Interestingly even some txt templates use one and
the corresponding HTML template uses the other.

This commit aligns all uses of 'at' and 'branch' to 'branch' as it is
considered more expressive.
The other choice would also be possible, as long as all users are
aligned.

.. _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.