Frequently Asked Questions

Open Source Site Tracking is a comprehensive analytics platform designed specifically for open source projects. It provides real-time analytics, user behavior tracking, conversion funnels, and detailed reporting capabilities to help project maintainers understand how users interact with their project websites and documentation.

Yes! The platform is released under the MIT License, which means it's completely free to use, modify, and distribute. You can host it on your own servers, customize it to your needs, and even contribute to its development.

Key features include:

• Real-time analytics dashboard
• Page view and visitor tracking
• User behavior analysis
• Conversion funnel tracking
• Heat map analytics
• Form analytics
• User flow analysis
• Team management and collaboration
• Custom report generation
• REST API for data access

Minimum requirements:

• CPU: 2 cores (4 recommended)
• RAM: 2GB (4GB recommended)
• Storage: 20GB (50GB recommended)
• OS: Linux, macOS, or Windows
• Docker: 20.10+ (recommended)
• Python: 3.8+
• Node.js: 16+

The easiest way is using Docker Compose:

git clone https://github.com/AutoBotSolutions/Opensource-Site-Tracking.git
cd opensource-site-tracking
docker-compose up -d

For detailed installation instructions, see the Installation Guide.

Yes! You can install the platform manually. See the Installation Guide for detailed instructions on manual installation using Python and Node.js.

Simply add this script to your website's <head> section:

<script src="https://your-domain.com/tracking.js" 
        data-project-id="your-project-id"></script>

Replace your-project-id with your actual Project ID from the dashboard.

The platform tracks:

• Page views and unique visitors
• User sessions and duration
• Click events and interactions
• Form submissions and interactions
• Scroll behavior and engagement
• Geographic location data
• Device and browser information
• Referral sources and campaigns

Yes! You can track custom events using the JavaScript API:

SiteTracking.track('button-click', {
  button: 'signup',
  page: 'homepage'
});

Navigate to the Teams section, click "Invite Members", enter the email address and assign appropriate roles. The invited member will receive an email with instructions to join.

The platform supports several roles:

• Owner: Full control over resources
• Admin: Administrative access
• Manager: Project and team management
• Member: Standard access
• Viewer: Read-only access

Yes! You can create custom roles with specific permissions tailored to your organization's needs. This allows for fine-grained access control.

The platform uses modern technologies:

• Backend: Python, FastAPI, PostgreSQL, Redis
• Frontend: Next.js, React, TypeScript, Tailwind CSS
• Database: PostgreSQL with SQLAlchemy ORM
• Caching: Redis for performance
• Queue: Celery for background tasks

Yes! The platform provides a comprehensive REST API for accessing analytics data, managing users, and integrating with other systems. See the API Documentation for details.

Yes! You can export analytics data in multiple formats including CSV, JSON, and PDF. Reports can be scheduled for automatic generation and delivery.

Check the following:

• Verify the tracking script is correctly installed
• Check that your Project ID is correct
• Look for JavaScript errors in browser console
• Ensure your website is accessible
• Check if ad blockers are blocking the script

Try these solutions:

• Wait a few minutes for data to process
• Check project status in dashboard
• Verify tracking is working
• Check data retention settings
• Contact support if issue persists

Several options are available:

• Check the comprehensive documentation
• Search existing issues on GitHub
• Ask questions in GitHub Discussions
• Join our Discord community
• Create a new issue for bugs or feature requests