Revision as of 18:00, 27 March 2014

Local Staging Server Setup

The following steps will guide users to create a local staging server that we will than use to launch our experiments from.

Note: This guide was done using OSX 10.9.2, the process for Windows will be a little different

The first step is to run the OSX m-c bootstrap, the command can be found in the link below: (right below One-Line Setup (Try This First!))
- https://developer.mozilla.org/en-US/docs/Developer_Guide/Build_Instructions/Mac_OS_X_Prerequisites
Clone the telemetry experiment server using the following command:
- hg clone http://hg.mozilla.org/users/bsmedberg_mozilla.com/telemetry-experiment-server/
Once cloned, a directory named telemetry-experiment-server should have been created
Switch into the telemetry-experiment-server
Will than checkout the latest branch using the following command:
- hg checkout <checkout branch #>, Example: hg checkout 42b785b60c60
Once you've checked out the latest branch, will need to install genshi as it's a prerequisite for building our local server
To install genshi simply type pip install Genshi in the terminal and follow the onscreen directions

Once you have all of the above completed, the next step will be to edit the build.py file and change a few of the parameters.

Open build.py with your favorite text editor, vim was used in this guide (vim build.py)
- Change: 'xpiURL': to 'http://localhost:8080/experiment.xpi'
- Change: 'channel': to the channel that you're currently testing in (nightly, aurora, beta, release)
Once you've made the appropriate changes, save the file and run the following command:
- python build.py <your directory name> Example: python build.py exp1 (should create a directory named exp1)
Switch into the directory that we've just created, in this example we used exp1 and run the following command:
- python -m SimpleHTTPServer 8080 (you should now be able visit: http://localhost:8080

The following preferences need to be created/modified to get telemetry experiments working correctly:

In the Firefox URI field, type in about:config and click on I'll be careful, I promise!
- Change: "experiments.enabled" = true
- Change: "experiments.logging.level" = 0
- Change: "experiments.manifest.cert.checkAttributes" = false
- Change: "experiments.manifest.uri" = http://localhost:8080/firefox-manifest.json (might differ depending on what you set your sever to earlier)

@@ Line 28: / Line 28: @@
 == Changing browsers preferences to enable experiments ==
-The next step will be to enable/change the correct preferences that we need for telemetry experiments to work correctly.
+The following preferences need to be created/modified to get telemetry experiments working correctly:
 * In the Firefox URI field, type in '''about:config''' and click on '''I'll be careful, I promise!'''