diff --git a/docs/admin/outline.rst b/docs/admin/outline.rst index 9cd13ecbf9..fff93746e1 100644 --- a/docs/admin/outline.rst +++ b/docs/admin/outline.rst @@ -1,11 +1,140 @@ Administrative Functions ======================== +.. note:: -testing + These docs are out of date. If you are interested in updating these (preferably with screenshots) let us know on the `community forum `_ because we are planning on a design overhaul of the ACP soon. -testing -------- +**To view the admin panel** (if you are an admin): `http://your_nodebb_domain.com/admin` -testing \ No newline at end of file +**Top Menu** (all can be easily reached by other means) + * NodeBB ACP (Administrator Control Panel: this view) + * `http://your_nodebb_domain.com/admin/index` (see Home below) + * Forum + * `http://your_nodebb_domain.com` (your main forum) + * Home + * `http://your_nodebb_domain.com/admin/index` (see Home below) + * Settings + * `http://your_nodebb_domain.com/admin/settings` (see Settings below) + +**Side Menu: NodeBB** + * Home + * `http://your_nodebb_domain.com/admin/index` + * Links all go to nodebb.com homepage + * NOTE: should all the links go to same place? + * Message reminder of what version this is and to check for updates (See [[Upgrading NodeBB]]) + * NOTE: would a link to where the latest stable version is help? + * Active Users + * lists number users per page-path (?) + * NOTE: not clear exactly what the paths mean or how to visit that path + + + * Categories + * `http://your_nodebb_domain.com/admin/categories` + * Filters: Active, Disabled, Unit Tests + * List of Categories: + * Icon, Name, Desc, Action: Disable + * Actions: Save, Add New + + * Users + * `http://your_nodebb_domain.com/admin/users` + * Filters: Latest Users, Top Posters, Most Reputation, Action: Search + * List of Users: + * Icon, Link: Name, Reputation(star), Number Posts(pencil), Action: Ban + * Action: Load More + + * Groups + * `http://your_nodebb_domain.com/admin/groups` + * List of Groups + * Name, Desc, Icon + * Action: Delete Group + * NOTE: What exactly can Groups be set up to do, besides Admin? + + * Topics + * `http://your_nodebb_domain.com/admin/topics` + * List of Topics + * Name [link to topic], Posted When and By, Number posts (Topic+Replies), Thread Actions: Pin(pushpin), Lock(lock), Delete(trashcan) + * Action: Load More Topics + + * Topic [from List of Topics link] + * Normal View of Topic+Reply Posts but with: + * Link, Edit, Delete Actions all enabled for each Post + * Thread Tools: + * Pin, Lock, Move, Delete + + * Themes (See [[Theming NodeBB]]) + * `http://your_nodebb_domain.com/admin/themes` + * List of (Custom | Bootswatch) Themes + * Actions: Use, Preview + * Action: Revert (to base) + + * Plugins (See [[Writing Plugins for NodeBB]]) + * `http://your_nodebb_domain.com/admin/plugins` + * List of Plugins + * Action: De/activate + * Info on making plugins + + * Settings + * `http://your_nodebb_domain.com/admin/settings` + + * General Settings + * (textbox) Site Title + * (textbox) Site Description + * (textbox) Site Keywords + * (textbox) Imgur Client ID + * NOTE: How does this function? + * (textbox) Maximum User Image Size + + * Privilege Thresholds (Use privilege thresholds to manage how much reputation a user must gain to receive moderator access.) + * (textbox) Manage Thread + * (textbox) Moderate Users + * (textbox) Create Pinned Topics + + * Email Settings + * (textbox) Email Address (The following email address refers to the email that the recipient will see in the "From" and "Reply To" fields.) + * (textbox) SMTP Server Host (Default: 127.0.0.1) + * (textbox) SMTP Server Port + + * User Settings + * (textbox) Minimum Username Length + * (textbox) Maximum Username Length + * (textbox) Minimum Password Length + + * Post Settings + * (textbox) Post Delay + * (textbox) Minimum Title Length + * (textbox) Minimum Post Length + * (checkbox) Use Outgoing Links Warning Page + + * Action: Save + + * Redis + * `http://your_nodebb_domain.com/admin/redis` + * Redis data storage stats + + * Logger + * `http://your_nodebb_domain.com/admin/logger` + * (checkbox) Enable HTTP logging + * (checkbox) Enable socket.io event logging + * (textbox) Path to log file + + * MOTD (Message of the Day) + * `http://your_nodebb_domain.com/admin/motd` + * (textarea) You can enter either full HTML or Markdown text. + * (checkbox) Show the Message of the Day + +**Side Menu: Social Authentication** (See [[Enabling Social Network Logins]]) + + * Twitter + * `http://your_nodebb_domain.com/admin/twitter` + + * Facebook + * `http://your_nodebb_domain.com/admin/facebook` + + * Google+ + * `http://your_nodebb_domain.com/admin/gplus` + +**Side Menu: Plugins** (Shows installed plugins) + +**Side Menu: Unit Tests** (Will run qunit tests) \ No newline at end of file diff --git a/docs/admin/sso.rst b/docs/admin/sso.rst index cb9119ac44..6c4d3bd23f 100644 --- a/docs/admin/sso.rst +++ b/docs/admin/sso.rst @@ -1,11 +1,45 @@ Enabling Social Network Logins ============================== +NodeBB supports integration for Facebook, Twitter, and Google through third party plugins: -testing +* `npm install nodebb-plugin-sso-facebook` +* `npm install nodebb-plugin-sso-twitter` +* `npm install nodebb-plugin-sso-google` +Other SSO vendors are available, such as GitHub. Please check the `plugin directory `_ for a list of all SSO vendors. -testing -------- +After installing and activating them, they require an API key in order to function: -testing \ No newline at end of file +Facebook +--------- + +Register an application via the `Facebook Developers `_ page. A credit card or mobile phone number may be required in order to create a Developer account. + +Create a new application, and obtain an Application Key and Application Secret: + +.. image:: http://i.imgur.com/hfy0eVo.png + +Ensure that "Website with Facebook Login" is checked, and that the URL to your NodeBB instance is specified in the "Site URL" box. Add that site's domain to the "App Domains" field. + +Paste this key and secret into the appropriate boxes in the NodeBB Administration Panel (accessible via /admin on your NodeBB install) + +Twitter +--------- + +Register an application at the `Twitter Developers `_ page. Create a new Application, and obtain the Access Token and Secret: + +.. image:: http://i.imgur.com/ksrHkgN.png + +**Important**: While setting up your application, be sure to specify a Callback URL. It does not have to correspond to your installation, it just cannot be blank. + +Paste this token and secret into the appropriate boxes in the NodeBB Administration Panel (accessible via /admin on your NodeBB install) + +Google +--------- + +Register an application at the `Google API Console `_, and obtain a Client ID and Secret. + +.. image:: http://i.imgur.com/xutDs1R.png + +Paste this ID and secret into the appropriate boxes in the NodeBB Administration Panel (accessible via /admin on your NodeBB install) \ No newline at end of file