Class WebStatus

Run a web server that provides Buildbot status.

@type  http_port: int or L{twisted.application.strports} string
@param http_port: 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).

@type  distrib_port: int or L{twisted.application.strports} string
@param distrib_port: 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
                     (C{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.

@param allowForce: deprecated; use authz instead
@param auth: deprecated; use with authz

@param authz: a buildbot.status.web.authz.Authz instance giving the authorization
                   parameters for this view

@param 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.

@type site: None or L{twisted.web.server.Site}
@param site: Use this if you want to define your own object instead of
             using the default.`

@type numbuilds: int
@param numbuilds: 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.

@type num_events: int
@param num_events: Default number of events to show in the waterfall.

@type num_events_max: int
@param num_events_max: The maximum number of events that are allowed to be
shown in the waterfall.  The default value of C{None} will disable this
check

@type auth: a L{status.web.auth.IAuth} or C{None}
@param auth: an object that performs authentication to restrict access
             to the C{allowForce} features. Ignored if C{allowForce}
             is not C{True}. If C{auth} is C{None}, people can force or
             stop builds without auth.

@type order_console_by_time: bool
@param order_console_by_time: 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).

@type changecommentlink: callable, dict, tuple (2 or 3 strings) or C{None}
@param changecommentlink: adds links to ticket/bug ids in change comments,
    see buildbot.status.web.base.changecommentlink for details

@type revlink: callable, dict, string or C{None}
@param revlink: decorations revision ids with links to a web-view,
    see buildbot.status.web.base.revlink for details

@type projects: callable, dict or c{None}
@param projects: maps project identifiers to URLs, so that any project listed
    is automatically decorated with a link to it's front page.
    see buildbot.status.web.base.dictlink for details

@type repositories: callable, dict or c{None}
@param repositories: maps repository identifiers to URLs, so that any project listed
    is automatically decorated with a link to it's web view.
    see buildbot.status.web.base.dictlink for details

@type logRotateLength: None or int
@param logRotateLength: file size at which the http.log is rotated/reset.
    If not set, the value set in the buildbot.tac will be used, 
     falling back to the BuildMaster's default value (1 Mb).

@type maxRotatedFiles: None or int
@param maxRotatedFiles: number of old http.log files to keep during log rotation.
    If not set, the value set in the buildbot.tac will be used, 
     falling back to the BuildMaster's default value (10 files).       

@type  change_hook_dialects: None or dict
@param change_hook_dialects: If empty, disables change_hook support, otherwise      
                             whitelists valid dialects. In the format of
                             {"dialect1": "Option1", "dialect2", None}
                             Where the values are options that will be passed
                             to the dialect
                             
                             To enable the DEFAULT handler, use a key of DEFAULT
                             
                             


@type  provide_feeds: None or list
@param provide_feeds: If empty, provides atom, json, and rss feeds.
                      Otherwise, a dictionary of strings of
                      the type of feeds provided.  Current
                      possibilities are "atom", "json", and "rss"

Overrides: twisted.application.service.MultiService.__init__

Overrides: twisted.application.service.Service.setServiceParent

Overrides: twisted.application.service.Service.stopService

Special descriptor for class __provides__

The descriptor caches the implementedBy info, so that
we can get declarations for objects without instance-specific
interfaces a bit quicker.

For example:

  >>> from zope.interface import Interface
  >>> class IFooFactory(Interface):
  ...     pass
  >>> class IFoo(Interface):
  ...     pass
  >>> class C(object):
  ...     implements(IFoo)
  ...     classProvides(IFooFactory)
  >>> [i.getName() for i in C.__provides__]
  ['IFooFactory']

  >>> [i.getName() for i in C().__provides__]
  ['IFoo']

Overrides: twisted.application.service.Service.__provides__

__implemented__

Value:

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