Update admin quick start guide
This commit is contained in:
Neil Lalonde
parent
a929eda8ba
commit
6ceb4f2656
|
|
@ -4,20 +4,9 @@ You are now the proud owner of your very own Civilized Discourse Construction Ki
|
|||
|
||||
You can login via the blue "Log in" button in the upper-right hand corner of Discourse.
|
||||
|
||||
Not an admin? If you used the [official install guide](https://github.com/discourse/discourse/blob/master/docs/INSTALL-ubuntu.md) you can use the following commands (taken from that guide) to elevate your account privileges:
|
||||
If you added your email address to the `developer_emails` setting in your discourse.conf file, or included it in the DISCOURSE_DEVELOPER_EMAILS environment variable, then be sure to use that email address in the signup form so that you're automatically granted admin privileges. If not, then be sure to do that and restart Discourse.
|
||||
|
||||
# Run these commands as the discourse user
|
||||
cd ~/discourse
|
||||
# ~/discourse or /var/www/discouse depending on where discourse is installed
|
||||
RAILS_ENV=production bundle exec rails c
|
||||
|
||||
# (in rails console)
|
||||
> me = User.find_by_username_or_email('myemailaddress@me.com')
|
||||
> me.activate #use this in case you haven't configured your mail server and therefore can't receive the activation mail.
|
||||
> me.admin = true
|
||||
> me.save
|
||||
|
||||
### Access the Admin Console<p>
|
||||
### Access the Admin Console
|
||||
|
||||
To access the Discourse admin console, add `/admin` to the base URL, like so:
|
||||
|
||||
|
|
@ -25,13 +14,22 @@ To access the Discourse admin console, add `/admin` to the base URL, like so:
|
|||
|
||||
From here, you'll be able to access the Admin functions, all of which are very important, so do check each one out.
|
||||
|
||||
### Required Settings
|
||||
|
||||
Go to the Required tab of the Settings tab in admin (`/admin/site_settings/category/required`) and change all the settings listed there.
|
||||
|
||||
To add logos and favicons to your site, create a topic and add the photos to a post in that topic. Click the wrench on the right side of the page and click the Make Invisible button to hide the topic. After submitting the post with the logos for your site, right click on them to get their URLs. Add the URL of the larger logo to the `logo_url` setting, and URL of the smaller logo to the `logo_small_url` setting. Also update the `favicon_url`.
|
||||
|
||||
The admin dashboard at `/admin` is a useful place to check often. If problems are detected with your site settings or deployment, they will be reported there.
|
||||
|
||||
|
||||
### Enable Twitter Logins
|
||||
|
||||
1. From the Administrative console above, enter **Site Settings**.
|
||||
2. Scroll down to the two text fields named:
|
||||
|
||||
`twitter_consumer_key`
|
||||
`twitter_consumer_secret`
|
||||
`twitter_consumer_key`
|
||||
`twitter_consumer_secret`
|
||||
|
||||
3. Enter in your respective **key** and **secret** that is issued to you via dev.twitter.com. If you are unsure of what your key/secret is, or you have yet to obtain one, visit the Twitter Dev API FAQ on [how to obtain these keys](https://dev.twitter.com/docs/faq#7447).
|
||||
4. In the Twitter settings, the callback url must use the path `/auth/twitter/callback` at your domain. e.g., `http://discuss.example.com/auth/twitter/callback`
|
||||
|
|
@ -41,26 +39,28 @@ From here, you'll be able to access the Admin functions, all of which are very i
|
|||
1. From the Administrative console above, enter **Site Settings**.
|
||||
2. Scroll down to the two text fields named:
|
||||
|
||||
`facebook_app_id`
|
||||
`facebook_app_secret`
|
||||
`facebook_app_id`
|
||||
`facebook_app_secret`
|
||||
|
||||
3. Enter in your respective **id** and **secret** that is issued to you via developers.facebook.com. If you are unsure of what your id/secret is, or you have yet to obtain one, visit the [Facebook Developers :: Access Tokens and Types](https://developers.facebook.com/docs/concepts/login/access-tokens-and-types/) page for more information.
|
||||
4. In the Facebook App settings, you must enable "Website with Facebook Login" under "Select how your app integrates with Facebook" and set the Site URL to use the path `/auth/facebook/callback` at your site domain. e.g., `http://discuss.example.com/auth/facebook/callback`.
|
||||
|
||||
### Enable GitHub Logins<p>
|
||||
### Enable GitHub Logins
|
||||
|
||||
1. From the Administrative console above, enter **Site Settings**.
|
||||
2. Scroll down to the two text fields named:
|
||||
|
||||
`github_client_id`
|
||||
`github_client_secret`
|
||||
`github_client_id`
|
||||
`github_client_secret`
|
||||
|
||||
3. Enter in your respective **id** and **secret** that is issued to you via https://github.com/settings/applications/new. If you are unsure of what your id/secret is, or you have yet to obtain one, visit the [GitHub Developers :: Applications](https://github.com/settings/applications/) page for more information.
|
||||
4. Be sure to set the Callback URL to use the path `/auth/github/callback` at your site domain. e.g., `http://discuss.example.com/auth/github/callback`.
|
||||
|
||||
### Creating New Categories<p>
|
||||
### Creating New Categories
|
||||
|
||||
You will get one new category by default, meta. [Check it out! It's important.](http://meta.discourse.org/category/meta) But you may want more.
|
||||
You will get two new categories by default: meta and lounge. [Check out the meta category. It's important!](/category/meta). [The Lounge category](/category/lounge) is a perk for users who reach trust level 3. Only staff and those trusted users can view topics in the Lounge.
|
||||
|
||||
But you may want more.
|
||||
|
||||
Categories are the **colored labels** used to organize groups of topics in Discourse, and they are completely customizable:
|
||||
|
||||
|
|
@ -89,16 +89,16 @@ Make sure you set your company name and domain variables for the [Terms of Servi
|
|||
You'll also need to make an important legal decision about the content users post on your forum:
|
||||
|
||||
> Your users will always retain copyright on their posts, and will always grant the forum owner enough rights to include their content on the forum.
|
||||
>
|
||||
>
|
||||
> Who is allowed to republish the content posted on this forum?
|
||||
>
|
||||
> - Only the author
|
||||
> - Author and the owner of this forum
|
||||
>
|
||||
> - Only the author
|
||||
> - Author and the owner of this forum
|
||||
> - Anybody
|
||||
|
||||
Please see our [admin User Content Licensing](/admin/site_contents/tos_user_content_license) page for a brief form that will let you cut and paste your decision into section #3 of the [Terms of Service](/tos#3).
|
||||
|
||||
### Customize CSS / Header Logos<p>
|
||||
### Customize CSS / Header Logos
|
||||
|
||||
1. Access the Administrative console, and select "Customize".
|
||||
|
||||
|
|
@ -116,20 +116,20 @@ Here is some example HTML that would go into the "Header" section within "Custom
|
|||
|
||||
```
|
||||
<div class='myheader' style='text-align:center;background-color:#CDCDCD'>
|
||||
<a href="/"><img src="http://dummyimage.com/1111x90/CDCDCD/000000.jpg&text=Placeholder+Custom+Header" width="1111px" height="90px" border="0" /></a>
|
||||
<a href="/"><img src="http://dummyimage.com/1111x90/CDCDCD/000000.jpg&text=Placeholder+Custom+Header" width="1111px" height="90px" border="0" /></a>
|
||||
</div>
|
||||
```
|
||||
|
||||
### Write a welcome topic and pin it
|
||||
|
||||
What is this forum for? Who should visit? Write a **brief introductory topic for your forum** that explains what the heck is going on here, so new users who find your forum will have some idea what they're getting into, and what the purpose of your forum is.
|
||||
What is this forum for? Who should visit? Write a **brief introductory topic for your forum** that explains what the heck is going on here, so new users who find your forum will have some idea what they're getting into, and what the purpose of your forum is.
|
||||
|
||||
- Don't write a novel because nobody will read it. What is the "elevator pitch" for your forum? How would you describe this forum to a stranger on an elevator when you have about 1 minute to talk?
|
||||
- do *not* give this topic a category!
|
||||
- after creating the topic, click the wrench icon in the upper right to get the staff menu for the topic
|
||||
- select Pin Topic
|
||||
|
||||
You should know that pinning topics works a little differently in Discourse than other forums.
|
||||
You should know that pinning topics works a little differently in Discourse than other forums.
|
||||
|
||||
- Users can clear pins on topics once they have read them, so they don't stay pinned forever for everyone
|
||||
- Pinned topics with a category will only "stick" to the top of their category
|
||||
|
|
@ -139,7 +139,7 @@ You should know that pinning topics works a little differently in Discourse than
|
|||
|
||||
- Be sure you have at least 2 GB of memory for your Discourse server. You might be able to squeak by with less, but we don't recommend it, unless you are an expert.
|
||||
|
||||
- We strongly advise setting `RUBY_GC_MALLOC_LIMIT` to something much higher than the default for optimal performance. See [this meta.discourse topic for more details][1].
|
||||
- We strongly advise setting `RUBY_GC_MALLOC_LIMIT` to something much higher than the default for optimal performance. See [this meta.discourse topic for more details][1].
|
||||
|
||||
### Need more Help?<p>
|
||||
|
||||
|
|
|
|||
Loading…
Reference in New Issue