"Fossies" - the Fresh Open Source Software Archive

Member "discourse-3.1.3/docs/ADMIN-QUICK-START-GUIDE.md" (9 Nov 2023, 12991 Bytes) of package /linux/www/discourse-3.1.3.tar.gz:

As a special service "Fossies" has tried to format the requested source page into HTML format (assuming markdown format). Alternatively you can here view or download the uninterpreted source code file. A member file download can also be achieved by clicking within a package contents listing on the according byte size field. See also the last Fossies "Diffs" side-by-side code changes report for "ADMIN-QUICK-START-GUIDE.md": 3.0.6_vs_3.1.0.

A hint: This file contains one or more very long lines, so maybe it is better readable using the pure text view mode that shows the contents as wrapped lines within the browser window.

Congratulations, you are now the proud owner of your very own Civilized Discourse Construction Kit. 🐣

1. Initial setup

Discourse is a powerful, versatile platform with many options. To help you make sure you're covering all the bases as you get started with your new community, we provided some checklists and guidance below. If you haven't already, complete the Setup Wizard which covers the essentials.

You now also need to test your email to make sure it is configured correctly, otherwise new signups and notifications will not work.

For more assistance on configuring and running your Discourse forum, see meta.discourse.org.

It is essential that you provide a meaningful name and description for your site, so your members immediately know what your community is about. Also edit the welcome topic. In a few sentences, let everyone know who this community is for, what they can expect to find here, and what you'd like them to do as soon as they arrive.

[] Add your site name and description [] Edit your welcome topic

You are responsible for providing your organization's details and legal notices. Discourse will place boilerplate templates in your #staff category when you add your company name in the setup wizard.

[] Add your company name and details [] Edit the boilerplate TOS or provide a link to the TOS on your main site [] Edit the boilerplate Privacy Notice or provide a link to the Privacy Notice on your main site

Customization options

Out of the box, Discourse provides a clean, friendly design. Via the setup wizard and admin dashboard, you can make changes easily to make your site look and feel unique. No special skills are required, but advanced options are available if you have access to the tech skills.

[] Upload logo images [] Change the color scheme [] Change the font used for text and headers [] Install a different site theme [] Choose a different homepage style [] Customize the default categories and tags shown on the sidebar [] Add a custom section to the sidebar [] Add custom user fields to let members provide more info about themselves

[details="Advanced options"]

Discourse is very configurable and there is a great deal programmers and web designers can do to customize it, integrate it into other platforms, or address any use case. Users going down this route are highly encouraged to join meta.discourse.org, our support community, to learn from what others have and to give and get advice.

[] Add one or more social login options: Google, Twitter, Facebook, GitHub, Discord, Apple, Amazon, LinkedIn, and Microsoft [] Embed Discourse in your WordPress website, or on your static HTML site [] Set up single-sign on with your main site [] Build your own login method [] Create your own theme [] Interact with Discourse from other applications using the API [/details]

2. Invite your members

Once you've done the initial setup, you're ready to invite your founding members who can help you finish setup and get some conversations started. Go to your invites page and look for the + Invite button to create invite links you can share or directly email everyone you want to have in your community. Be sure to follow up to make sure they join and start participating!

To complete together with your founding members

[] Founding members sign up and commit to visiting and participating regularly (at least 3 recommended) [] Members provide their name, bio and picture [] Create interesting topics (at least 5 topics and 30 replies recommended) [] Start talking in chat [] Talk in #feedback about how to use the site and how it is organized [] Review and edit the provided Community Guidelines (FAQ)

When you're ready, launch your community!

[] For public sites, link your community everywhere and promote it so people can find it! [] Send out invitations by email and by sharing invite links in channels used by your community (you can also create bulk invites and invite users into groups) [] Keep following up to make sure as many people as possible are joining and communicating with each other on your Discourse site

Note: To make launching your new site easier, all new members will have daily email summary emails enabled (instead of the usual weekly) and be given a higher level of trust. See below to learn more about the trust system and bootstrap mode.

3. Managing your forum

Admin and Moderator tools

Exercise your admin superpowers anytime via the admin dashboard. You can access it via the 🔧 admin link on the menu. Admin and moderator functions are generally marked with the wrench 🔧 icon, so look for that.


Staff members are official representatives of this community. There are two kinds of Staff in Discourse:

  1. Admins, who can do anything and configure anything on this site.
  2. Moderators, who can edit all posts and users but cannot add categories or change any site settings.

Promoting members of your community is easy:


You have three default categories:

  1. General – create topics here that don't fit into any other existing category.
  2. Site Feedback – Discussion about this site, its organization, how it works, and how you and your community can improve it. It's important!
  3. Staff – Visible only to staff (admins and moderators) Only create a few initial categories, as you can overwhelm your community. You can always add more categories later and easily bulk recategorize topics. You and your members will have a better experience if you figure out the organization as you go rather than assuming you'll get it all right from the beginning.

Select the 🔧 admin wrench on the categories page to add a category. You can set security per-category so only certain groups of users can see topics in that category.

Every category has an initial "About this category" topic which you will want to edit to suit your needs. This topic will be pinned to the top of the category, and the description you enter in the first paragraph will appear throughout. Be sure to give your new category a good, clear description, so people understand what belongs there!

In addition to categories, Discourse allows you to organize topics with tags. Tags offer a flexible alternative to categories. Create tags when editing topics.

Pinned topics and banners

Note how pinning topics works in Discourse:

If a pin isn't visible enough, you can also turn one single topic into a banner. The banner topic floats on top of all topics and all primary pages. Users can permanently dismiss this floating banner by clicking the × in the upper right corner.

To make (or remove) a pin or banner, use the topic 🔧 admin wrench.

Forum moderation and community building

Discourse has a trust level system where users earn trust over time and gain abilities to assist in governing their community. The trust level system is designed to offer safe defaults, even for public communities with no active moderation. You should not have to change them. For more details, see Understanding Trust Levels.

0 (new) → 1 (basic) → 2 (member) → 3 (regular) → 4 (leader)

To make launching your new site easier, all new users will have daily email summary emails enabled (instead of the usual weekly) and be given a higher level of trust that allows them to bypass new user restrictions. Once you've reached a certain number of users (adjustable via the Bootstrap mode admin setting) new users will have to spend 15 minutes reading to remove new user restrictions, or be invited by another trusted user.

4. Maintaining your Discourse server

Test Your Email

Email is required for new account signups and notifications. Test your email to make sure it is configured correctly! Visit the admin email settings, then enter an email address in the "email address to test" field and click send test email.

If you'd like to enable replying to topics via email, see this howto.


Optional things you might eventually want to set up

[] Automatic daily backups [] HTTPS support [] Content Delivery Network support [] Reply via Email [] Import and Export your data [] Change the domain name [] Multiple Discourse instances on the same server [] Import old content from vBulletin, PHPbb, Vanilla, Drupal, BBPress, etc [] Configure a firewall on your server. [] A user friendly offline page when rebuilding or upgrading

Resources and help are a click away

Have suggestions to improve or update this guide? Submit a pull request.