From f3fb9285f5fa166a568ab93b9860cccaa5a9878f Mon Sep 17 00:00:00 2001
From: Daniel Berteaud <daniel@firewall-services.com>
Date: Mon, 13 Jul 2015 23:58:18 +0200
Subject: [PATCH] Document the admin area

---
 templates/default/documentation.html.ep | 143 ++++++++++++++++++++++++
 1 file changed, 143 insertions(+)

diff --git a/templates/default/documentation.html.ep b/templates/default/documentation.html.ep
index 7d88d5e..da34151 100644
--- a/templates/default/documentation.html.ep
+++ b/templates/default/documentation.html.ep
@@ -623,6 +623,149 @@ systemctl restart vroom.service</pre>
           reloaded automatically after each modification
         </div>
       </p>
+
+
+      <h1 id="admin_area">
+        Admin area
+      </h1>
+      <p>
+        The admin area is available on /vroom/admin or /admin (depending on how you have configured your web server). 
+        <div class="alert alert-danger">
+          Once again: There's no builtin auth mechanism, your web server must protect this URI
+        </div>
+        This page gives access to several sub menus to manage your VROOM instance
+      </p>
+
+      <h2 id="room_management">
+        Room Management
+      </h2>
+      <p>
+        This page lists all the existing rooms wih some important informations (creation date, last activity, number of participants) and
+        three buttons to manage each room (join, configure, delete)
+      </p>
+
+      <h2 id="audit">
+        Audit
+      </h2>
+      <p>
+        This page is to consult audit logs. Every important event in VROOM is logged
+        <ul>
+          <li>On stdout (ideally captured by systemd's Journal or similar)</li>
+          <li>In the audit table</li>
+        </ul>
+        Each event is composed of the following:
+        <ul>
+          <li><strong>ID</strong>: It's just a unique ID for each event</li>
+          <li><strong>Date</strong>: the date and time of the event</li>
+          <li><strong>IP Address</strong>: The IP address of the user</li>
+          <li><strong>Event</strong>: The type of event (see below)</li>
+          <li><strong>User</strong>: The login of the user</li>
+          <li><strong>Message</strong>: A human readable information describing the event</li>
+        </ul>
+        <div class="alert alert-warning">
+          As all other dates, event dates are stored in the database in UTC and converted in local time when displayed. If you access
+          directly the database to check the events, you'll have to do the conversion yourself
+        </div>
+        <div class="panel panel-default">
+          <div class="panel-heading">
+            Event types and their meanings
+          </div>
+        </div>
+        <table class="table">
+          <thead>
+            <tr>
+              <th>Event type</th>
+              <th>Signification</th>
+            </tr>
+          </thead>
+          <tbody>
+            <tr>
+              <td>session_create</td>
+              <td>A new cookie based session is created</td>
+            </tr>
+            <tr>
+              <td>session_destroy</td>
+              <td>A session is destroyed. Usually the user explicitely quit a room
+            </tr>
+            <tr>
+              <td>room_create</td>
+              <td>A new room is created</td>
+            </tr>
+            <tr>
+              <td>room_modify</td>
+              <td>Room configuration is modified</td>
+            </tr>
+            <tr>
+              <td>peer_role</td>
+              <td>The role of a peer is changing (after authentication or being promoted to an owner of a room)</td>
+            </tr>
+            <tr>
+              <td>room_expire</td>
+              <td>A room is being deleted because it showed no activity for too long</td>
+            </tr>
+            <tr>
+              <td>room_delete</td>
+              <td>A room is being deleted by a user action</td>
+            </tr>
+            <tr>
+              <td>add_email_notification</td>
+              <td>Add an email to the list of notifications sent when someone joins a room</td>
+            </tr>
+            <tr>
+              <td>reset_email_notification</td>
+              <td>Reset the list of email being notified when someone joins a rooms</td>
+            </tr>
+            <tr>
+              <td>del_email_notification</td>
+              <td>Remove an email from the list of notifications sent when someone joins a room</td>
+            </tr>
+            <tr>
+              <td>send_invitation</td>
+              <td>An email invitation to join the room is being sent</td>
+            </tr>
+            <tr>
+              <td>invitation_response</td>
+              <td>Response to an invitation received</td>
+            </tr>
+            <tr>
+              <td>invalidate_invitation</td>
+              <td>An invitation has been used, so is marked as invalide (invitations are only usable once)</td>
+            </tr>
+            <tr>
+              <td>pad_create</td>
+              <td>A pad (Etherpad-Lite) is created</td>
+            </tr>
+            <tr>
+              <td>admin_key</td>
+              <td>An API Key aquire admin privileges. Usually this happens when a user access /admin for the first time with this session</td>
+            </tr>
+            <tr>
+              <td>peer_id_mismatch</td>
+              <td>Connection to the signaling channel attempted with a wrong peer ID</td>
+            </tr>
+            <tr>
+              <td>no_role</td>
+              <td>Someone tried to join a room but has no valid role, so access is denied</td>
+            </tr>
+            <tr>
+              <td>member_off_limit</td>
+              <td>A peer is being denied because member limit is already reached</td>
+            </tr>
+            <tr>
+              <td>room_leave</td>
+              <td>A peer leaves a room</td>
+            </tr>
+            <tr>
+              <td>api_action_denied</td>
+              <td>An API action has been denied</td>
+            </tr>
+            <tr>
+              <td>api_action_allowed</td>
+              <td>An API action was allowed</td>
+            </tr>
+          </tbody>
+        </table>
+      </p>
     </div>
   </div>
 </div>