Dashboard Overview

Dashboard Overview

The OstrichDB dashboard is your central hub for managing projects, collections, and data. This guide covers authentication, navigation, and key features.

Getting Started

Account Creation and Authentication

Sign Up:

1. Visit the OstrichDB homepage
2. Click “Start Building Free” or “Sign Up”
3. Complete registration using Clerk authentication
4. Verify your email address

Sign In:

1. Click “Sign In” on the homepage
2. Enter your credentials
3. You’ll be redirected to your dashboard

Dashboard Layout

After signing in, you’ll see your personalized dashboard with:

• Projects Section: Top-level containers for your databases
• Quick Actions: Create new projects, collections, and clusters
• Account Status: Your current tier (Free, Pro, or Enterprise)
• Backend Connection Status: Green indicator shows active connection to the database
• Navigation Sidebar: Access to different tools and views

Main Dashboard Components

Projects Overview

The projects section displays all your database projects as cards, showing:

• Project Name: Unique identifier for the project
• Collection Count: Number of collections in the project
• Project Size: Total storage used by the project
• Last Modified: When the project was last updated
• Actions Menu: Three-dot menu (⋮) for project operations

Project Sorting Options

Sort your projects by:

• Alphabetical (A-Z): Default sorting by name
• Number of Collections: Projects with most collections first
• Project Size: Largest projects first
• Last Modified: Most recently modified first

Quick Actions Panel

Access common operations quickly:

• Create New Project: Start a new database project
• Create Collection: Add a collection to an existing project
• Create Cluster: Add a data cluster to a collection
• Open Cluster Editor: Visual interface for managing data

Account Information

Monitor your account status:

• Current Plan: Free, Pro, or Enterprise tier
• Usage Statistics: Storage used, projects created, collections count
• Billing Information: For Pro and Enterprise users
• Upgrade Options: Links to upgrade your plan

Navigation

Primary Navigation

The sidebar provides access to key features:

• Dashboard: Main project overview (home)
• Cluster Editor: Visual data management interface
• Natural Language Query: AI-powered query interface (Pro/Enterprise)
• Manual Query Editor: Direct database command interface
• Account Settings: Profile and billing management
• Theme Toggle: Switch between light and dark modes

Breadcrumb Navigation

When navigating deeper into projects:

Dashboard > Project Name > Collection Name > Cluster Name

Each level is clickable to navigate back up the hierarchy.

Theme and Personalization

Theme Settings

• Light Theme: Default clean interface
• Dark Theme: Dark mode for reduced eye strain
• Auto-Detection: Automatically matches your system preference
• Persistent Settings: Theme choice saved across sessions

Interface Customization

• Responsive Design: Works on desktop, tablet, and mobile
• Keyboard Shortcuts: Common operations accessible via keyboard
• Contextual Menus: Right-click menus for quick actions

Connection Status

Backend Connection Indicator

The connection status indicator shows:

• Green Dot: Successfully connected to OstrichDB backend
• Red Dot: Connection lost or backend unavailable
• Yellow Dot: Attempting to reconnect

Troubleshooting Connection Issues

If you see connection problems:

1. Refresh the page: Often resolves temporary connectivity issues
2. Check your internet: Ensure stable internet connection
3. Clear browser cache: Remove cached data that might be corrupted
4. Try incognito mode: Test if extensions are causing issues

Dashboard Features by Plan

Free Tier Features

• 1 Project: Single project container
• 1 Collection: One collection per project
• Basic Dashboard: Project overview and management
• Community Support: Access to community resources

Pro Tier Features

• 3 Projects: Multiple project containers
• 3 Collections: Three collections per project
• Enhanced Dashboard: Advanced sorting and filtering
• NLP Interface: Natural language query access (50/day)
• Collaboration Tools: Multi-user features

Enterprise Tier Features

• 30 Projects: Extensive project capacity
• 100 Collections: Large-scale data organization
• Advanced Dashboard: Full feature access
• Unlimited NLP: No limits on AI queries
• Priority Support: Direct support access
• Custom Branding: White-label options

Performance and Best Practices

Dashboard Performance

For optimal performance:

• Limit large projects: Consider splitting projects with 50+ collections
• Regular cleanup: Remove unused projects and collections
• Efficient naming: Use descriptive but concise names
• Monitor usage: Keep track of storage and limits

Organization Tips

Structure your dashboard effectively:

• Group related projects: Use consistent naming conventions
• Separate environments: Different projects for dev/staging/production
• Document structure: Add descriptions to complex projects
• Regular maintenance: Review and clean up old data

Keyboard Shortcuts

Common keyboard shortcuts:

• Ctrl/Cmd + N: Create new project
• Ctrl/Cmd + Shift + N: Create new collection
• Ctrl/Cmd + E: Open Cluster Editor
• Ctrl/Cmd + Q: Open query interface
• Ctrl/Cmd + ,: Open settings
• Escape: Close current modal or dialog

Getting Help

In-Dashboard Help

Access help resources:

• Help Button: Context-sensitive help for current view
• Tooltips: Hover over elements for quick explanations
• Status Messages: Informative messages about operations
• Error Guidance: Specific help for error conditions

External Support

For additional support:

• Community Discord: Free community support
• Documentation: Comprehensive guides and references
• Private Support: Pro/Enterprise private channels
• Email Support: Direct contact for urgent issues

Next Steps

Once you’re familiar with the dashboard:

1. Learn about Projects - Create and manage database projects
2. Explore Collections - Organize your data into collections
3. Use the Cluster Editor - Visual interface for data management
4. Try Natural Language Queries - AI-powered database interactions