Skip to main content

Documentation

Learn how to use the Headless platform

Getting Started

2 min read

Welcome to Headless! This guide will help you get started with creating and managing content for your applications.

Creating Your Account

  1. Navigate to the registration page at /register
  2. Enter your name, email address, and password
  3. Check your email for a verification link
  4. Click the link to verify your account
  5. Log in with your credentials

Two-Factor Authentication (Optional)

For added security, enable two-factor authentication:

  1. Go to Settings > Security
  2. Click Enable 2FA
  3. Scan the QR code with an authenticator app (Google Authenticator, Authy, etc.)
  4. Enter the 6-digit code to confirm
  5. Save your backup codes in a secure location

Quick Start

Once you're logged in, here's how to get started:

  1. Create an Organization - Organizations are the top-level container for your projects and team
  2. Create a Project - Projects contain your content types, entries, and media
  3. Define Content Types - Set up the structure for your content (like "Blog Post" or "Product")
  4. Create Entries - Add actual content based on your content types
  5. Access via API - Use the REST or GraphQL API to fetch your content

Keyboard Shortcuts

ShortcutAction
Ctrl/Cmd + SSave entry
Ctrl/Cmd + EnterSave and publish
EscapeClose modal/dialog
/Focus search

Use the search bar in the header to find content across your organization:

  1. Press / or click the search icon to open search
  2. Type your search query
  3. Use filters to narrow results:
    • Project: Search within a specific project
    • Content Type: Filter by content type
    • Type: Search entries, media, or both
  4. Click a result to navigate directly to it

Search finds matches in:

  • Entry titles and field content
  • Media filenames and alt text

Tip: If semantic search is enabled on a project, results include AI-powered matches that find content by meaning, not just keywords.

Getting Help

  • Documentation: You're reading it!
  • Support: Contact your administrator
  • Status: Check system status at /api/health