MiniCMS Docs
Content

Dashboard Guide

Create projects, manage collections and items, and generate API keys from the Mini CMS dashboard.

The dashboard is the easiest way to manage content if you are not working from code. If your instance is deployed, you can open the dashboard from the link in the top navigation bar.

What You Can Do Here

  • create workspaces for each team or organization
  • create projects for each client site or content area
  • create collections for each content type inside a project
  • upload and manage reusable project assets
  • define the fields each item should have
  • add and edit content with a generated form
  • create API keys for developers and automation
  • manage team members, roles, and project access

Workspace Overview

When you sign in, the dashboard shows your workspace:

  • Name: Your organization or team name
  • Slug: URL-friendly identifier used in API requests
  • ID: Unique identifier for API integration

The workspace ID (w) is used in the public content API and schema API requests.

Your role in the workspace determines what you can manage and which projects you can see.

Roles And Project Access

Every workspace member has a role. The role controls workspace management and project visibility.

RoleWorkspace managementProject visibility
OwnerManage the workspace, team, projects, and API keysAll projects
AdminManage the team, projects, and API keysAll projects
MemberManage content and environmentsOnly assigned projects
ReviewerManage content and environmentsOnly assigned projects

Owners and admins can create, edit, and delete projects, change API access settings, invite teammates, and manage API keys. Members and reviewers can work with collections, items, assets, environments, and analytics for the projects assigned to them. They cannot open the Team or API Keys pages.

A member or reviewer with no assigned projects sees an empty project list. Assign at least one project before they sign in.

Assign Project Access

  1. Open Team in the sidebar.
  2. Find the member in the members table.
  3. In the Projects column, click Manage.
  4. Select the projects the member should see.
  5. Click Save.

Use Select all to grant every current project or Clear to remove all project access. Owners and admins always see every project, so their Projects column shows All projects.

When an owner or admin is demoted to member or reviewer, they keep access to all projects that exist at that moment. An owner or admin can then restrict them with the same dialog. Projects created later are not assigned automatically.

The sidebar holds navigation, the project selector, and workspace utilities:

  • Project selector: switches the active project. The selection is kept in the URL. The selector only lists projects the current member can access.
  • Environment selector: appears when a project has more than one environment. It scopes collection views to the selected environment.
  • Team and API Keys: visible only to owners and admins. Members and reviewers work inside their assigned projects.
  • Collapse toggle: collapses the sidebar to icons to give content more room. Hovering a collapsed icon shows its label.
  • Docs: opens this documentation from the sidebar footer.

Create A Project

  1. Sign in to the dashboard.
  2. Open Collections.
  3. Choose New project.
  4. Enter a name and slug.
  5. Create the project.

Only owners and admins can create, edit, or delete projects. Members and reviewers can open the projects assigned to them.

Projects group related collections inside a workspace. Each project has its own:

  • Collections and items
  • Schema definitions
  • API key scope (optional)

You can switch between the projects you can access using the selector at the top of the sidebar.

Create A Collection

  1. Sign in to the dashboard.
  2. Open Collections.
  3. Select the project the collection should belong to.
  4. Click New collection.
  5. Enter a name, slug, and optional description.
  6. Create the collection.

Create collection dialog

After creation, the collection appears in the list with its item count.

Collections list

Collection Actions

Each collection in the list has an actions menu (...) with:

  • Open: View and manage collection items
  • Edit: Modify collection name, slug, or description
  • Delete: Remove the collection and all its items

Deleting a collection is permanent. All items in that collection will be lost.

Open A Collection

  1. From Collections, click Open on the collection you want.
  2. Review the schema columns and current items.

Empty collection example:

Empty collection state

Create An Item

  1. Open the collection.
  2. Click Add item.
  3. Fill the form generated from the collection schema.
  4. Save the item.

Mini CMS supports text, url, number, boolean, and date fields. Every item also includes two built-in system fields:

  • _id: generated automatically and shown in the items table
  • _published: controlled in the item editor and used by the public API

Item editor

Saved item example:

Collection items

Edit Schema

  1. Open the collection.
  2. Click Edit schema.
  3. Update fields like text, url, number, boolean, or date.

