User:Jpr@uab.edu/DocsBotCookbook - Revision history

Jpr@uab.edu: /* Anatomy of a Bot */ Break login discussion into new subsection Bot Operations

2012-02-24T18:42:22Z

Anatomy of a Bot: Break login discussion into new subsection Bot Operations

← Older revision		Revision as of 18:42, 24 February 2012
Line 14:		Line 14:
	The enter Bot page can useful info to any project from the perspective of general project rules. Make sure to also read the last section on programming languages just to make sure to have a good context for future background thought. There are libraries for a number of popular development languages and platforms.		The enter Bot page can useful info to any project from the perspective of general project rules. Make sure to also read the last section on programming languages just to make sure to have a good context for future background thought. There are libraries for a number of popular development languages and platforms.

	* [[wikipedia:Wikipedia:Creating_a_bot#Logging_in\|Bot ~~Login]]~~		== Bot Operations ==

	The ~~login~~ section highlights what will need support on docs. A bot typically uses a traditional user/password account on Mediwiki. This won't work so well with our default SAML web-browser profile, since that favors human interactive users. It shouldn't be difficult for us to support user/password bot accounts, and would be interesting to have those traveling across a client-authenticated SSL connection. That would allow us to know who the (human) person is running the bot and allow for normal bot login-handshaking using the bot account method.		=== Login ===

			The [[wikipedia:Wikipedia:Creating_a_bot#Logging_in\|Bot Login]] section highlights what will need support on docs. A bot typically uses a traditional user/password account on Mediwiki. This won't work so well with our default SAML web-browser profile, since that favors human interactive users. It shouldn't be difficult for us to support user/password bot accounts, and would be interesting to have those traveling across a client-authenticated SSL connection. That would allow us to know who the (human) person is running the bot and allow for normal bot login-handshaking using the bot account method.

	In other words, this wouldn't demand SSO or account coordination between Apache and Mediawiki. Apache just does a client-auth'd SSL handshake and validates the user DN against our account database. This happens just as part of connection establishment and is just an easy way of providing "login" accounting. The bot work still takes place explicitly under a bot account for that specfic mediawiki instance. The SSL channel also makes it possible to support proxy-certs for delegation to the bot. This model also works for a large number of other tools and avoids us having to do much integration work aside from configuring Apache for ssl-auth in particular areas of the URL namespace.		In other words, this wouldn't demand SSO or account coordination between Apache and Mediawiki. Apache just does a client-auth'd SSL handshake and validates the user DN against our account database. This happens just as part of connection establishment and is just an easy way of providing "login" accounting. The bot work still takes place explicitly under a bot account for that specfic mediawiki instance. The SSL channel also makes it possible to support proxy-certs for delegation to the bot. This model also works for a large number of other tools and avoids us having to do much integration work aside from configuring Apache for ssl-auth in particular areas of the URL namespace.

Jpr@uab.edu: /* Anatomy of a Bot */ Thoughts on supporting bot login

2012-02-24T18:40:38Z

Anatomy of a Bot: Thoughts on supporting bot login

← Older revision		Revision as of 18:40, 24 February 2012
Line 13:		Line 13:

	The enter Bot page can useful info to any project from the perspective of general project rules. Make sure to also read the last section on programming languages just to make sure to have a good context for future background thought. There are libraries for a number of popular development languages and platforms.		The enter Bot page can useful info to any project from the perspective of general project rules. Make sure to also read the last section on programming languages just to make sure to have a good context for future background thought. There are libraries for a number of popular development languages and platforms.

			* [[wikipedia:Wikipedia:Creating_a_bot#Logging_in\|Bot Login]]

			The login section highlights what will need support on docs. A bot typically uses a traditional user/password account on Mediwiki. This won't work so well with our default SAML web-browser profile, since that favors human interactive users. It shouldn't be difficult for us to support user/password bot accounts, and would be interesting to have those traveling across a client-authenticated SSL connection. That would allow us to know who the (human) person is running the bot and allow for normal bot login-handshaking using the bot account method.

			In other words, this wouldn't demand SSO or account coordination between Apache and Mediawiki. Apache just does a client-auth'd SSL handshake and validates the user DN against our account database. This happens just as part of connection establishment and is just an easy way of providing "login" accounting. The bot work still takes place explicitly under a bot account for that specfic mediawiki instance. The SSL channel also makes it possible to support proxy-certs for delegation to the bot. This model also works for a large number of other tools and avoids us having to do much integration work aside from configuring Apache for ssl-auth in particular areas of the URL namespace.

	== Development Tools ==		== Development Tools ==

Jpr@uab.edu: Add Dev section and link to perl command line client

2012-02-24T18:27:10Z

Add Dev section and link to perl command line client

← Older revision		Revision as of 18:27, 24 February 2012
Line 13:		Line 13:

	The enter Bot page can useful info to any project from the perspective of general project rules. Make sure to also read the last section on programming languages just to make sure to have a good context for future background thought. There are libraries for a number of popular development languages and platforms.		The enter Bot page can useful info to any project from the perspective of general project rules. Make sure to also read the last section on programming languages just to make sure to have a good context for future background thought. There are libraries for a number of popular development languages and platforms.

			== Development Tools ==

			Among that more appealing developer APIs for mediawiki are the ones for perl, python, scheme and lisp.

			=== CVS-like Command-line client ===

			The Perl-based [http://search.cpan.org/~markj/WWW-Mediawiki-Client-0.31/lib/WWW/Mediawiki/Client.pm Mediawiki-Client] looks like an interesting tool for building hooks because it exposes a command-line interface and is promoted as having a CVS-like feel.

	== Useful Existing Bots ==		== Useful Existing Bots ==

Jpr@uab.edu: /* Anatomy of a Bot */ Add link to dev process overview and closing comments

2012-02-24T18:23:31Z

Anatomy of a Bot: Add link to dev process overview and closing comments

← Older revision		Revision as of 18:23, 24 February 2012
Line 10:		Line 10:
	* [[wikipedia:Wikipedia:Creating_a_bot#Considerations_before_creating_a_bot\|Considerations before getting started]]		* [[wikipedia:Wikipedia:Creating_a_bot#Considerations_before_creating_a_bot\|Considerations before getting started]]
	* [[wikipedia:Wikipedia:Creating_a_bot#Overview_of_operation\|Operation overview]]		* [[wikipedia:Wikipedia:Creating_a_bot#Overview_of_operation\|Operation overview]]
			* [[wikipedia:Wikipedia:Creating_a_bot#Overview_of_the_process_of_developing_a_bot\|Overview of Developing a Bot]]

			The enter Bot page can useful info to any project from the perspective of general project rules. Make sure to also read the last section on programming languages just to make sure to have a good context for future background thought. There are libraries for a number of popular development languages and platforms.

	== Useful Existing Bots ==		== Useful Existing Bots ==

Jpr@uab.edu: Initial notes on Mediawiki Bots and how to read their documentation

2012-02-24T17:24:16Z

Initial notes on Mediawiki Bots and how to read their documentation

New page

Writing bots for docs is for finding and writing information.

Some things to get started.

== Anatomy of a Bot ==

Everything has an anatomy and bots are no different. If you want them to help you, you need to understand what makes them tick. The [[wikipedia:Wikipedia:Creating_a_bot|Creating a bot]] page give a good overview. To get a starting context, make sure you read:

* [[wikipedia:Wikipedia:Creating_a_bot#Why_would_I_need_to_create_a_bot.3F|Reasons for Bots]]
* [[wikipedia:Wikipedia:Creating_a_bot#Considerations_before_creating_a_bot|Considerations before getting started]]
* [[wikipedia:Wikipedia:Creating_a_bot#Overview_of_operation|Operation overview]]

== Useful Existing Bots ==

There's already a lot of work in this space and some tools are designed to be generally helpful, like edit assitors.

=== AutoWikiBot ===

The [[wikipedia:Wikipedia:AutoWikiBrowser|AutoWikiBrowser]] bot is a mediawiki editor for windows that is designed to ease editing tasks. It looks interesting but it's possible our default config for authn on docs will make tools like this harder to use since our log in is not by user/pass. If it supports ssl auth then it's awesome. Otherwise something else woudl need to be done to support tools like this.

[[Category:Cookbook]]