codeninjasllc/discourse
1
0
Fork 0
mirror of https://github.com/codeninjasllc/discourse.git synced 2024-11-27 09:36:19 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions
discourse/docs/ADMIN-QUICK-START-GUIDE.md

9 KiB
Raw Blame History

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

Getting Started

If you haven't already, launch the setup wizard and go through the steps to configure your site. You can run the wizard as many times as you want, it's completely safe!

Admin Dashboard

Exercise your admin superpowers any time via the admin dashboard at

/admin

You can also access it via the "hamburger" ☰ menu in the upper right: Admin functions are generally marked with the wrench 🔧 icon, so look for that.

Staff

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

  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.

To add additional staff members:

Social Logins

Users can log in with traditional local username and password accounts. You may want to add:

You can also set up single-sign on, or even build your own login method.

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.

  • You got the test email? Great! Read that email closely, it has important email deliverability tips.
  • You didn't get the test email? This means your users probably aren't getting any signup or notification emails either.
  • Email deliverability can be hard. Read Email Service Configuration.

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

Categories

You have three default categories:

  1. Site Feedback – general discussion about the site itself. It's important!
  2. Lounge – a perk for users at trust level 3 and higher
  3. Staff – visible only to staff (admins and moderators)

Don't create too many initial categories, as you can overwhelm your audience. You can always add more categories, and easily bulk recategorize topics later. It's better to figure out the organization as you go rather than assuming you'll get it all right from the beginning (hint: you won't).

To add a category, visit the categories page, then click Create Category at the upper right. 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. This topic will be pinned to the top of the category, and the description you enter will be used in a bunch of places. Be sure to give your new category a good, clear description, so people understand what belongs there!

Pinned Topics and Banners

Note that pinning topics does work a little differently in Discourse:

  • Once someone reads to the bottom of a pinned topic, it is automatically unpinned for them specifically. They can change this via the personal pin controls at the bottom of the topic.
  • When staff pins a topic, they can pin it globally to all topic lists, or just within its category.

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 a banner, use the admin wrench at the top right or bottom of the topic.

New User Sandbox and the Trust System

If your discussion area is be open to the public, new visitors will arrive that are initially strangers to the community. Discourse has a trust system where users can, over time, earn the trust of the community and gain abilities to assist in governing their community.

Discourse is designed to offer safe defaults for public communities, even with no active moderation.

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

All new users start out in a sandbox with restrictions for everyone's safety. Trust level 0 (new) users cannot …

  • post more than 2 hyperlinks
  • post any images or file attachments
  • send private messages
  • flag posts or topics
  • have actual links in the "about me" field of their profile
  • @name mention more than 2 users in a post

Every action a user can take is rate limited for safety, and especially so for new users. But don't worry, new users can transition to trust level 1 in about 10 minutes of reading.

These defaults are safe, but note that while in "bootstrap mode" after you set up your site, all new users will be granted trust level 1 until you reach 50 users.

Building Your Community

Be patient; building communities is hard. Before launching, be sure to:

  1. Clearly define your community's purpose in a pinned or banner topic.
  2. Seed the discussion with interesting topics.
  3. Commit to visiting and participating regularly.
  4. Link your community everywhere and promote it so people can find it.

There's more advice at Building a Discourse Community.

Sending Invitations

One way to get people to visit your site is to invite them via email. You can do this via:

  • The Invite button at the bottom of the topic.
  • The Invite area on your profile page.

The invite area on your profile page also includes advanced Staff methods of sending bulk invites, and inviting users into groups.

Maintenance

Need more Help?

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

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