Quick Install
If you already know what you’re doing here’s the code you need to install the currently used plugins:
cd /var/discourse
nano containers/app.yml
hooks:
after_code:
- exec:
cd: $home/plugins
cmd:
- git clone https://github.com/paviliondev/discourse-follow.git
#- git clone https://github.com/paviliondev/discourse-landing-pages.g$
- git clone https://github.com/discourse/docker_manager.git
- git clone https://github.com/davidtaylorhq/discourse-whos-online.git
- git clone https://github.com/discourse/discourse-voting.git
- git clone https://github.com/focallocal/dcs-discourse-plugin.git
- git clone https://github.com/discourse/discourse-assign.git
- git clone https://github.com/paviliondev/discourse-custom-wizard.git
#- git clone https://github.com/huangtony/discourse-onesignal-plugin.$
- git clone https://github.com/paviliondev/discourse-events.git
#- git clone https://github.com/paviliondev/discourse-layouts
#- git clone https://github.com/discourse/discourse-calendar.git
- git clone https://github.com/discourse/discourse-data-explorer
- git clone https://github.com/discourse/discourse-solved
- git clone https://github.com/discourse/discourse-akismet
- git clone https://github.com/discourse/discourse-post-voting
- git clone https://github.com/discourse/discourse-docs
- git clone https://github.com/discourse/discourse-category-experts
- git clone https://github.com/discourse/discourse-cakeday
- git clone https://github.com/discourse/discourse-code-review
cd /var/discourse
./launcher rebuild app
From the Discourse Plugin Library
Support available in the Discourse Plugin Library
Format:
- Title
- Short overview explaining how and why we use it
- Plugin discussion url on https://meta.discourse.com
- Github url
Menu Links
- Adding links to the main menu and other menus without needing coding
- https://meta.discourse.org/t/navigation-add-custom-menu-items/53124
- GitHub - VinkasHQ/discourse-navigation: Plugin to add a custom nav menu links.
- also requires docker manager plugin
git clone:
GitHub - discourse/docker_manager: Plugin for use with discourse docker image
GitHub - VinkasHQ/discourse-navigation: Plugin to add a custom nav menu links.
.
Voting
- Used for where voting will aid decision making, with the intention of using this heavily (with edits) in our community governance model in the future
- Discourse Topic Voting - plugin - Discourse Meta
- GitHub - discourse/discourse-topic-voting: Adds the ability for voting on a topic within a specified category in Discourse.
.
Who’s Online
- Allows users to see who’s online. Helps the chat app too
- Discourse Who's Online - plugin - Discourse Meta
- GitHub - discourse/discourse-whos-online: A plugin for Discourse which uses the messagebus to display a live list of active users
.
Kanban Boards
- Allows us to create kanban project management boards in specific threads and categories so teams can coordinate their efforts on projects using Scrum/Agile Methodology
- Kanban Board - theme-component - Discourse Meta
- GitHub - discourse/discourse-kanban-theme: A Discourse theme component providing basic kanban-board functionality
.
Chat Room Plugin (our Slack sync)
- Used for integration between main channels for members who need to use other platforms, usually because they are at work and have down time to support a cool project
- Discourse Chat Integration - plugin - Discourse Meta
- GitHub - discourse/discourse-chat-integration
Discourse Library Plugins which have been edited by our Community
Custom Builds
Docuss
- The integration which allows this forum to interact with, and power our community building, communications, and much of our admin area.
- GitHub - sylque/docuss: A comment/discussion/collaboration system for websites and web apps
note: Sylvain ( @syl ) is both an independent, and an important part of our community. He founded Docuss and operates closely with us as we partnered and are the 1st website bringing his independent vision of Docuss to life.
Plugins under Consideration
Calendar
- Pros: This could be used in each team category to help teams organise meetings, collaborate work sessions, and schedule their desired commitment which is a big help in helping people keep to the commitment they want to make. Currently served just about adequately by external Timetree.
- Cons: Looks to be lacking in user friendly features, so would be confusing to those not comfortable with tech.
- Library link: Discourse Calendar (and Event) - plugin - Discourse Meta
- Github: GitHub - discourse/discourse-calendar: Adds the ability to create a dynamic calendar in the first post of a topic.
.
Linkedin Oauth
- Allows users to login using Linkedin as well as current options
- Pros: Useful to those who use Linked in often
- Cons: Might interfere with our React/Meteor platform which is synced to copy account creation and login from Discourse (this forum).
- Discourse LinkedIn Authentication - plugin - Discourse Meta
- GitHub - discourse/discourse-linkedin-auth: LinkedIn OAuth Login support for Discourse
.
Add buttons at the bottom of posts
- Could be used to easily expand functionality
- Add a button at the bottom of a topic, visible to everyone: discourse-custom-topic-button - plugin - Discourse Meta
.
Add buttons at the bottom of a post ONLY visible to a specific group
- Adds ability to incentivise joining groups and expand functionality
- Add a button at the bottom of a topic, visible to a specific group: discourse-topic-group-button - plugin - Discourse Meta
.
Staff Notes
- Allows staff to tag notes and comment on specific users
- Pros: allows experienced users to better keep tabs on anyone behaving in a suspicious manner they suspect to be operating against the community values they agreed to
- Cons: communication out in the open is in line with our community values. we don’t want miscommunication by discussions happening behind closed doors. A culture of asking people what they are doing and why to understand - or remove them if its not inline with why we are here, would be better
- Discourse User Notes - plugin - Discourse Meta
.
The Discourse Plugin Library
Official: Topics tagged official
All: plugin - Discourse Meta
note: clicking on ‘views’ or ‘replies’ to order the forum posts is a fairly good way of bringing the most popular plugins to the top
How to Install a New Plugin
Ask someone from the Dev team who has access to our Digital Ocean server to add a plugin and share this guide with them. Its a very quick (2 min) process so they shouldn’t mind.
Current Devs with Access:
You then need any forum admin to navigate to plugins and turn it on
A few admins:
Plugin installation tutorial
So you want to install a plugin on your Discourse instance? Great, let’s get started!
In this tutorial, we’ll install Discourse Spoiler Alert plugin.
- Get the plugin’s GitHub or Bitbucket
git clone
url. - Access your container’s
app.yml
file (present in/var/discourse/containers/
)
cd /var/discourse
nano containers/app.yml
- Add the plugin’s repository URL to your container’s
app.yml
file:
hooks:
after_code:
- exec:
cd: $home/plugins
cmd:
- git clone https://github.com/discourse/docker_manager.git
- git clone https://github.com/discourse/discourse-spoiler-alert.git
(Add the plugin’s git clone
url just below git clone https://github.com/discourse/docker_manager.git
)
- Rebuild the container:
cd /var/discourse
./launcher rebuild app
That’s it, you’ve successfully installed the Discourse Spoiler Alert plugin on your Discourse instance!
Note: I think our app.yml file (and other files) are inside Docker. Please let me know if that’s correct so I can update this tutorial.