Install a Plugin

(Arpit Jalan) #1

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.

  • Add the plugin’s repository url to your container’s app.yml file:

    - exec:
        cd: $home/plugins
          - mkdir -p plugins
          - git clone
          - git clone

(Add the plugin’s git clone url just below git clone

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

Persona Login Plugin
Checklist: A simple markdownified checkbox-plugin with inline-updating
The Official Discourse Tags Plugin: discourse-tagging
Discourse Version 1.2
Launcher permission denied error after rebuilding with typo in app.yml
Discourse Slackdoor Plugin
Site maintenance mode during rebuilds?
How to create a new plugins?
Embed Etherpad Lite pads into Discourse
How do I stop human spammers?
Increase Avatar Size to 120x120 pixels
Easy to use static pages plugin
How to Configure Domain name in Digital Ocean to Connect with Discourse
Can Plugins Be Added To Basic Docker Install
About the Plugin category
Data Explorer Plugin
Formatting toolbar
Has anyone built something for informal status updates - Chat?
Discourse Push Notifications
Solved Button Plugin
Checklist Plugin - Interactive Checkboxes made Simple
Unable to install plugins
Bump Reset plugin - Annotated to help new devs
"Phishing (web forgery) suspected" - Seriously, I do not customize anythings
How does Discourse compare and contrast with Vanilla Forums?
Wild Apricot login plugin
ReplyGif: Adding reaction GIF easily
Importing from phpBB3
Content Lock BBCode
How do you spoiler an image or onebox?
How to hook up JWT Single Sign On to Discourse
Admin Statistics Report
Install plugins
Should all plugins be cloned as the `discourse` user?
Discourse Patreon Integration
OAuth2 integration with Drupal
User feedback plugin
Media Overlay Plugin
Discourse Narrative Bot Beta Feedback
Daemonite Material Theme
No option appears to choose better answer
How to block all crawlers but Google's
Update private plugin without rebuilding the application
Discourse Avatar name_first_letter
Auto-suspend inactive users
Generating lots of Invite Tokens
How do i install plugins after doing a fork?
How to ad banners?
Algolia plugin indexation
Chatroom Integration Plugin (discourse-chat-integration)
Can't Install plugin
Discourse Zendesk Plugin
Telegram Notifications Plugin (discourse-telegram-notifications)
Discourse Backups to Dropbox (Deprecated)
Who's Online Plugin (discourse-whos-online)
Configuring OneLogin's SAML for Discourse
Migrate from Digital Ocean to OVH?
Trying to install plugin (But not working)
Discourse Push Notifications
How to break 99k char limit?
Synchronizer-base for any backup provider
Babble - A Chat Plugin
Efficient way to change from 'categories & topics' to 'forums & threads' in app?
Allow Tab in app.yml for Plugin Installation
Beginner's Guide to Creating Discourse Plugins - Part 1
Does this software allow admin to put Adsense ads in?
SSO for College Account
Should all plugins be cloned as the `discourse` user?
[Solved] Admin-upgrade page not showing up
How can I add new badges?
Discourse Etiquette: take actions when users intend to post inappropriate remark
./launcher rebuild app error './launcher: No such file or directory'
Babble - A Chat Plugin
Azure Blob Storage Plugin
Why do I need a block storage?
Plugin for Preventing Malicious Linking
I cant install plugin
How does anon posting work? (Is there any place I can try it out?)
Fixing problems with rebuild app
Install plugins for hosted solution
Embedding Video on Homepage
Topic List Previews
Is there any left or right sidebar option in Discourse login (vkontakte)
Links Category for Discourse
Force specific users through moderation
Watching Categories based on on group in discourse
Importing from phpBB3
(Lê Trần Đạt) #6

Is there a way to rebuild app without letting the forum down like the Discourse Upgrading feature does? The down time for rebuilding Discourse is quite long.

(Sam Saffron) #7

not yet, we are probably going to solve this some time in 2015

How does Discourse compare and contrast with Vanilla Forums?

Can be found here:

  1. Access your server (use Putty on Windows)
  2. Type cd /var/discourse
  3. Type nano containers/app.yml

It is good to teach a step by step. Not everyone is familiar to the Discourse way :blush:

How to convince my university to use/install Discourse?
Installing Sidebar Plugin
How do I manually update Discourse and Docker image to latest?
(Molly) #14

Step by Step Guide:

(for those like me who needed more info the first time)

4.) Arrow down until you see this:

5.) Paste “- git clone” beneath that so that all together it looks like this:

6.) control + O (to save app.yml), hit enter

8.) control + X (to exit app.yml), then hit enter

9.) git pull (this updates stuff)

10.) ./launcher rebuild app (restarts Discourse and includes the plugin)

^ @AdamCapriola showed me that stuff and I did exactly the way I ordered it and it worked for me.

It may seem like an obvious order to those more familiar with it, but that’s what I needed to do it successfully the first time. Now I can do it easy peasy.

