domma-cms 0.25.14 → 0.25.16

package/admin/js/templates/docs/usage-site-settings.html

@@ -0,0 +1,52 @@
+<div class="view-header">
+  <h1><span data-icon="book"></span> Site Settings</h1>
+  <a href="#/documentation" class="btn btn-ghost btn-sm"><span data-icon="arrow-left"></span> All usage topics</a>
+</div>
+
+<div class="row">
+  <div class="col-12">
+    <div class="docs-body">
+
+<p>Site Settings are stored in <code>config/site.json</code> and editable from the Settings page in
+                      the admin
+                      panel.</p>
+
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Field</th>
+                          <th>Description</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>siteName</code></td>
+                          <td>Site title used in the public navbar and browser tab.</td>
+                      </tr>
+                      <tr>
+                          <td><code>tagline</code></td>
+                          <td>Subtitle shown in the public site footer.</td>
+                      </tr>
+                      <tr>
+                          <td><code>adminTheme</code></td>
+                          <td>Admin panel colour theme (e.g. <code>charcoal-dark</code>, <code>ocean-light</code>).</td>
+                      </tr>
+                      <tr>
+                          <td><code>publicTheme</code></td>
+                          <td>Public site theme applied to <code>&lt;html data-theme&gt;</code>.</td>
+                      </tr>
+                      <tr>
+                          <td><code>defaultLayout</code></td>
+                          <td>Fallback layout for pages that don't specify one.</td>
+                      </tr>
+                      </tbody>
+                  </table>
+
+                  <h3>Server configuration</h3>
+                  <p>Low-level settings (port, CORS, upload size) live in <code>config/server.json</code> and require a
+                      server
+                      restart to take effect. These are not editable from the admin panel.</p>
+
+    </div>
+  </div>
+</div>

package/admin/js/templates/docs/usage-users-roles.html

@@ -0,0 +1,84 @@
+<div class="view-header">
+  <h1><span data-icon="book"></span> Users &amp; Roles</h1>
+  <a href="#/documentation" class="btn btn-ghost btn-sm"><span data-icon="arrow-left"></span> All usage topics</a>
+</div>
+
+<div class="row">
+  <div class="col-12">
+    <div class="docs-body">
+
+<p>Users are stored as individual JSON files in <code>content/users/</code>. Passwords are hashed with
+                      bcrypt
+                      and never returned by the API.</p>
+
+                  <h3>Roles</h3>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Role</th>
+                          <th>Access</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><strong>Admin</strong></td>
+                          <td>Full access — users, plugins, settings, all content.</td>
+                      </tr>
+                      <tr>
+                          <td><strong>Manager</strong></td>
+                          <td>Content + structure (navigation, layouts). No users or plugins.</td>
+                      </tr>
+                      <tr>
+                          <td><strong>Editor</strong></td>
+                          <td>Pages and media only.</td>
+                      </tr>
+                      <tr>
+                          <td><strong>Subscriber</strong></td>
+                          <td>Read-only access to the API.</td>
+                      </tr>
+                      </tbody>
+                  </table>
+
+                  <h3>Authentication</h3>
+                  <p>The admin panel uses JWT Bearer tokens. Tokens are stored in the browser and automatically
+                      refreshed.
+                      Sessions expire according to <code>config/auth.json</code> — default is 24 hours.</p>
+
+                  <h3>Views &amp; Actions</h3>
+                  <p>Views and Actions are pro-only features that require a MongoDB connection.
+                      Both roles — Admin and Manager — can create, edit, and run Views and Actions.</p>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Role</th>
+                          <th>Views</th>
+                          <th>Actions</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><strong>Admin</strong></td>
+                          <td>Full access</td>
+                          <td>Full access</td>
+                      </tr>
+                      <tr>
+                          <td><strong>Manager</strong></td>
+                          <td>Full access</td>
+                          <td>Full access</td>
+                      </tr>
+                      <tr>
+                          <td><strong>Editor</strong></td>
+                          <td>No access</td>
+                          <td>No access</td>
+                      </tr>
+                      <tr>
+                          <td><strong>Subscriber</strong></td>
+                          <td>No access</td>
+                          <td>No access</td>
+                      </tr>
+                      </tbody>
+                  </table>
+
+    </div>
+  </div>
+</div>

