Discource-C
/
discourse
mirror of https://github.com/discourse/discourse.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

further improvements to Admin Quick Start Guide

This commit is contained in:
Jeff Atwood 2014-07-11 15:32:25 -07:00
parent ff57e704bc
commit 572b8e0664
1 changed files with 27 additions and 22 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

49
docs/ADMIN-QUICK-START-GUIDE.md
View File

@ -22,7 +22,7 @@ By default you get the same standard generic "penciled in" Discourse logo everyo
To quickly give your Discourse a distinctive look, without having to edit or understand CSS, create a new color scheme via [Customize, Colors](/admin/customize/colors).
You can also specify custom CSS and custom HTML headers/footers to further customize the look. One common request is a navigation header that takes you back to the parent site. Here is some example HTML to put in [Customize, CSS and HTML Customizations](/admin/customize/css_html) under "Header":
You can also specify custom CSS and custom HTML headers/footers to further customize the look. One common request is a navigation header that takes you back to the parent site. Here is some example HTML to put in [Customize, CSS/HTML](/admin/customize/css_html) under "Header":
```
<div id="top-navbar" class="container">
@ -39,7 +39,7 @@ You can also specify custom CSS and custom HTML headers/footers to further custo
### Establish Staff
You are the only staff member right now. Staff members are official representatives of this community:
Staff members are official representatives of this community, and you are the only staff member right now. 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.
@ -54,7 +54,7 @@ Discourse assumes you want a public discussion area. If you prefer a private one
- `login_required`
- `invite_only`
If you only want some parts of your site to be private, edit permissions on a category. The built-in Staff category is an example.
If you only want some parts of your site to be private, edit category permissions. And you already have one private category: this topic is in it!
### Configure Login Methods
@ -65,22 +65,22 @@ By default, users can only log in with traditional local username and password a
- [Configure Facebook logins](https://meta.discourse.org/t/configuring-facebook-login-for-discourse/13394)
- [Configure GitHub logins](https://meta.discourse.org/t/configuring-github-login-for-discourse/13745)
If you want to get extra-fancy you can also [set up single-sign on](https://meta.discourse.org/t/official-single-sign-on-for-discourse/13045), or even [build your own oAuth 2 login](https://meta.discourse.org/t/login-to-discourse-with-custom-oauth2-provider/14717).
If you want to get extra-fancy you can also [set up single-sign on](https://meta.discourse.org/t/official-single-sign-on-for-discourse/13045), or even [build your own login method](https://meta.discourse.org/t/login-to-discourse-with-custom-oauth2-provider/14717).
### Test Email
### Test Your Email
If email is not working, you have a broken Discourse &ndash; email is required for new account signups and notifications. **Test your email to make sure it is configured correctly!** Visit [the admin email settings](/admin/email), then enter an email address in the "email address to test" field and click <kbd>send test email</kbd>.
Email is required for new account signups and notifications. **Test your email to make sure it is configured correctly!** Visit [the admin email settings](/admin/email), then enter an email address in the "email address to test" field and click <kbd>send test email</kbd>.
- 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. We strongly recommend using dedicated email services like [Mandrill](http://mandrill.com), [MailGun](http://www.mailgun.com/), or [MailJet](http://www.mailjet.com/), which offer generous free plans that work fine for most communities.
If you'd like to enable *replying* to topics via email, [see this howto](https://meta.discourse.org/t/set-up-reply-via-email-support/14003).
(If you'd like to enable *replying* to topics via email, [see this howto](https://meta.discourse.org/t/set-up-reply-via-email-support/14003).)
### What and Who is this site for?
One of the default topics is [Welcome to Discourse](/t/welcome/6). This topic is pinned globally, so it will appear on the homepage for all new users. Your welcome topic is important because it is the first thing you visitors will see:
One of the default topics is [Welcome to Discourse](/t/welcome/6). This topic is pinned globally, so it will appear on the homepage, right at the top of the topic list, for all new users. Your welcome topic is important because it is the first thing you visitors will see:
- Where am I?
- Who is this discussion area for?
@ -91,9 +91,13 @@ One of the default topics is [Welcome to Discourse](/t/welcome/6). This topic is
Note that pinning topics works a little differently in Discourse:
- Users can hide pins on topics once they have read them via the controls at the bottom of the topic, so they don't stay pinned forever for everyone.
- Users can hide pins on topics once they have read them via the controls at the bottom of the topic, so they aren't always pinned forever for everyone.
- When you pin a topic, you can choose to pin it globally to all topic lists, or pin it only 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 &times; in the upper right corner.
To make (or remove) a pin or a banner, use the admin wrench at the top right of the topic.
### Build Your Own FAQ
Right now [your FAQ](/faq) is the same Creative Commons [universal rules of civilized discourse](http://blog.discourse.org/2013/03/the-universal-rules-of-civilized-discourse/) we provide to all Discourse installs. These built-in community guidelines are referenced a bunch of places; please *do* use them and refer to them often -- they really work!
@ -114,15 +118,15 @@ Done -- now you have a community FAQ for your site that is collaboratively edita
You have three categories out of the box:
1. [meta](/category/meta) – general discussion about the site itself. [It's important!](https://meta.discourse.org/t/what-is-meta/5249)
2. [lounge](/category/lounge) – a perk for users at trust level 3 and higher
3. [staff](/category/staff) – visible only to staff (admins and moderators)
1. [Meta](/category/meta) – general discussion about the site itself. [It's important!](https://meta.discourse.org/t/what-is-meta/5249)
2. [Lounge](/category/lounge) – a perk for users at trust level 3 and higher
3. [Staff](/category/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 later, and easily bulk recategorize topics any time. It's better to figure out organization as you go rather than assuming you'll get it all right from the beginning (hint: you won't).
**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](/categories), 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 the {foo} category" topic created alongside it. This topic will be pinned to the top of the category, and the description you enter here will be used in a bunch of places. Be sure to give your new category a good, clear description!
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!
### File Uploads
@ -135,13 +139,13 @@ Basic image uploads work fine out of the box stored locally, provided you have a
### 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.
If your discussion area is be open to the public, new visitors will arrive that are initially strangers to the community. There is a [trust system in Discourse](https://meta.discourse.org/t/what-do-user-trust-levels-do/4924/2) where users can, over time, earn the trust of the community and automatically gain abilities to assist in governing the community.
Discourse is designed to offer safe defaults for public communities, even with no active moderation. There is a [trust system in Discourse](https://meta.discourse.org/t/what-do-user-trust-levels-do/4924/2) where regular users automatically earn abilities to assist in governing the community.
Discourse is designed to offer safe defaults for public communities, even with no active moderation.
> **0 (new) &rarr; 1 (basic) &rarr; 2 (regular) &rarr; 3 (leader) &rarr; 4 (elder)**
All new users start out at trust level zero, in a sandbox with restrictions for everyone's safety. **Trust level zero users _cannot_** &hellip;
All new users start out in a sandbox with restrictions for everyone's safety. **Trust level 0 (new) users _cannot_** &hellip;
- post more than 2 hyperlinks
- post any images or file attachments
@ -150,7 +154,7 @@ All new users start out at trust level zero, in a sandbox with restrictions for
- have actual links in the "about me" field of their profile
- @name mention more than 2 users in a post
There are also a lot of rate limits around how many actions new users can take. Of course, new users don't stay new users forever; reading a variety of topics is enough to [transition to trust level 1](https://meta.discourse.org/t/what-do-user-trust-levels-do/4924/2) in about 15 minutes.
Virtually 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](https://meta.discourse.org/t/what-do-user-trust-levels-do/4924/2) in about 15 minutes.
These defaults are safe, but they may be too conservative for your site:
@ -177,19 +181,20 @@ Number 3 is the Discourse default &ndash; that's [Creative Commons BY-NC-SA 3.0]
### Maintenance
- One CPU and 1GB of memory, with swap, is the minimum for a small Discourse community. As your community grows you may need more memory or CPU resources.
- One CPU and 1GB of memory, with swap, is the minimum for a basic Discourse community. As your community grows you may need more memory or CPU resources.
- Hopefully you are running [in our Docker container install](https://github.com/discourse/discourse/blob/master/docs/INSTALL.md); it's the only one we officially support. That will guarantee easy updates, and all recommended optimizations from the Discourse team.
- Hopefully you are running [in our Docker container install](https://github.com/discourse/discourse/blob/master/docs/INSTALL.md); it's the only one we officially support. It guarantees easy updates, and all recommended optimizations from the Discourse team.
- To upgrade your instance, visit [/admin/docker](/admin/docker). If there's a new version, an <kbd>upgrade</kbd> button will appear. Press it!
- You should get an email notification when new versions of Discourse are released. To upgrade your instance, visit [/admin/docker](/admin/docker) -- <kbd>upgrade</kbd> button will appear. Press it!
- Some other things you might eventually want to set up:
- [Automatic daily backups](https://meta.discourse.org/t/configure-automatic-backups-for-discourse/14855)
- [HTTPS support](https://meta.discourse.org/t/allowing-ssl-for-your-discourse-docker-setup/13847)
- [Content Delivery Network support](https://meta.discourse.org/t/enable-a-cdn-for-your-discourse/14857)
- [Multiple Discourse instances on the same server](https://meta.discourse.org/t/multisite-configuration-with-docker/14084)
- [Reply via Email](https://meta.discourse.org/t/set-up-reply-via-email-support/14003)
- [Import and Export your data](https://meta.discourse.org/t/move-your-discourse-instance-to-a-different-server/15721)
- [Change the domain name](https://meta.discourse.org/t/how-do-i-change-the-domain-name/16098)
- [Multiple Discourse instances on the same server](https://meta.discourse.org/t/multisite-configuration-with-docker/14084)
### Need more Help?