Babble - A Chat Plugin
Problem is installing plugin
(Jens Maier) #15

Please do beware that indentation in YAML – the file format used through the app.yml file – matters! Whenever you post YAML documents or snippets, please use the proper markup:

<--- paste snippet here!

Here’s your app.yml snippet with proper indentation:

    - exec:
        cd: $home/plugins
          - mkdir -p plugins
          - git clone
          - git clone

If you use <blockquote> blocks or, as you did above, [quote] blocks, whitespace at the beginning of the line will not be preserved and the YAML document’s meaning will change, resulting in errors.

Also… learn Vim. :wink:

Allow Tab in app.yml for Plugin Installation
(Athithan) #32

How to install a private git repository plugin?

(Arpit Jalan) #33

To add a private git repository plugin, you need to follow these steps:

  - exec: echo "Beginning of custom commands"
  - exec: cd /var/www/discourse && sudo -u discourse bundle install --deployment --without test --without development
  - exec: echo "Host\n\tStrictHostKeyChecking no\n" >> /user/.ssh/config
  - file:
      path: /user/.ssh/id_rsa
      chmod: 600
      contents: |
        -----BEGIN RSA PRIVATE KEY-----
           .... etc ....
        -----END RSA PRIVATE KEY-----
  - file:
      path: /user/.ssh/
      chmod: 600
      contents: ssh-rsa AAAAB3NzaC1yc2EAAAABIwAAAQEAklOUpkDHrfHY17SbrmTIpNLTGK9Tj .... etc .... user@discourse
  - exec: cd $home/plugins && git clone
  - exec: cd $home && sudo -E -u discourse bundle exec rake db:migrate
  - exec: cd $home && rm -fr tmp/cache
  - exec: cd $home &&  sudo -E -u discourse bundle exec rake assets:precompile
  - exec: rm /user/.ssh/id_rsa
  - exec: rm /user/.ssh/

  - exec: echo "End of custom commands"
  • Rebuild the container:
cd /var/discourse
./launcher rebuild app

Your private plugin should be installed on your Discourse instance.

Discourse: Install plugin from Gitlab private repository
Migration 1.8 -> 1.9 errors
Specifying the gem dependecies for plugin - gem does not exist
(Sandip Pingle) #34

after following this steps to install this plugin


cd /var/discourse
./launcher rebuild app

There was no errors, but my site stopped working completely.
Tried ./launcher restart app, docker restart also rebooting serve, but still error persist.

Also tried removing plugin url from app.yml and again rebuilding app.

Thanks in advance.

(Jeff Atwood) #35

Your YAML is probably invalid. Copy and paste it into an online YAML validator. I just set up the tagging plugin for several DO droplets and it worked fine.

Allow Tab in app.yml for Plugin Installation
(Sandip Pingle) #36

@codinghorror, thanks for reaching out.
my app.yml is valid, I’ve tested it using

Any other pointers to solve issues.

(Sam Saffron) #37

yaml can be well structured yet invalid in some cases.

start from the samples, one change at a time and rebuild.

(David Detlefsen) #38

How do you install a plugin with a hosted instance?

(Kane York) #39

With hosting, plugins are only available in the Enterprise offering, and you email with info on the plugin (the URL).

(eriko) #40

Issue cloning plugin from an internal server.

Cloning into 'xxxx_xxx_xxx'...
fatal: unable to access 'https://git.XXXX.XXX/academic-technologies/xxxx_xxx_xxx.git/': server certificate verification failed. CAfile: /etc/ssl/certs/ca-certificates.crt CRLfile: none

I have an internally accessible gitlab server with a valid ‘DigiCert SHA2 Secure Server CA’ intermediary cert. basically Chrome is happy with it and we use certs from the same source for our external services. Because of the datasources and to things that get set it is really not for public consumption so I can not put it on get hub

So is there a cache of server certificates that discourse_docker is allowed to install plugins from?.

(Kane York) #41

Try installing updates on the host: sudo apt-get update && sudo apt-get upgrade. That should update the certificate files.

(eriko) #42

Ok I can see why that would work. I had assumed that since connecting from the OS hosting the docker containers worked that it would from inside the container.

So I am running into this while running ./launcher rebuild so do I need to update the docker image that is being used to setup the container. I could put that apt-get commands in to the container file before the plugin is installed but seems kludgy.

(Curiositry) #43

FYI: In addition to what @elberet said, the launcher will not let you rebuild if you use tabs! You have to use spaces to indent your YAML. Picky picky… :stuck_out_tongue:

Allow Tab in app.yml for Plugin Installation
(Jeff Atwood) #44

What kind of animal would use tabs instead of spaces

(Curiositry) #45

@codinghorror Haha. I suppose self-taught varmints like @curiositry use tabs when they’re in the heat of battle with a Goliath rails app :smile:. (I’m used to using Atom or Sublime, which convert tabs to 2 spaces…)

Thanks for building Discourse by the way, and making it open-source. It’s a sweet piece of software.