Prerequisites

Prerequisites for GStatus #

Before you begin using GStatus, ensure that your environment meets the following requirements. These prerequisites help ensure a smooth installation and optimal performance.

1. General Requirements #

Supported Environments #

  • Browsers: GStatus is compatible with modern browsers such as:
    • Google Chrome (v60+)
    • Mozilla Firefox (v55+)
    • Microsoft Edge (v79+)
    • Safari (v11+)
  • Server: Hosting server must support HTTPS for secure data transmission.

Minimum System Specifications #

  • Client-Side:

    • JavaScript enabled in the browser.
    • Minimal impact on browser memory (<50 KB script size).

  • Server-Side (if hosting GStatus backend):

    • Node.js v14+ (recommended).
    • At least 1 GB of RAM.
    • Disk space for analytics storage (varies by traffic, ~100 MB/month for small sites).

2. Hosting and Domain Requirements #

Self-Hosted Backend (Optional) #

If you choose to self-host the GStatus API for complete data control:

  • A VPS or dedicated server.
  • Ability to install and configure software (e.g., Docker, Nginx).

Domain Name #

Ensure you have a valid domain name for your website (e.g., https://yourwebsite.com).

3. Web Development Environment #

To integrate GStatus effectively, you’ll need basic knowledge of web development and access to:

  • Your website’s source code.
  • The ability to upload and edit files on your server or hosting provider.

4. Permissions and Compliance #

GDPR and Privacy Compliance #

If you are operating in regions with strict data protection laws (e.g., GDPR, CCPA):

  • Ensure you inform users about tracking in your privacy policy.
  • Implement a consent mechanism (e.g., a cookie banner).

User Permissions #

Make sure you have the necessary access to:

  • Modify your website’s HTML, CSS, and JavaScript files.
  • Add third-party libraries or scripts.

5. Tools and Software #

Required Tools #

You’ll need the following tools installed locally or accessible on your development machine:

  • Node.js and npm (for package installation):
  • Text Editor or IDE:
    • Examples: Visual Studio Code, Sublime Text.
  • Browser Developer Tools:
    • Use built-in tools in Chrome, Firefox, or Edge to debug and verify tracking scripts.

Optional Tools #

For advanced configurations:

  • Git:
    • Useful for version control and collaboration.
  • Command Line Interface (CLI):
    • Basic knowledge of CLI for npm commands or debugging.

6. Network and Connectivity #

CDN Access #

If using the GStatus CDN for the library:

  • Ensure that your server allows outgoing requests to https://cdn.gstatus.org.

API Endpoint #

If hosting analytics data externally or using a custom backend, ensure:

  • Your API endpoint is reachable from your client-side code.
  • Secure API keys are generated for authentication.

While GStatus is designed to be beginner-friendly, having the following knowledge can help you maximize its potential:

  • Basic HTML and JavaScript:
    • To integrate GStatus scripts and track custom events.
  • Web Performance Optimization:
    • Understanding concepts like Core Web Vitals helps you use GStatus effectively.
  • Privacy Best Practices:
    • Familiarity with GDPR, CCPA, or similar regulations.

Next Steps #

Once you’ve confirmed that your environment meets these prerequisites, head over to the Installation Guide to begin setting up GStatus on your website.

Need help? Visit our Support Page or email us at support@gstatus.org.