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 e4f892f commit b9c8d89
Show file tree
Hide file tree
Showing 5 changed files with 82 additions and 9 deletions.
8 changes: 4 additions & 4 deletions package/campaignchain_facebook.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
CampaignChain Facebook
======================

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

Features
Expand Down Expand Up @@ -54,8 +54,8 @@ created in Facebook:
#. 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.
#. Once you have registered the app, :ref:`connect to a Location <create-new-oauth-apps>`
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
Expand All @@ -74,7 +74,7 @@ Issues
Please post reports, questions, suggestions, etc. at
https://github.com/CampaignChain/campaignchain/issues.


.. _Facebook: https://www.facebook.com
.. _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
Expand Down
72 changes: 72 additions & 0 deletions package/campaignchain_linkedin.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,72 @@
CampaignChain Linkedin
======================

This documentation covers the standard `Linkedin`_ functionality available by
default in the CampaignChain Community Edition.

Features
--------

- Connect a Linkedin stream to CampaignChain with username and password
- Assign a Linkedin message to a campaign
- Include up to 4 pictures in a Tweet
- Schedule a Tweet to automatically post it on Linkedin 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 Linkedin functionality is being provided by CampaignChain, Inc.
through these packages:

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

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

.. _linkedin-oauth-app-configuration:

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

#. Go to https://dev.linkedin.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 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, :ref:`connect to a Location <create-new-oauth-apps>`
choosing Linkedin as the Channel.
#. When the *Provide Application Credentials* screen comes up, go back to
https://dev.linkedin.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.

Issues
------

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

.. _Linkedin: https://www.linkedin.com
.. _campaignchain/channel-linkedin: https://github.com/CampaignChain/channel-linkedin
.. _campaignchain/location-linkedin: https://github.com/CampaignChain/location-linkedin
.. _campaignchain/activity-linkedin: https://github.com/CampaignChain/activity-linkedin
.. _campaignchain/operation-linkedin: https://github.com/CampaignChain/operation-linkedin
.. _Symfony bundles: http://symfony.com/doc/current/bundles.html
8 changes: 4 additions & 4 deletions package/campaignchain_twitter.rst
Original file line number Diff line number Diff line change
@@ -1,7 +1,7 @@
CampaignChain Twitter
=====================

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

Features
Expand Down Expand Up @@ -51,8 +51,8 @@ created in Twitter:
#. 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
Twitter as the Channel.
#. Once you have registered the app, :ref:`connect to a Location <create-new-oauth-apps>`
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 *Keys and
Access Tokens* tab to copy and paste the *Consumer Key* and the *Consumer
Expand All @@ -64,7 +64,7 @@ Issues
Please post reports, questions, suggestions, etc. at
https://github.com/CampaignChain/campaignchain/issues.


.. _Twitter: https://twitter.com/
.. _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
Expand Down
1 change: 1 addition & 0 deletions package/index.rst
Original file line number Diff line number Diff line change
Expand Up @@ -9,4 +9,5 @@ available for CampaignChain.

campaignchain_twitter
campaignchain_facebook
campaignchain_linkedin
campaignchain_update
2 changes: 1 addition & 1 deletion user/get_started.rst
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@ 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.

.. _Connect to a Location:
.. _connect-to-a-location:

1. Connect to a Location
------------------------
Expand Down

0 comments on commit b9c8d89

Please sign in to comment.