Files @ 92b4b392b0df
Branch filter:

Location: kallithea/docs/usage/locking.rst - annotation

92b4b392b0df 1.1 KiB text/prs.fallenstein.rst Show Source Show as Raw Download as Raw
Søren Løvborg
db: remove redundant unique constraints from primary keys

Primary keys are always unique, both in the SQL standard and in SQLite,
MySQL and PostgreSQL.

Setting unique=True cases SQLAlchemy to explicitly add additional,
redundant UNIQUE indexes to the columns, which is at best needless
metadata overhead, and at worst causes the database engine to waste
time maintaining an extra index that serves no purpose.
.. _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.