package/admin/js/templates/docs/usage-views.html

@@ -0,0 +1,105 @@
+<div class="view-header">
+  <h1><span data-icon="book"></span> Views</h1>
+  <a href="#/documentation" class="btn btn-ghost btn-sm"><span data-icon="arrow-left"></span> All usage topics</a>
+</div>
+
+<div class="row">
+  <div class="col-12">
+    <div class="docs-body">
+
+<p>Views are admin-designed display configurations that query one or more Collections via a stored
+                      MongoDB aggregation pipeline, then render the results in the admin panel.
+                      Views require a MongoDB connection configured under <strong>Collections → Options</strong>.</p>
+
+                  <h3>Creating a View</h3>
+                  <ol>
+                      <li>Navigate to <strong>Data → Views</strong> and click <strong>New View</strong>.</li>
+                      <li><strong>Source tab</strong> — enter a title, choose the primary source collection, and select
+                          the MongoDB connection.
+                      </li>
+                      <li><strong>Pipeline tab</strong> — add aggregation stages in order. Each stage has a type and a
+                          JSON config object.
+                      </li>
+                      <li><strong>Display tab</strong> — choose table or list mode, set page size, and optionally define
+                          column definitions.
+                      </li>
+                      <li><strong>Access tab</strong> — select which roles can access this view and whether it is
+                          publicly accessible.
+                      </li>
+                      <li>Click <strong>Save View</strong>, then use <strong>Preview</strong> to execute and inspect the
+                          results.
+                      </li>
+                  </ol>
+
+                  <h3>Allowed Pipeline Stage Types</h3>
+                  <table class="table table-sm">
+                      <thead>
+                      <tr>
+                          <th>Stage</th>
+                          <th>Purpose</th>
+                      </tr>
+                      </thead>
+                      <tbody>
+                      <tr>
+                          <td><code>$match</code></td>
+                          <td>Filter documents by condition</td>
+                      </tr>
+                      <tr>
+                          <td><code>$lookup</code></td>
+                          <td>Left join from another collection</td>
+                      </tr>
+                      <tr>
+                          <td><code>$sort</code></td>
+                          <td>Sort documents</td>
+                      </tr>
+                      <tr>
+                          <td><code>$project</code></td>
+                          <td>Include or exclude fields</td>
+                      </tr>
+                      <tr>
+                          <td><code>$unwind</code></td>
+                          <td>Deconstruct an array field</td>
+                      </tr>
+                      <tr>
+                          <td><code>$addFields</code></td>
+                          <td>Compute and add new fields</td>
+                      </tr>
+                      <tr>
+                          <td><code>$group</code></td>
+                          <td>Group and aggregate</td>
+                      </tr>
+                      <tr>
+                          <td><code>$count</code></td>
+                          <td>Count documents</td>
+                      </tr>
+                      <tr>
+                          <td><code>$skip</code></td>
+                          <td>Skip documents (added automatically for pagination)</td>
+                      </tr>
+                      <tr>
+                          <td><code>$limit</code></td>
+                          <td>Limit documents (added automatically for pagination)</td>
+                      </tr>
+                      </tbody>
+                  </table>
+                  <p>Forbidden stages (<code>$out</code>, <code>$merge</code>, <code>$function</code>, <code>$accumulator</code>,
+                      <code>$graphLookup</code>) are rejected at save and execution time.</p>
+
+                  <h3>Column Definitions</h3>
+                  <p>On the Display tab, column definitions are a JSON array. Each object has a <code>key</code>
+                      (dot-path into the result document) and a <code>label</code>.</p>
+                  <pre class="code-block"><code>[
+  { "key": "data.name",  "label": "Name" },
+  { "key": "data.email", "label": "Email" },
+  { "key": "orders",     "label": "Orders" }
+]</code></pre>
+                  <p>If no columns are defined, the preview auto-generates columns from the first result document.</p>
+
+                  <h3>Public Access</h3>
+                  <p>Tick <strong>Public</strong> on the Access tab to expose the view via
+                      <code>GET /api/views/:slug/public</code> without requiring a login.
+                      Leave it unticked to require JWT authentication with one of the allowed roles.</p>
+
+    </div>
+  </div>
+</div>