Skip to content

Commit

Permalink
updates to readme
Browse files Browse the repository at this point in the history
  • Loading branch information
Karolis Rusenas committed Jul 28, 2015
1 parent b2a88e8 commit 306cad1
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 9 deletions.
2 changes: 2 additions & 0 deletions .gitignore
Original file line number Diff line number Diff line change
Expand Up @@ -7,3 +7,5 @@

# Vagrant
.vagrant

app_conf.yaml
17 changes: 8 additions & 9 deletions README.rst
Original file line number Diff line number Diff line change
Expand Up @@ -22,20 +22,19 @@ https://developers.google.com/analytics/devguides/reporting/mcf/v3/limits-quotas

Set Per-user limit to more than 1.

Provide service account and profile_id in settings.py
**Rename app_conf.yaml.example to app_conf.yaml**

Then, use this file for configuration:

# Authentication via Google
* applicationSettings - these options are used for callbacks as well as server startup. For local development
leave them as is.

provide details for secure authentication in settings.py:
* google_oauth settings value should contain key with your Client ID (create a new client ID application) and secret with Client secret
* allowed_domain settings value should contain whitelisted domain, leave it blank to allow all domains.
* googleAnalyticsApi - in your google developer console go to APIs & auth > credentials and create new service account.
Your profileId is your google analytics profile ID.

# Details to query google API
* googleOAuth - key value should contain key with your Client ID (Client ID for native application) and secret - Client secret
* allowedDomain value should contain whitelisted domain, leave it blank ('') to allow all domains.

* SERVICE_ACCOUNT settings value should contain email address of your service account that you created and gave rights
to access your analytics.
* PROFILE_ID settings value contain your analytics profile ID to reduce query count.

Start the server
================
Expand Down
19 changes: 19 additions & 0 deletions app_conf.yaml.example
Original file line number Diff line number Diff line change
@@ -0,0 +1,19 @@
applicationSettings:
debug: true
hostname: "localhost"
port: 8888
forksPerCPU: 0

# Details for querying google analytics API
# don't forget to add it to your analytics users, profileId - add your google analytics profile ID
googleAnalyticsApi:
serviceAccount: '__your_service_account@developer.gserviceaccount.com'
profileId: '__your_profile__id'

# application credentials from APIs & auth > credentials > Client ID for native application
# key represents "Client ID", secret is "Client secret". Oauth module expects to find "google_oauth" in app settings
# set allowedDomain to '' if you want to allow all domains
googleOAuth:
key: '__your_client_key__'
secret: '__your_client_secret__'
allowedDomain: '__your_domain__'

0 comments on commit 306cad1

Please sign in to comment.