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 f1dd58b commit 05f10d9
Show file tree
Hide file tree
Showing 4 changed files with 91 additions and 12 deletions.
25 changes: 17 additions & 8 deletions ce/administrator/configuration/oauth_apps.rst
Original file line number Diff line number Diff line change
@@ -1,17 +1,26 @@
OAuth Apps
==========

To access the REST APIs of Channels such as Twitter or Facebook, CampaignChain must be
registered as an App with these Channels to receive an App Key and App Secret. For
example, you can do so at
Create new OAuth Apps
---------------------

- Twitter: https://apps.twitter.com
- Facebook: https://developers.facebook.com/apps
To allow CampaignChain to post to Twitter, Facebook and some more Channels, it
must be able to access the REST APIs of such Channels. Hence, CampaignChain
must be registered as an App with these Channels to receive an App Key and App
Secret.

To enable CampaignChain modules to access the respective REST APIs, the App Keys and
Secrets can be configured within CampaignChain as follows.
There are How-Tos available for each Channel:

In the CampaignChain header menu, click the *Settings* icon and select *OAuth Apps*.
- `Twitter OAuth app configuration`_

Edit existing OAuth App credentials
-----------------------------------

The App Keys and Secrets of Channels which have already been connected with
CampaignChain, can be edited as follows:

In the CampaignChain header menu, click the *Settings* icon and select *OAuth
Client Apps*.

.. image:: /images/administrator/settings_menu_oauth_apps.png
:width: 600px
Expand Down
67 changes: 67 additions & 0 deletions package/campaignchain_twitter.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,67 @@
CampaignChain Twitter Packages
==============================

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

Features
--------

- Connect a Twitter stream to CampaignChain with username and password
- Assign a Twitter message to a campaign
- 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
and re-tweets

Packages
--------

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

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

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
-------------

.. _Twitter OAuth app configuration:

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

#. Go to https://dev.twitter.com/apps and create a new application.
#. Fill out any required fields such as the application name and description.
#. Put your website domain in the Website field.
#. Provide the domain of your CampaignChain instance as the Callback URL. Make
sure that you specify the correct protocol (`http` or `https`).
#. 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
Access Tokens* tab to copy and paste the *Consumer Key* and the *Consumer
Secret* and insert it in the *Provide Application Credentials* form.

Issues
------

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


.. _campaignchain/channel-twitter: https://github.com/CampaignChain/channel-twitter
.. _campaignchain/location-twitter: https://github.com/CampaignChain/location-twitter
.. _campaignchain/activity-twitter: https://github.com/CampaignChain/activity-twitter
.. _campaignchain/operation-twitter: https://github.com/CampaignChain/operation-twitter
.. _Symfony bundles: http://symfony.com/doc/current/bundles.html
1 change: 1 addition & 0 deletions package/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -7,4 +7,5 @@ available for CampaignChain.
.. toctree::
:maxdepth: 2

campaignchain_twitter
campaignchain_update
10 changes: 6 additions & 4 deletions user/get_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,10 +6,12 @@ Campaign and Activity within CampaignChain. You will learn how to connect
Twitter as a Channel and how to post a Tweet on the stream of the related
Twitter user account.

1. Connect to a Channel
-----------------------
.. _Connect to a Location:

To connect a Twitter Channel with CampaignChain, click the *Create New*
1. Connect to a Location
------------------------

To connect a Twitter Location with CampaignChain, click the *Create New*
button in the header menu and choose *Location*.

.. image:: /images/user/create_new_location.png
Expand All @@ -24,7 +26,7 @@ On the next screen, select Twitter as the Channel and click *Next*.
.. note::

Should you now see the *Provide Application Credentials* screen, then please
ask the CampaignChain administrator to do this for you and proceed as follows.
see the documentation on `Twitter OAuth app configuration`_.

When clicking the button *Connect with Twitter*, the login screen for Twitter
will be displayed to you. Please enter your Twitter user name and your Twitter
Expand Down

0 comments on commit 05f10d9

Please sign in to comment.