kallithea Files · docs/usage/locking.rst

Files @ 79fd9b50bd3e

Branch filter:

Location: kallithea/docs/usage/locking.rst

79fd9b50bd3e 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

domruf

db_manage: remove create_ui_settings method

We already have a loop for adding Ui entries, so why not handle the hook entries
there as well?!
This is also much easier to read.
create_settings is only called from setup_db so querying for existing settings
makes no sense.

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