Manual:Bot passwords: Difference between revisions

Content deleted Content added

Inline

Latest revision as of 08:58, 18 May 2024

MediaWiki version:

≥ 1.27

Bot passwords allow applications or bots to log in with a simple username-password combination even if the wiki employs some extra authorization steps that the bot framework could not handle; they also allow limiting the permissions given to the bot (e.g. the bot might be allowed to edit articles but not to create new ones). Clients using bot passwords can only access the API, not the normal web interface. The functionality is roughly equivalent to what some other sites like Google call "app passwords".

New bot passwords can be created and existing ones managed via Special:BotPasswords. Login happens via the login API module. When the user’s real password changes, bot passwords will not work until they’re reset; Special:BotPasswords will show a warning on each password that hasn’t been reset yet.

This is a simpler alternative to OAuth, meant for bots which do not support that. If the wiki and the bot support OAuth, use that instead; it is more secure, especially on wikis without robust HTTPS support.

See also[edit]

Related task and commit

task T121113 → Gerrit change 259066

Related configuration parameters

$wgEnableBotPasswords – Whether to enable bot passwords
$wgBotPasswordsCluster – Cluster name for the "bot_passwords" table
$wgBotPasswordsDatabase – Database name for the "bot_passwords" table

Database table

bot_passwords

Classes

BotPassword

@@ Line 16: / Line 16: @@
 </translate>
 '''<translate><!--T:10--> Related task and commit</translate>'''
+* {{Phabricator|T121113}} → {{gerrit|259066}}
-* 12345
-* → 12345
-*
 '''<translate><!--T:11--> Related configuration parameters</translate>'''
+* <code>{{ll|Manual:$wgEnableBotPasswords|$wgEnableBotPasswords}}</code> – <translate><!--T:12--> Whether to enable bot passwords</translate>
-* 12345
-* – <translate><!--T:12--> Whether to enable bot passwords</translate>
+* <code>{{ll|Manual:$wgBotPasswordsCluster|$wgBotPasswordsCluster}}</code> – <translate><!--T:13--> Cluster name for the "<tvar name=1>bot_passwords</tvar>" table</translate>
+* <code>{{ll|Manual:$wgBotPasswordsDatabase|$wgBotPasswordsDatabase}}</code> – <translate><!--T:14--> Database name for the "<tvar name=1>bot_passwords</tvar>" table</translate>
-* 12345
-* – <translate><!--T:13--> Cluster name for the "<tvar name="1">bot_passwords</tvar>" table</translate>
-* 12345
-* – <translate><!--T:14--> Database name for the "<tvar name="1">bot_passwords</tvar>" table</translate>
 '''<translate><!--T:15--> Database table</translate>'''
+* <code>{{ll|Manual:Bot passwords table|bot_passwords}}</code>
-* 12345
-* 12345
-*
 '''<translate><!--T:16--> Classes</translate>'''
+* {{class doclink|BotPassword}}
-* 12345
-*
 [[Category:Authentication and login{{#translation:}}]]