Skip to main content

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.

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

​
Support Channels

Documentation

Comprehensive guides, tutorials, and API references

GitHub Issues

Bug reports and feature requests

GitHub Discussions

Community Q&A, ideas, and general discussion

Discord Community

Real-time chat with the community (link in GitHub)

​
Getting Help

​
Before Asking for Help

To get the fastest response:
1

Search Documentation

Check if your question is answered in the documentation. Use the search feature to find relevant pages.
2

Search Existing Issues

Look through GitHub Issues and Discussions to see if your question has been asked before.
3

Check the FAQ

Review the FAQ page for common questions and answers.
4

Try the Demo

Experiment with the live demo to understand how features work.

​
How to Ask Good Questions

Help us help you by providing: 
trail --version
Specify:
  • TrailBase version
  • Operating system and version
  • Client library versions (if applicable)
  • What are you trying to accomplish?
  • What did you expect to happen?
  • What actually happened?
  • Can you reproduce it consistently?
Include:
  • Relevant code snippets (not entire files)
  • Configuration excerpts
  • SQL schema (if relevant)
  • API requests/responses
  • Error messages and stack traces
Redact sensitive information like passwords, tokens, and API keys!
  • 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.

​
Support Options

​
Community Support (Free)

The TrailBase community provides free support through various channels.
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
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
Security issues: Report privately to security@trailbase.io, not as public issues. See Security Policy.
Report a Bug | Request a Feature

​
Documentation

Comprehensive documentation at 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.
Deep dives into features and concepts:
  • Architecture decisions
  • Major feature announcements
  • Performance deep-dives
  • Migration guides
Read at trailbase.io/blog
Practical examples in the examples directory:
  • WASM components (JS, TS, Rust)
  • Client applications
  • Integration examples
  • Real-world use cases
Clone and run locally to learn by example.

​
Email Support

Email: security@trailbase.ioFor: Security vulnerabilities and sensitive issues onlyResponse 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 for the complete process.
Do NOT report security issues publicly on GitHub!
Email: contact@trailbase.ioFor:
  • License clarifications
  • Commercial license exceptions
  • Partnership inquiries
  • Private inquiries
Response time: Within a few business daysFor general licensing questions, see the license page first.

​
Self-Help Resources

​
Debugging Tips

Run TrailBase with verbose output:
RUST_LOG=debug trail run
Or for specific modules:
RUST_LOG=trailbase=debug trail run
Logs help identify issues and provide context when asking for help.
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.
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.
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

​
Common Issues

Symptoms: TrailBase won’t start or clients can’t connectSolutions:
  • Check if another process is using port 4000
  • Specify a different port: trail run --port 4001
  • Check firewall settings
  • Verify ADDRESS environment variable
Symptoms: Can’t log in or tokens are invalidSolutions:
  • Verify user exists and is verified
  • Check token expiration
  • Ensure clock synchronization (for JWTs)
  • Review access rules in admin UI
  • Check CORS settings
Symptoms: Record APIs return 404Solutions:
  • 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
Symptoms: WASM components don’t load or crashSolutions:
  • 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
Symptoms: Slow queries or high latencySolutions:
  • 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 for optimization tips

​
Contributing to Support

Help other community members:

​
Answer Questions

  • Browse GitHub 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

​
Share Your Experience

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

​
Enterprise Support

Official enterprise support is not yet available but may be offered in the future.

​
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

​
Support Best Practices

​
For Users

Be Patient

Community volunteers respond when they can. Complex issues take time.

Be Respectful

Everyone is helping out of goodwill. Treat others with respect.

Be Detailed

More information helps get better answers faster.

Give Back

Help others when you can. Share solutions you find.

​
For Helpers

Be Welcoming

Remember you were a beginner once. Be patient with newcomers.

Be Clear

Explain your reasoning. Provide examples. Link to documentation.

Be Constructive

Focus on solving problems, not criticizing approaches.

Know Your Limits

It’s okay to say “I don’t know” or point to someone who might know better.

​
Response Time Expectations

Set realistic expectations:
ChannelTypical Response TimePriority
Security emailHours to 1 dayHigh
GitHub Issues (bugs)1-7 daysMedium-High
GitHub Discussions1-7 daysMedium
DiscordHours to daysLow-Medium
GitHub Issues (features)1-14 daysLow-Medium
General email1-7 daysLow
These are estimates. Response times vary based on complexity, community availability, and maintainer workload.

​
Getting Updates

Stay informed about TrailBase:

Watch on GitHub

Get notified of releases and important issues

Subscribe to Releases

RSS feed for new releases

Follow on Twitter

Updates and announcements

Read the Blog

Deep dives and feature announcements

​
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

Ask for Help

Start a discussion on GitHub for community support
Remember: TrailBase is open source and maintained by volunteers. Your patience, detailed questions, and contributions back to the community are greatly appreciated! 🙏

Build docs developers (and LLMs) love

Get started for freeTalk to us