Welcome to the Initial Setup guide! 🌟 This document will walk you through the essential steps to configure your environment and get started with our platform.

🧰 System Requirements

Before proceeding, ensure your system meets the following criteria:

  • ✅ Operating System: Linux/Windows/macOS
  • ✅ RAM: Minimum 4GB
  • ✅ Disk Space: At least 20GB available
  • 📌 Network: Stable internet connection (❗ Required for API access)

📄 Configuration File Setup

  1. Create config.yaml
    Use the template provided at /Documentation/en/Configuration/Template to set up your initial configuration.

    configuration_file

  2. Set Environment Variables
    Define key variables like API_KEY and DATA_PATH in your .env file.

    environment_variables

  3. Validate Syntax
    Run yamllint config.yaml to ensure no formatting errors exist.

    syntax_check

🚀 Starting the Service

After configuration, start the service using: 

sudo systemctl start your_service_name

Check the status with: 

sudo systemctl status your_service_name
service_start

📌 Verification Steps

  • ✅ Access the dashboard at /Dashboard to confirm service is running
  • ✅ Check logs via journalctl -u your_service_name for any errors
  • ✅ Run a sample test script: test_initial_setup.sh

⚠️ Important Notes

  • Always back up your configuration files before making changes
  • For security, use HTTPS in production environments
  • Learn more about system requirements at /Documentation/en/Requirements
configuration_verification