Files
@ a45113998d07
Branch filter:
Location: kallithea/docs/usage/locking.rst - annotation
a45113998d07
1.1 KiB
text/prs.fallenstein.rst
AuthSettingsController: assume 'auth_plugins' option exists
In formglobals, the provided 'auth_plugins' default value is always
replaced with the real database value, returned along with other
plugin settings by Setting.get_auth_settings.
We can safely assume that the database value exists, since not only does
db_manage initialize the 'auth_plugins' option upon database creation,
but other authentication modules already assume its existence.
For instance, Settings.get_auth_plugins() is equivalent to
Settings.get_auth_settings()['auth_plugins']
except that get_auth_plugins will throw AttributeError, not KeyError,
if the 'auth_plugins' key does not exist in the database.
In formglobals, the provided 'auth_plugins' default value is always
replaced with the real database value, returned along with other
plugin settings by Setting.get_auth_settings.
We can safely assume that the database value exists, since not only does
db_manage initialize the 'auth_plugins' option upon database creation,
but other authentication modules already assume its existence.
For instance, Settings.get_auth_plugins() is equivalent to
Settings.get_auth_settings()['auth_plugins']
except that get_auth_plugins will throw AttributeError, not KeyError,
if the 'auth_plugins' key does not exist in the database.
aa17c7a1b8a5 aa17c7a1b8a5 8d065db04909 8d065db04909 8d065db04909 aa17c7a1b8a5 8d065db04909 8d065db04909 03bbd33bc084 03bbd33bc084 8d065db04909 8d065db04909 8d065db04909 aa17c7a1b8a5 8d065db04909 8d065db04909 aa17c7a1b8a5 8d065db04909 8d065db04909 8d065db04909 aa17c7a1b8a5 8d065db04909 8d065db04909 8d065db04909 8d065db04909 aa17c7a1b8a5 8d065db04909 8d065db04909 | .. _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.
|