kallithea Files · docs/usage/locking.rst

Files @ b374803eafb6

Branch filter:

Location: kallithea/docs/usage/locking.rst

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

domruf

MANIFEST: only include bootstrap from node_modules when packaging or installing

With the 'less' source folder placed under 'public', the whole folder happened
to be fully included in source distribution and installed. *If* 'npm install'
has been run, 'kallithea/public/less/node_modules/' will contain both
build/development tools ('less' and dependencies) and the source of Bootstrap.

We do want Bootstrap source to be included so it automatically gets 'vendored',
but we don't want all the build tools.

We thus prune the whole 'node_modules' directory, but add
'node_modules/bootstrap' back in.

This is exactly what it is. It might seem a bit fragile: There is no
verification that it only is the 'bootstrap' directory that should be added
back in, and there is no verification that it actually is present and included.

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