ProCourse Installer - Installing/removing plugins via the UI

This plugin is designed to make it extremely easy to install new plugins without logging into the server. It adds a screen under /admin/plugins/procourse-installer that looks like this:

From there, you can enter the URL (with or without .git) of the plugin git repo and click Install Plugin. Wait a few minutes (about 5 minutes) for the installation to complete and you’re good to go.

To see all the plugins you’ve installed through the installer or to remove a plugin, just go to Installed Plugins.


A few notes:

  • These plugins DO remain after a rebuild or bootstrap of app or web_only.

  • It is currently untested on multisite instances and will likely fail in those scenarios as the plugin needs access to the /plugins directory of the application in order to function.

  • The plugins installed WILL show up under /admin/plugins.

  • You CAN upgrade these plugins as normal from /admin/upgrade.

  • In the process of building this, we found a potential error when removing translations from plugins. It can cause the site to show an error if the user visits a page where the translation is used. This seems to happen even if you use admin/upgrade to upgrade a specific plugin and the plugin has removed a translation. We’re working on finding a solution to this currently.


Requirements:

  • You must be running a supported Docker install.

  • The Docker Manager plugin must be installed.

  • Access to /admin/upgrade.


Repo can be found here:

34 Likes

Wow! That’s quite an accomplishment! I thought it couldn’t be done. Nice work, @joebuhlig!

EDIT: Here’s a question. If you do a rebuild at the command-line, are the procourse-installer plugins upgraded?

9 Likes

Yes – plugins should get upgraded upon bootstrap.

5 Likes

Just wow!
Nice work!

2 Likes

IMO, this deserves to be in core.

6 Likes

So, would it be worth removing my existing plugins from the app.yml file and moving them to this installer?

I have to admit that I’m conflicted on this one. It would really cool to be in core but if it’s in core, installing plugins will only work on Docker installs and non-multisite installs. That would cause problems for a quite a lot of instances.

Technically, it doesn’t matter. They end up being installed in exactly the same way. This just makes it easier to do.

6 Likes

I assume the challenges associated with getting it to work with multisite are far more complex then getting to set up multisite (which none of my clients have deployed) and I’m saying that from managing over 2 dozen active discourse installations.

It should be easier to include this in the standard app.yml on bootstrap for the standalone installs and not including the same in a multisite/multi container/HA setup.

It could always be part of core (with a big warning label that says “only works with docker”) but leave the current install method available as well.

Even better if there’s a way to detect a compatible installation and hide or show itself as necessary.

4 Likes

The main challenge is precompiling assets and such. We’re effectively adding the repo to the /plugins and then running an docker manager upgrade on that specific plugin. That handles the magic side of it.

But in a multisite, you run into issues because you don’t want one instance to be able to make edits for all instances in the multisite.

4 Likes

How i can uninstall a plugin using ssh? Because i installed Moderator Extension and now I cant put it anymore online, Error 502

Assuming you can’t get to the admin panel:

  1. SSH into the server.
  2. cd /var/discourse
  3. ./launcher enter app
  4. vim /shared/tmp/procourse-installer/plugins.txt
  5. Remove the offending plugin from the file.
  6. exit
  7. ./launcher rebuild app
4 Likes

Cant up online :cry:

Looks like your container isn’t running. Try this ./launcher start app

3 Likes

Thank You, my error 502 now are resolved. :smiley:

2 Likes

I think the installer is working fine but I saw this in my error log, not sure if it’s anything but thought I’d might as well bring it up:

NameError (uninitialized class variable @@install_state in ProcourseInstaller::InstallController)
/var/www/discourse/plugins/procourse-installer/app/controllers/procourse_installer/install_controller.rb:4:in `status'
2 Likes

Interesting. Do you have any guesses about what you were doing when that error came to be?

1 Like

Some 20 or so days ago, I installed this Procourse plugin, and another plugin (I forgot which one was it) thru this plugins interface.
After a few days, I found that many times (say once every few days) my website went dead slow. On those moments, even safe mode opening went equally slow. And after 20-30 minutes I found that the speed of my site became normal.

Although I have not got necessary skills to diagnose the logs, but since the logs’ (or was it sidekiq?) warning section contained ‘procourse’ so many times, I thought it is somehow related to this plugin installed inside/thru procourse plugin. So I uninstalled that plugin from procourse interface.

But yesterday it again (almost) crashed.
I checked and again found the word ‘procourse’ written in many many warnings in logs.

So today I decided and uninstalled procourse too.

Now my fingers are strongly crossed.

Can you share the backtrace of one of those errors? That would help us narrow down where it’s coming from.

1 Like

Since I have Uninstalled the plugin for the time being. I can have the logs sent only when next occurrence occurs.

(I don’t know if logs are kept for 2-3 days or not, if they are, then I can try).

Thanks.