kallithea Files · docs/usage/locking.rst

Files @ 6e75963503cc

Branch filter:

Location: kallithea/docs/usage/locking.rst

6e75963503cc 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Thomas De Schampheleire

admin: auth: make sure list of auth modules is consistent

When authentication modules are enabled, but fail to be enabled e.g. due to
missing dependencies (pam, ldap), the list of enabled plugins still contains
the failing module. However, the 'Enabled/Disabled' button correctly shows
Disabled, causing a mismatch between both.

Worse, the mismatch cannot be corrected by clicking the Enabled/Disabled
button, one needs to manually clear the problematic entry in the list of
enabled plugins.

Fix by always populating the list with the actually enabled plugins, not
those requested by the user in case there are failures.

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