Keys starting with _ are reserved for system fields and cannot be used for custom fields.

Field Types

TypeEditorUse Case
textText inputShort or long text content
urlURL inputLinks with thumbnail preview
numberNumber inputNumeric values
booleanToggleYes/no flags
dateDate pickerTimestamps and dates

Publishing Items

Every item has a _published system field:

  • When true: The item appears in the public content API
  • When false or missing: The item is only visible in the dashboard

Use unpublished items for drafts or items you don't want exposed publicly.

Generate An API Key

Only owners and admins can open API Keys and create keys.

  1. Open API Keys in the sidebar.
  2. Enter a key name.
  3. Optionally scope it to a single project.
  4. Click Create key.
  5. Copy the revealed key immediately.

This API key is what mini-cms uses for schema pull, push, collection listing, and protected item listing.

The public content API does not use API keys.

Manage Assets

  1. Open Assets in the dashboard sidebar.
  2. Select the project the files should belong to.
  3. Click Upload asset.
  4. Choose an image, PDF, or video file.
  5. Copy the generated public URL and use it in collection items or frontend code.

Assets are project-scoped, just like collections. Supported file types are common images, PDFs, and MP4/WebM videos up to 10MB.

The Assets page also lets you:

  • browse uploaded files in a visual grid
  • filter by type (All, Images, Videos, Docs)
  • search by filename, sort by name, type, size, or date, and page through results
  • toggle between Fill and Fit to crop or letterbox image previews
  • preview image assets and open a video to play it
  • copy the public URL for any asset
  • select multiple assets to copy their URLs or delete them in one action
  • delete files that are no longer needed

Selections are per page and clear automatically when the files are removed or you change pages. Bulk deletion asks for confirmation and cannot be undone.

When a project has no assets, the empty state offers an Upload asset button. If a search or filter returns nothing, the page shows a separate no-matches state with a Clear filters action.

Table Controls

Every list in the dashboard (members, projects, workspaces, API keys, collections, assets, and the dashboard overview) shares the same table toolbar and pagination bar, so you can manage large lists without reloading the page.

The toolbar above each table provides:

  • Filter input — type to narrow the rows on the current page (case-insensitive match across the configured fields). The filter is debounced and only affects the visible rows; the server page is not re-fetched. When filtering hides some rows, a "Showing N of M on this page" hint appears.
  • Refresh button — re-fetches the current view and shows a spinning icon while the request is in flight.
  • Sort by — a dropdown of the sortable columns.
  • Order — a dropdown to switch between ascending and descending.

You can also click a sortable column header to cycle through none → ascending → descending → none. The header and the toolbar dropdowns stay in sync.

The pagination bar below each table provides:

  • A summary line: Showing N items · Page X of Y
  • Rows per page — a dropdown with 10, 25, or 50 items, next to an (i) icon whose tooltip reads: "Choose how many items to show per page. Larger page sizes load more data and may take longer to fetch."
  • Prev and Next buttons

All of these settings are stored in the URL as query parameters (page, pageSize, q, sort, order), so a hard reload or a shared link restores the exact view. Page-size and sort changes are reflected in the URL immediately.

API Key Scopes

  • Workspace-scoped: Full access to all projects and collections
  • Project-scoped: Limited to a specific project only

Invite Team Members

Only owners and admins can invite teammates.

  1. Open Team in the sidebar.
  2. Click Invite member.
  3. Enter the email address.
  4. Choose a role: Admin, Member, or Reviewer.
  5. Send the invite.

The invitee receives an email with a link to join your workspace. Existing users can sign in and join directly, while new users can create an account first and then continue with the invite.

After the invitee joins, assign their projects from the Projects column on the Team page. Members and reviewers start with no project access. Owners are not available from the invite form.

In demo environments, invites are also constrained by DEMO_MAX_USERS_PER_WORKSPACE when that limit is configured.

Environment

The sidebar shows an environment dropdown when the active project defines more than one environment. Use it to switch between environments such as production or staging. The selected environment is added to the URL as env and scopes collection views to items created for that environment.

Production is the default and is not written to the URL. This helps developers verify that they are editing the same environment their integration is pointing at.

On this page