kallithea Files · docs/usage/locking.rst

Files @ 5dde581f703f

Branch filter:

Location: kallithea/docs/usage/locking.rst

5dde581f703f 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Mads Kiilerich

scripts: add update-copyrights.py

This script will automate how the current attribution and copyright listings
are generated, thus also enabling it to be maintained from repository history
in the future.

This doesn't change anything about who has or hasn't contributed or deserves
credit, it just does a best effort attempt at maintaining existing attribution
we inherited and automating it going forward. The automation might expose
existing problems - they should be fixed by adding or removing exceptions in
the script.

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