> ## Documentation Index
> Fetch the complete documentation index at: https://mintlify.com/trailbaseio/trailbase/llms.txt
> Use this file to discover all available pages before exploring further.

# Support

> Getting help with TrailBase - community resources and support channels

Need help with TrailBase? This page outlines the various support channels available and how to get assistance.

## Support Channels

<CardGroup cols={2}>
  <Card title="Documentation" icon="book" href="/">
    Comprehensive guides, tutorials, and API references
  </Card>

  <Card title="GitHub Issues" icon="github" href="https://github.com/trailbaseio/trailbase/issues">
    Bug reports and feature requests
  </Card>

  <Card title="GitHub Discussions" icon="comments" href="https://github.com/trailbaseio/trailbase/discussions">
    Community Q\&A, ideas, and general discussion
  </Card>

  <Card title="Discord Community" icon="discord">
    Real-time chat with the community (link in GitHub)
  </Card>
</CardGroup>

## Getting Help

### Before Asking for Help

To get the fastest response:

<Steps>
  <Step title="Search Documentation">
    Check if your question is answered in the [documentation](/). Use the search feature to find relevant pages.
  </Step>

  <Step title="Search Existing Issues">
    Look through [GitHub Issues](https://github.com/trailbaseio/trailbase/issues) and [Discussions](https://github.com/trailbaseio/trailbase/discussions) to see if your question has been asked before.
  </Step>

  <Step title="Check the FAQ">
    Review the [FAQ page](/resources/faq) for common questions and answers.
  </Step>

  <Step title="Try the Demo">
    Experiment with the [live demo](https://demo.trailbase.io/_/admin) to understand how features work.
  </Step>
</Steps>

### How to Ask Good Questions

Help us help you by providing:

<Accordion title="Include Version Information">
  ```sh theme={null}
  trail --version
  ```

  Specify:

  * TrailBase version
  * Operating system and version
  * Client library versions (if applicable)
</Accordion>

<Accordion title="Describe the Problem Clearly">
  * What are you trying to accomplish?
  * What did you expect to happen?
  * What actually happened?
  * Can you reproduce it consistently?
</Accordion>

<Accordion title="Provide Relevant Code/Configuration">
  Include:

  * Relevant code snippets (not entire files)
  * Configuration excerpts
  * SQL schema (if relevant)
  * API requests/responses
  * Error messages and stack traces

  <Warning>
    Redact sensitive information like passwords, tokens, and API keys!
  </Warning>
</Accordion>

<Accordion title="Show What You've Tried">
  * What troubleshooting steps have you attempted?
  * What searches have you done?
  * What documentation have you read?

  This helps avoid suggesting things you've already tried.
</Accordion>

## Support Options

### Community Support (Free)

The TrailBase community provides free support through various channels.

<Accordion title="GitHub Discussions (Recommended)">
  **Best for:**

  * General questions
  * "How do I...?" questions
  * Design discussions
  * Sharing ideas
  * Showcasing projects

  **How to use:**

  1. Go to [GitHub Discussions](https://github.com/trailbaseio/trailbase/discussions)
  2. Search existing discussions
  3. Start a new discussion if needed
  4. Choose the appropriate category
  5. Provide details (see "How to Ask Good Questions" above)

  **Response time:**

  * Community volunteers respond as time allows
  * Popular questions get faster responses
  * Maintainers participate when available

  [Ask a Question on Discussions](https://github.com/trailbaseio/trailbase/discussions/new?category=q-a)
</Accordion>

<Accordion title="Discord Community">
  **Best for:**

  * Real-time chat
  * Quick questions
  * Community discussion
  * Networking with other users

  **How to join:**

  * Find the Discord invite link in the GitHub repository
  * Introduce yourself in the welcome channel
  * Read the channel descriptions
  * Be respectful and helpful

  **Response time:**

  * Varies based on community availability
  * Generally faster than GitHub for simple questions
  * Less formal than GitHub Issues/Discussions
</Accordion>

<Accordion title="GitHub Issues">
  **Best for:**

  * Bug reports
  * Feature requests
  * Reproducible problems
  * Security issues (non-sensitive)

  **NOT for:**

  * General questions (use Discussions)
  * "How do I...?" questions
  * Support requests

  **How to file an issue:**

  1. Search existing issues first
  2. Use the issue template
  3. Provide reproduction steps
  4. Include version information
  5. Add relevant labels

  <Warning>
    **Security issues:** Report privately to [security@trailbase.io](mailto:security@trailbase.io), not as public issues. See [Security Policy](https://github.com/trailbaseio/trailbase/security/policy).
  </Warning>

  [Report a Bug](https://github.com/trailbaseio/trailbase/issues/new?template=bug_report.md) | [Request a Feature](https://github.com/trailbaseio/trailbase/issues/new?template=feature_request.md)
</Accordion>

### Documentation

<Accordion title="Official Documentation">
  Comprehensive documentation at [trailbase.io](https://trailbase.io):

  * **Getting Started**: Installation and quickstart guides
  * **Guides**: Step-by-step tutorials
  * **Reference**: API documentation and specifications
  * **Examples**: Sample code and projects
  * **Resources**: FAQ, comparisons, roadmap

  Use the search feature to find specific topics.
</Accordion>

<Accordion title="Blog Articles">
  Deep dives into features and concepts:

  * Architecture decisions
  * Major feature announcements
  * Performance deep-dives
  * Migration guides

  Read at [trailbase.io/blog](https://trailbase.io/blog)
</Accordion>

<Accordion title="Examples Repository">
  Practical examples in the [examples directory](https://github.com/trailbaseio/trailbase/tree/main/examples):

  * WASM components (JS, TS, Rust)
  * Client applications
  * Integration examples
  * Real-world use cases

  Clone and run locally to learn by example.
</Accordion>

### Email Support

<Accordion title="Security Issues">
  **Email**: [security@trailbase.io](mailto:security@trailbase.io)

  **For**: Security vulnerabilities and sensitive issues only

  **Response time**: As quickly as possible (high priority)

  **What to include**:

  * Commit version with the issue
  * Proof of concept
  * Steps to reproduce
  * Recommended fixes (if any)

  See our [Security Policy](/resources/license) for the complete process.

  <Warning>
    Do NOT report security issues publicly on GitHub!
  </Warning>
</Accordion>

<Accordion title="License Questions">
  **Email**: [contact@trailbase.io](mailto:contact@trailbase.io)

  **For**:

  * License clarifications
  * Commercial license exceptions
  * Partnership inquiries
  * Private inquiries

  **Response time**: Within a few business days

  For general licensing questions, see the [license page](/resources/license) first.
</Accordion>

## Self-Help Resources

### Debugging Tips

<Accordion title="Enable Verbose Logging">
  Run TrailBase with verbose output:

  ```sh theme={null}
  RUST_LOG=debug trail run
  ```

  Or for specific modules:

  ```sh theme={null}
  RUST_LOG=trailbase=debug trail run
  ```

  Logs help identify issues and provide context when asking for help.
</Accordion>

<Accordion title="Check the Logs">
  TrailBase maintains logs in the admin UI:

  1. Navigate to `/_/admin/logs`
  2. Look for error messages
  3. Check request/response details
  4. Filter by time or endpoint

  Share relevant log entries when reporting issues.
</Accordion>

<Accordion title="Test in Isolation">
  Simplify your setup to isolate the problem:

  * Create a minimal reproduction
  * Remove custom WASM components
  * Test with a fresh `traildepot`
  * Use the example applications
  * Try the live demo

  This helps determine if the issue is with TrailBase or your configuration.
</Accordion>

<Accordion title="Verify Your Setup">
  Common issues to check:

  * ✅ TrailBase version is up to date
  * ✅ Client library versions match server
  * ✅ Database migrations are applied
  * ✅ Access rules are configured correctly
  * ✅ File permissions are correct
  * ✅ Ports are not blocked by firewalls
  * ✅ Configuration is valid
</Accordion>

### Common Issues

<Accordion title="Connection Refused / Port Already in Use">
  **Symptoms**: TrailBase won't start or clients can't connect

  **Solutions**:

  * Check if another process is using port 4000
  * Specify a different port: `trail run --port 4001`
  * Check firewall settings
  * Verify `ADDRESS` environment variable
</Accordion>

<Accordion title="Authentication Errors">
  **Symptoms**: Can't log in or tokens are invalid

  **Solutions**:

  * Verify user exists and is verified
  * Check token expiration
  * Ensure clock synchronization (for JWTs)
  * Review access rules in admin UI
  * Check CORS settings
</Accordion>

<Accordion title="API 404 Errors">
  **Symptoms**: Record APIs return 404

  **Solutions**:

  * Verify Record API is configured in admin UI
  * Check table/view name spelling
  * Ensure migrations have run
  * Reload configuration: `kill -HUP <pid>`
  * Check access rules allow the operation
</Accordion>

<Accordion title="WASM Component Issues">
  **Symptoms**: WASM components don't load or crash

  **Solutions**:

  * Verify component is compatible with server version
  * Check component is in `traildepot/wasm/`
  * Rebuild component with latest runtime
  * Check WASM component logs
  * Use `--dev` mode for better error messages
</Accordion>

<Accordion title="Performance Issues">
  **Symptoms**: Slow queries or high latency

  **Solutions**:

  * Add indexes to frequently queried columns
  * Review access rules (complex rules add overhead)
  * Check SQLite cache size settings
  * Use `EXPLAIN QUERY PLAN` to analyze queries
  * Consider multi-DB for write-heavy workloads
  * See [benchmarks page](/resources/benchmarks) for optimization tips
</Accordion>

## Contributing to Support

Help other community members:

### Answer Questions

* Browse [GitHub Discussions](https://github.com/trailbaseio/trailbase/discussions)
* Join Discord and help in support channels
* Share your knowledge and experience
* Be patient and welcoming to newcomers

### Improve Documentation

* Fix typos and errors
* Add missing examples
* Clarify confusing sections
* Write tutorials for common tasks
* See [contributing guide](/resources/contributing)

### Share Your Experience

* Write blog posts about using TrailBase
* Create video tutorials
* Share example projects
* Present at meetups or conferences

## Enterprise Support

<Info>
  Official enterprise support is not yet available but may be offered in the future.
</Info>

### Future Plans

Potential enterprise offerings:

* Priority support with SLAs
* Private support channels
* Training and onboarding
* Custom development
* Architecture consulting
* Commercial licenses

Interested in enterprise support? Contact: [contact@trailbase.io](mailto:contact@trailbase.io)

## Support Best Practices

### For Users

<CardGroup cols={2}>
  <Card title="Be Patient" icon="clock">
    Community volunteers respond when they can. Complex issues take time.
  </Card>

  <Card title="Be Respectful" icon="handshake">
    Everyone is helping out of goodwill. Treat others with respect.
  </Card>

  <Card title="Be Detailed" icon="magnifying-glass">
    More information helps get better answers faster.
  </Card>

  <Card title="Give Back" icon="gift">
    Help others when you can. Share solutions you find.
  </Card>
</CardGroup>

### For Helpers

<CardGroup cols={2}>
  <Card title="Be Welcoming" icon="hand-wave">
    Remember you were a beginner once. Be patient with newcomers.
  </Card>

  <Card title="Be Clear" icon="message">
    Explain your reasoning. Provide examples. Link to documentation.
  </Card>

  <Card title="Be Constructive" icon="hammer">
    Focus on solving problems, not criticizing approaches.
  </Card>

  <Card title="Know Your Limits" icon="circle-info">
    It's okay to say "I don't know" or point to someone who might know better.
  </Card>
</CardGroup>

## Response Time Expectations

Set realistic expectations:

| Channel                  | Typical Response Time | Priority    |
| ------------------------ | --------------------- | ----------- |
| Security email           | Hours to 1 day        | High        |
| GitHub Issues (bugs)     | 1-7 days              | Medium-High |
| GitHub Discussions       | 1-7 days              | Medium      |
| Discord                  | Hours to days         | Low-Medium  |
| GitHub Issues (features) | 1-14 days             | Low-Medium  |
| General email            | 1-7 days              | Low         |

<Note>
  These are estimates. Response times vary based on complexity, community availability, and maintainer workload.
</Note>

## Getting Updates

Stay informed about TrailBase:

<CardGroup cols={2}>
  <Card title="Watch on GitHub" icon="eye" href="https://github.com/trailbaseio/trailbase">
    Get notified of releases and important issues
  </Card>

  <Card title="Subscribe to Releases" icon="rss" href="https://github.com/trailbaseio/trailbase/releases.atom">
    RSS feed for new releases
  </Card>

  <Card title="Follow on Twitter" icon="twitter" href="https://twitter.com/trailbaseio">
    Updates and announcements
  </Card>

  <Card title="Read the Blog" icon="newspaper" href="https://trailbase.io/blog">
    Deep dives and feature announcements
  </Card>
</CardGroup>

## Community Guidelines

To maintain a positive support community:

✅ **Do**:

* Be respectful and constructive
* Search before posting
* Provide details and context
* Follow up with solutions you find
* Help others when you can
* Give credit where due

❌ **Don't**:

* Demand immediate responses
* Post duplicate questions
* Be rude or dismissive
* Share sensitive information publicly
* Cross-post excessively
* Go off-topic

Violations may result in moderation actions.

## Still Need Help?

If you've tried the above and still need assistance:

1. **Double-check** you've provided all relevant information
2. **Be specific** about what you need help with
3. **Choose the right channel** for your question type
4. **Be patient** while waiting for a response
5. **Consider commercial support** for urgent business needs

<Card title="Ask for Help" icon="question" href="https://github.com/trailbaseio/trailbase/discussions/new?category=q-a">
  Start a discussion on GitHub for community support
</Card>

***

Remember: TrailBase is open source and maintained by volunteers. Your patience, detailed questions, and contributions back to the community are greatly appreciated! 🙏