Skip to content

Commit

Permalink
#3 Explain for each module how to set up OAuth Apps
Browse files Browse the repository at this point in the history
  • Loading branch information
groganz committed Sep 11, 2016
1 parent b2410f5 commit 59c9783
Show file tree
Hide file tree
Showing 3 changed files with 86 additions and 1 deletion.
2 changes: 2 additions & 0 deletions ce/administrator/configuration/oauth_apps.rst
Original file line number Diff line number Diff line change
Expand Up @@ -14,6 +14,8 @@ Secret.
There are How-Tos available for each Channel:

- :ref:`Twitter <twitter-oauth-app-configuration>`
- :ref:`Facebook <facebook-oauth-app-configuration>`


Edit existing OAuth App credentials
-----------------------------------
Expand Down
82 changes: 82 additions & 0 deletions package/campaignchain_facebook.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,82 @@
CampaignChain Facebook Packages
===============================

This documentation covers the standard Facebook functionality available by
default in the CampaignChain Community Edition.

Features
--------

- Connect a Facebook user or page stream to CampaignChain with username and
password
- Assign a Facebook message to a campaign
- Include 1 picture in the Facebook message
- Schedule a message to automatically post it on Facebook at a given date and
time
- Assign a responsible person to a Facebook message
- Once a Facebook update was posted, regularly collect statistical data about
likes and comments

Packages
--------

The standard Facebook functionality is being provided by CampaignChain, Inc.
through these packages:

- `campaignchain/channel-facebook`_
- `campaignchain/location-facebook`_
- `campaignchain/activity-facebook`_
- `campaignchain/operation-facebook`_

Although these modules are based on `Symfony bundles`_, they do not work
independently of CampaignChain.

Installation
------------

The above modules are included in the Community Edition by default.

Configuration
-------------

.. _facebook-oauth-app-configuration:

Before you can post on Facebook from within CampaignChain, an OAuth app must be
created in Facebook:

#. Go to https://developers.facebook.com/apps and create a new application by
clicking *Create New App*.
#. Fill out any required fields such as the application name and description.
#. Put your website domain in the *Site Url* field.
#. Provide the host name of your CampaignChain instance as the Callback URL
(e.g. http://mydomain.com). Make sure that you specify the correct scheme
(`http` or `https`).
#. The Callback URL's parts must be identical with the
`router.request_context.host` and `router.request_context.scheme` parameters
defined in the `app/config/parameters.yml` configuration file.
#. Once you have registered the app, `connect to a location`_ while choosing
Facebook as the Channel.
#. When the *Provide Application Credentials* screen comes up, go back to
https://developers.facebook.com/apps, select your app and visit the
*Settings* page to copy and paste the *App ID* and the *App Secret* and
insert it in the *Provide Application Credentials* form.

.. note::

Should you want CampaignChain to post to Facebook streams which are not
owned by the same Facebook account which owns your OAuth App, then you must
get your OAuth App approved by Facebook. To do so, click on *App Review*
on the left menu of your Facebook OAuth App.

Issues
------

Please post reports, questions, suggestions, etc. at
https://github.com/CampaignChain/campaignchain/issues.


.. _campaignchain/channel-facebook: https://github.com/CampaignChain/channel-facebook
.. _campaignchain/location-facebook: https://github.com/CampaignChain/location-facebook
.. _campaignchain/activity-facebook: https://github.com/CampaignChain/activity-facebook
.. _campaignchain/operation-facebook: https://github.com/CampaignChain/operation-facebook
.. _Symfony bundles: http://symfony.com/doc/current/bundles.html
3 changes: 2 additions & 1 deletion package/campaignchain_twitter.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,6 +9,7 @@ Features

- Connect a Twitter stream to CampaignChain with username and password
- Assign a Twitter message to a campaign
- Include up to 4 pictures in a Tweet
- Schedule a Tweet to automatically post it on Twitter at a given date and time
- Assign a responsible person to a Tweet
- Once a Tweet was posted, regularly collect statistical data about likes
Expand Down Expand Up @@ -53,7 +54,7 @@ created in Twitter:
#. Once you have registered the app, `connect to a location`_ while choosing
Twitter as the Channel.
#. When the *Provide Application Credentials* screen comes up, go back to
https://dev.twitter.com/apps, select your app and visit the the *Keys and
https://dev.twitter.com/apps, select your app and visit the *Keys and
Access Tokens* tab to copy and paste the *Consumer Key* and the *Consumer
Secret* and insert it in the *Provide Application Credentials* form.

Expand Down

0 comments on commit 59c9783

Please sign in to comment.