kallithea Files · docs/usage/locking.rst

Files @ 1f05cf31ec0d

Branch filter:

Location: kallithea/docs/usage/locking.rst

1f05cf31ec0d 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Mads Kiilerich

permissions: clarify the use of "Permissions" - use "Show Permissions" for the overview

53d6a64ce4f3 wasn't enough.

Pages for editing permissions for a subject are always just called
"Permissions".

Now, pages summarizing the actual permissions to objects are generally named
"Show Permissions".

This is especially important for User Groups which have both settings and where
"Default permissions" just is wrong.

.. _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`` state that
can be true or false.  The hg/git commands ``hg/git clone``, ``hg/git pull``,
and ``hg/git push`` influence this state:

- A ``clone`` or ``pull`` action on the repository locks it (``locked=true``)
  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 (``locked=false``) 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 includes 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.