kallithea Files · docs/usage/locking.rst

Files @ 06d5c043e989

Branch filter:

Location: kallithea/docs/usage/locking.rst

06d5c043e989 1.1 KiB text/prs.fallenstein.rst Show Annotation Show as Raw Download as Raw

Mads Kiilerich

ini: add scripts/generate-ini.py for generating all .ini files from template.ini.mako

Based on kallithea/bin/template.ini.mako, generate
kallithea/config/deployment.ini_tmpl
development.ini
kallithea/tests/test.ini

The script might not be pretty, but it works for the given input, and all
changes in output will be reviewed thoroughly anyway ...

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