Skip to content

Commit

Permalink
new files for dashboard and index
Browse files Browse the repository at this point in the history
  • Loading branch information
julianlam committed May 12, 2016
1 parent fcae813 commit 72a7d40
Show file tree
Hide file tree
Showing 2 changed files with 47 additions and 0 deletions.
34 changes: 34 additions & 0 deletions admin/dashboard.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,34 @@
ACP / Dashboard
===============

The dashboard shows an at-a-glance overview of your NodeBB, including
pageviews collated by time and day, and other interesting metrics such
as current active user count and user location.

System Control
~~~~~~~~~~~~~~

The "Reload", "Restart", and "Maintenance Mode" buttons allow you to
administer the running process of NodeBB.

- **Reload** - refreshes all stylesheets, js files, and templates.
Clears caches if there are any. The NodeBB server is kept running.
- **Restart** - Brings down the NodeBB server and starts it up again.
Refreshes all assets and clears all caches. A restart is recommended
if you have activated or deactivated plugins.
- **Maintenace Mode** - Brings you to the maintenance mode page,
allowing you to temporarily restrict access to your forum.

Updates
~~~~~~~

The updates section queries the NodeBB project for a new version of
NodeBB, and determines whether you are up-to-date. There is no
requirement to update NodeBB, although it is usually recommended in
order to obtain the latest features and bug fixes.

Notices
~~~~~~~

The notices allows NodeBB and various plugins to quickly determine if
action is required (e.g. if a restart is required).
13 changes: 13 additions & 0 deletions admin/index.rst
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
Administrative Functions
========================

The *Administrative Control Panel* (ACP) allows you to alter the
behaviour of NodeBB, as well as customise various parts of its look and
feel. Administrative functions such as user and group management are
available from here.

The ACP is only accessible to administrators, and thus should be
protected from unauthorised access whenever possible.

- `Dashboard </admin/dashboard>`__

0 comments on commit 72a7d40

Please sign in to comment.