Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Expand on the Google settings documentation #498

Merged
merged 2 commits into from May 16, 2019
Merged
Changes from all commits
Commits
File filter...
Filter file types
Jump to…
Jump to file or symbol
Failed to load files and symbols.

Always

Just for now

@@ -51,12 +51,32 @@ set up Orchestra yet, you should do that now. Also, make sure that
have loaded the workflow into the database (``python manage.py loadworkflow
journalism_workflow v1``).

The journalism workflow requires Google Apps integration to run,
so make sure in ``orchestra_settings.py`` you set ``settings.GOOGLE_APPS`` to
``True``, and fill in values for ``settings.GOOGLE_SERVICE_EMAIL``,
``settings.GOOGLE_P12_PATH``, and ``settings.GOOGLE_PROJECT_ROOT_ID``. Set up
and correct values for those settings are described in `the Google Apps
documentation <https://developers.google.com/drive/web/delegation>`_.
The journalism workflow requires Google Apps integration to run, so
make sure in ``orchestra_settings.py`` you set
``settings.GOOGLE_APPS`` to ``True``, and fill in values for
``settings.GOOGLE_SERVICE_EMAIL``, ``settings.GOOGLE_P12_PATH``, and
``settings.GOOGLE_PROJECT_ROOT_ID``. To get started, sign up for a
`Google API console account
<https://console.developers.google.com/>`_. Set up `a service account,
and retrieve that account's service email and .p12 key file
<https://webapps.stackexchange.com/questions/58411/how-where-to-obtain-a-p12-key-file-from-the-google-developers-console>`_.
As a summary, the variables do the following:

* ``settings.GOOGLE_SERVICE_EMAIL`` is the ID that Google will grant
you when you sign up for a service account.

* ``settings.GOOGLE_P12_PATH`` is a path on the filesystem to a .p12
key file you will receive when you sign up for the service account.

* ``settings.GOOGLE_PROJECT_ROOT_ID`` is the ID of the parent folder
in Google Drive in which Orchestra will create project-specific
subfolders. For example, if you create a parent folder in Google
Drive and its URL is
``https://drive.google.com/drive/u/0/folders/XYZ``, you should set
``settings.GOOGLE_PROJECT_ROOT_ID = 'XYZ'``. Note that your service
account needs to have access to this folder, either because you gave
it domain-wide access or because you explicitly shared the folder
with the service account.

Next, make sure you have the journalism workflow sample data installed by
running (if you haven't already) ``python manage.py loadworkflowsampledata
ProTip! Use n and p to navigate between commits in a pull request.
You can’t perform that action at this time.