Adding default sets of topics, categories and users to a new Discourse


(Jay Pfaffman) #1

I have another university professor interested in using Discourse as a tool to run online classes. I would like to have a means to create an initial Discourse database with a set of sample categories and topics. For example,

  • each course will have a set of categories/subcategories with appropriate permissions;
  • there need to be additional topics in the Staff category about how to organize things
  • Badges for submitting assignments and getting instructor approval
  • I want to tweak the language in some of the default staff posts for people who don’t know what system administration is

I think that perhaps the easiest/best way to do this is to set up a fresh install, set stuff up like I want it, and back that up. Those who want to use my system would do a fresh install and restore my database. Does that sound right? Is there some other way? Might I want to do this as a template instead and use db/fixtures/999_topics.rb as a model?


(Jay Pfaffman) #2

I just noticed that there is a topic and category import/export command line tool. This solves half my problem, as I can now put all of my customizations in a LMS category and export:

This will make it easy/possible to include the exported JSON file with my set of scripts that support creating badges for assignments and so on.


(Neil Lalonde) #3

A similar badge export/import tool would probably be very handy too.


(Jay Pfaffman) #4

Indeed it might. For now I have created a Python script that creates sets of badges (bronze, silver, gold for people who post in a certain category with a given tag). My target audience probably won’t be likely to be popping into a shell and running rails commands, though.


(Erick Guan) #5

In this way, you lose the time axis. Your default topic may looks out of date.

I guess your case is highly customized given different time. But the previous data doesn’t need to change since they will be archived just like Moodle.

I would suggest two ways:

  • If your data doesn’t evolved rapidly and it can be deduced from default site settings, you can go with a plugin. In this plugin, several seed_data can be registered (it’s the way to override admin start guide for plugin authors) as well as a lib task. Later on, you invoked this lib task.
  • While the previous may not be that customizable, you can however make use of a rake task. Visiting a HTTP url (securely), downloading and commit all changes. Basically everything you can do in the console can be done by rake task.

It’s been quite easy to invoke the rake task for Discourse Docker. Running rake in custom commands and you are good to go. In both case, you have to protect the rake task running twice which might fit your case. This can be achieved by a timestamp parameter. (Well, I don’t have an good idea now)

Besides, you have every rights to generate an admin API by rake apikey:get and use it whatever you want. Though you still need to use custom commands to trigger the rake task and collect it (securely).

Basically, depends on what you need to do :slight_smile:


(Jay Pfaffman) #6

That sounds like what I need to do. I’ll poke through some plugins and look for an example of seed_data. I don’t remember seeing that in the plugin guides, but that may be because I wasn’t looking. :slight_smile:

Thanks!


(Erick Guan) #7

Sorry, I checked the seed_data which is a plain hash and only used for overriding the admin starter guide. It’s not really useful in your case.

But a rake task is still worthing considered but you have to prevent it from running twice (maybe define a site setting for checking this). In this way, you would end up with a configurable ruby script as your need/create.

Task db.rake may be a good start.