Class WebStatus

Run a web server that provides Buildbot status.

Parameters:

• http_port (int or twisted.application.strports string) - a strports specification describing which port the buildbot should use for its web server, with the Waterfall display as the root page. For backwards compatibility this can also be an int. Use 'tcp:8000' to listen on that port, or 'tcp:12345:interface=127.0.0.1' if you only want local processes to connect to it (perhaps because you are using an HTTP reverse proxy to make the buildbot available to the outside world, and do not want to make the raw port visible).
• distrib_port (int or twisted.application.strports string) - Use this if you want to publish the Waterfall page using web.distrib instead. The most common case is to provide a string that is an absolute pathname to the unix socket on which the publisher should listen (os.path.expanduser(~/.twistd-web-pb) will match the default settings of a standard twisted.web 'personal web server'). Another possibility is to pass an integer, which means the publisher should listen on a TCP socket, allowing the web server to be on a different machine entirely. Both forms are provided for backwards compatibility; the preferred form is a strports specification like 'unix:/home/buildbot/.twistd-web-pb'. Providing a non-absolute pathname will probably confuse the strports parser.
• allowForce - boolean, if True then the webserver will allow visitors to trigger and cancel builds
• public_html - the path to the public_html directory for this display, either absolute or relative to the basedir. The default is 'public_html', which selects BASEDIR/public_html.
• site (None or twisted.web.server.Site) - Use this if you want to define your own object instead of using the default.`
• numbuilds (int) - Default number of entries in lists at the /one_line_per_build and /builders/FOO URLs. This default can be overriden both programatically --- by passing the equally named argument to constructors of OneLinePerBuildOneBuilder and OneLinePerBuild --- and via the UI, by tacking ?numbuilds=xy onto the URL.
• num_events (int) - Defaualt number of events to show in the waterfall.
• num_events_max (int) - The maximum number of events that are allowed to be shown in the waterfall. The default value of None will disable this check
• auth (a status.web.auth.IAuth or None) - an object that performs authentication to restrict access to the allowForce features. Ignored if allowForce is not True. If auth is None, people can force or stop builds without auth.
• order_console_by_time (bool) - Whether to order changes (commits) in the console view according to the time they were created (for VCS like Git) or according to their integer revision numbers (for VCS like SVN).

Overrides: twisted.application.service.MultiService.__init__

Overrides: twisted.application.service.Service.setServiceParent

Overrides: twisted.application.service.Service.stopService

Check that user/passwd is a valid user/pass tuple and can should be allowed to perform the action. If this WebStatus is not password protected, this function returns False.

__implemented__

Value:

<implementedBy buildbot.status.web.baseweb.WebStatus>

__provides__

Value:

<zope.interface.declarations.ClassProvides object at 0x1ad2fd0>