9.0 KiB

Raw Blame History

Official Discourse Advertising Plugin

This is the official Discourse advertising plugin. It allows advertisements to be served by supported advertising platforms for users with a Discourse forum.

Authors: Sarah Ni & Vi Nguyen Version: 1.0.1 Contributors: See credits section below License: MIT License Supported Discourse Version: 1.4 Supported Ad Platforms:

Google Adsense
Google Double Click for Publishers
Amazon Affiliates - Banner and Product Link Ads

Quick Start in 3 Steps

This quick start shows you how to install this plugin and use it. Recommended if you have:

A live discourse forum
You have deployed your live forum using Docker. If you're using Digital Ocean, it's likely that your forum is deployed on Docker.

For non-docker or local development installation (those with programming experience), see Other Installation.

Step 1 - Install the Official Discourse Advertising Plugin

As seen in a how-to on meta.discourse.org, simply add the plugin's repository url to your container's app.yml file:

hooks:
  after_code:
    - exec:
        cd: $home/plugins
        cmd:
          - mkdir -p plugins
          - git clone https://github.com/team-melbourne-rgsoc2015/discourse-adplugin.git

Rebuild the container

cd /var/docker
git pull
./launcher rebuild app

Step 2 - Configure Your Settings to Display Your Advertisments

There are 2 easy steps for configuring your Discourse settings to enable advertisements to display in your Discourse forum.

Step 2(a) - Choose Your Advertisement Platform

Navigate to the Admin section in your Discourse forum.
Click on Settings and a left vertical navigation bar should appear.
Choose your advertisement platform.

Adsense - if using Adsense as your advertisement platform.
DFP - if using the DoubleClick for Publishers advertisement platform.

Step 2(b) - Input Your Details

Add in your publisher ID - your publisher ID can be obtained from your ad platform and can also be found in your ad tag (see pictures below).
Choose your trust level from the dropdown box. This will only display ads to users with a certain level of trust. For more details about trust levels go to the Plugin Features heading.
Get the Advertisement Tag from your Ad Platform - see the images below to see what a tag looks like.
Add parts of your ad code to Discourse's site settings for the locations you wish your ad to appear. Refer to image for your ad platform to where parts of your ad tag should go. For more detail about where the ad will appear
Choose Your Ad Size - this is the same size that you've put into your ad provider to create your ad. Go to the Plugin Features heading to see a list of supported Ad sizes.

DoubleClick for Publishers' Advertisement Tag to Discourse's Site Settings

Amazon Affiliates' Advertisement Tag to Discourse's Site Settings

Only for Product Link and Banner Ads.

Step 3 - See Your Ad

Once you've configured your settings and your advertising platform has ads that are ready to serve, navigate to the page where you've inputted for the location and you should see ads.

Plugin Features

In this section, we go into more detail on:

Available Locations for Ad Display
Ad Sizes Supported
Trust Levels
Languages Supported

Available Locations for Ad Display

The following are available locations along with a description and an image showing their location within Discourse to display ads for all platforms.

Location Name	Description	Image of Location
Topic List Top	Ad will appear at the header of Discourse homepage	Topic list top
Topic Above Post Stream	Ad will appear in the header of all Discourse forum topics	Topic above post stream
Topic Above Suggested	Ad will appear in the footer above suggested topics of all Discourse forum topics	Topic above suggested
Post Bottom & Nth Post	Ad will appear on the stipulated nth post within a topic. So if you have 5 posts in a topic and you want the ad to display after on the 2nd post, put 2 in `ad_platform_nth_post_code`.	Post bottom

Advertisement Sizes Supported

This plugin supports the following ad sizes for the following locations.

All locations except post bottom	Post bottom location	Mobile
728 x 90	728 x 90	320 x 50
336 x 280	336 x 280
300 x 250	300 x 250
970 x 90	970 x 90
468 x 60	468 x 60
234 x 60	234 x 60
125 x 125
180 x 150
200 x 200
250 x 250

Trust Levels

You can use the ad_platform_through_trust_level dropdown to disable ads for users above a certain trust levels. As a guide, choosing:

0 shows ads to users that are not logged in.
1 shows ads to users that are not logged in, and to new and basic users.
2 shows ads to regular users as well, but not to leaders and elders.
3 shows ads to everyone but elders.
4 shows ads to everyone including elders.

To find more about trust levels in Discourse, refer to Discourse's posts on trust levels

Languages Supported

Chinese (Simplified)
English
French
Spanish

Other Installation

There are two sets of installation instructions:

Non-Docker Installation - If you have experience with programming. This will set up this plugin as a git submodule in your Discourse directory.
Local Development - If you want develop locally and have experience with programming. This will set up this plugin as a symlinked file in Discourse's plugin directory.

If you already have a live Discourse forum up, please go to the Quick Start heading above.

1. Non-docker installation

Run bundle exec rake plugin:install repo=http://github.com/team-melbourne-rgsoc2015/discourse-adplugin in your discourse directory
In development mode, run bundle exec rake assets:clean
In production, recompile your assets: bundle exec rake assets:precompile
Restart Discourse

2. Local Development Installation

Clone the Discourse Adplugin Repo in a new local folder.
Separately clone Discourse Forum in another local folder and install Discourse.
In your terminal, go into Discourse folder navigate into the plugins folder. Example cd ~/code/discourse/plugins
Create a symlink in this folder by typing the following into your terminal :

ln -s ~/whereever_your_cloned_ad_plugin_path_is .
For example: ln -s ~/discourse-plugin-test .

You can now make changes in your locally held Discourse Adplugin folder and see the effect of your changes when your run rails s in your locally held Discourse Forum files.

Questions or Want to Contribute?

Open an Issue on this repository to start a chat.

Credits

Discourse.org: Thanks to our amazing mentor @eviltrout and the wonderful Discourse team!

Our Coaches: Very special thank you to our coaches and honorary coach - @georg, @betaass, @adelsmee, @davich, @link664, @tomjadams, @compactcode, @joffotron, @jocranford, @saramic, @madpilot, @catkins

Rails Girls: Thanks @sareg0 and the Rails Girls Team for the opportunity to participate in Rails Girls Summer of Code 2015.

To create this plugin we referenced the original dfp plugin (created by nlalonde) and the adsense plugin.

9.0 KiB Raw Blame History