kallithea Files · docs/usage/locking.rst

Files @ 013796b2c861

Branch filter:

Location: kallithea/docs/usage/locking.rst

013796b2c861 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

lib: BaseRepoController: use webob.exc.HTTPNotFound if possible

In the entire code base, the use of 'paste' is very limited.
In particular, 'paste.httpexceptions' is only still used in lib/base.py, in
three occurrences:
- two of them in class BasicAuth which derives from paste.auth.something.
Here it probably makes sense to use paste.httpexceptions.
- one in BaseRepoController, which has no specific relation to paste. This
occurrence can be replaced with webob.exc like in the rest of the code
base.

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