Skip to content

HTTPS clone URL

Subversion checkout URL

You can clone with HTTPS or Subversion.

Download ZIP
Newer
Older
100644 70 lines (38 sloc) 1.891 kb
d439a26 @jrburke some renaming work, README cleanup.
authored
1 # f1
2
3 A link sharing service that consists of a Firefox extension and a web service.
4
5 The firefox extension creates an area to show the share UI served from the web service.
6
7 The web service handles the OAuth work and sending of messages to different share servers.
8
9 Some directory explanations:
10
11 * **extensions**: holds the Firefox extension source.
12 * **web**: holds the UI for the web service.
13 * **grinder**: a load testing tool.
14 * **tools**: deployment tools.
15 * The rest of the files support the web service.
16
17 ## Installation and Setup
18
331076b @jrburke Adding license info.
authored
19 ### Get the f1 repository:
d439a26 @jrburke some renaming work, README cleanup.
authored
20
21 git clone https://github.com/mozilla/f1.git
22 cd f1
23
24 ### Setup a virtual environment (optional, recommended):
25
26 sudo easy_install virtualenv
27 virtualenv env
28 source env/bin/activate
29
30 ### Dependency installation
31
32 python setup.py develop
33
34 ### Make a config file as follows::
35
36 # **skip this step for now**
37 # paster make-config f1 config.ini
38
39 ### Tweak the config file as appropriate and then setup the application::
40
41 # **skip this step for now**
42 # paster setup-app config.ini
43
44 ### Running f1
45
46 Run the web server. 'reload' is useful for development, the webserver restarts on file changes, otherwise you can leave it off
47
48 paster serve --reload development.ini
49
50 Then visit: http://127.0.0.1:5000/ for an index of api examples
51
52
53 ## Setting up a valid Google domain for OpenID+OAuth
54
55 You have to have access to a valid domain that google can get to and where you can install an html file.
56
57 Visit: https://www.google.com/accounts/ManageDomains
58
59 Add your domain, follow the rest of their instructions.
60
61 To test: Once that is done, you can bypass normal access to your domain by adding to your /etc/hosts file:
62
63 127.0.0.1 your.host.com
64
65 Update development.ini and add your key/secret for the google configuration, restart paster.
66
67 Then in the web browser, hit f1 with http://your.host.com.
68
69
Something went wrong with that request. Please try again.