test/httpd

We are planning to deprecate the use by Firefox add-ons of the techniques described in this document.

Don't use these techniques to develop new add-ons. Use WebExtensions instead.

If you maintain an add-on which uses the techniques described here, consider migrating it to use WebExtensions instead.

Add-ons developed using these techniques might not work with multiprocess Firefox (e10s), which is already the default in Firefox Nightly and Firefox Developer Edition, and will soon be the default in Beta and Release versions of Firefox. We have documentation on making your add-ons multiprocess-compatible, but it will be more future-proof for you to migrate to WebExtensions.

A wiki page containing resources, migration paths, office hours, and more, is available to help developers transition to the new technologies.

This module was removed in Firefox 36, please use the addon-httpd npm module instead.

An HTTP server for the Mozilla platform, which can be used in unit tests.

Usage

The most basic usage is:

var { startServerAsync } = require("sdk/test/httpd");
var srv = startServerAsync(port, basePath);
require("sdk/system/unload").when(function cleanup() {
  srv.stop(function() { // you should continue execution from this point.
  })
});

This starts a server in background (assuming you're running this code in an application that has an event loop, such as Firefox). The server listens at http://localhost:port/ and serves files from the specified directory. You can serve static content or use SJS scripts, as described in documentation on developer.mozilla.org.

You can also use nsHttpServer to start the server manually:

var { nsHttpServer } = require("sdk/test/httpd");
var srv = new nsHttpServer();
// further documentation on developer.mozilla.org

See HTTP server for unit tests for general information.

Document Tags and Contributors

 Contributors to this page: wbamberg, evold
 Last updated by: wbamberg,