codeninjasllc/discourse
1
0
Fork 0
mirror of https://github.com/codeninjasllc/discourse.git synced 2024-11-23 23:58:31 -05:00
Code Issues Projects Releases Packages Wiki Activity Actions

Update admin quick start guide

Browse source
This commit is contained in:
Neil Lalonde 2014-02-12 14:50:01 -05:00
parent a929eda8ba
commit 6ceb4f2656
1 changed files with 31 additions and 31 deletions
Show stats Download patch file Download diff file Expand all files Collapse all files

34
docs/ADMIN-QUICK-START-GUIDE.md
View file

@ -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. 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 ### Access the Admin Console
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>
To access the Discourse admin console, add `/admin` to the base URL, like so: To access the Discourse admin console, add `/admin` to the base URL, like so:
@ -25,6 +14,15 @@ 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. 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 ### Enable Twitter Logins
1. From the Administrative console above, enter **Site Settings**. 1. From the Administrative console above, enter **Site Settings**.
@ -47,7 +45,7 @@ From here, you'll be able to access the Admin functions, all of which are very i
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. 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`. 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**. 1. From the Administrative console above, enter **Site Settings**.
2. Scroll down to the two text fields named: 2. Scroll down to the two text fields named:
@ -58,9 +56,11 @@ From here, you'll be able to access the Admin functions, all of which are very i
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. 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`. 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: Categories are the **colored labels** used to organize groups of topics in Discourse, and they are completely customizable:
@ -98,7 +98,7 @@ You'll also need to make an important legal decision about the content users pos
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). 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". 1. Access the Administrative console, and select "Customize".