Ridy Documentation

Appearance

Docker Deployment ​

Ridy’s containerized architecture allows for fast and consistent deployment using Docker and Docker Compose. This is the preferred method for production, staging, and most development environments.

✅ Why Choose Docker Deployment? ​

  • Fast setup with a one-line script
  • Environment consistency across machines and teams
  • Zero manual dependency management
  • Ready for scaling in cloud environments
  • Database persistence with Docker volumes

📦 What’s Included in the Docker Stack? ​

The included docker-compose.yml file provisions:

ServicePurpose
rider-apiCustomer ride operations
driver-apiDriver-related logic
admin-apiBackend for the Admin Panel
payment-gatewaysProcessor for 22+ integrated gateways
mysqlRelational database (Docker volume-persisted)
redisCaching and job queues
nginxServes frontend & API routing

🛡️ Licensing Requirements ​

  • Each license is tied to one public IP.
  • Changing IPs frequently or deploying to multiple machines will result in license conflicts or temporary lockouts.
  • A static IP VPS is required for Docker deployment.
  • Running locally (on laptops or desktops) may consume your license unintentionally.

💡 Tip: Contact support if you need a dev license slot for local experimentation.

⚙️ Installation Steps ​

Download & Run the installation script:

bash
curl -sSL https://uploads.ridy.io/install.sh | sh
  • Installs Docker and Docker Compose if missing
  • Applies default .env values from the included .env.example
  • Builds and launches all containers

Advanced users can edit .env and docker-compose.yml before or after setup to customize ports, resource limits, or volumes.

🌍 Accessing the Admin Panel ​

Once setup completes, visit:

http://yourdomain.com/admin/

You will be guided through the Admin Installation Wizard, which includes:

  • License key verification
  • Initial database setup
  • Admin user creation
  • Branding and system name input
  • Firebase & map key configuration

💾 Data Persistence ​

  • MySQL data is stored in Docker volumes and remains safe across container restarts or rebuilds.
  • Logs and cache are not wiped unless volumes are explicitly deleted.

🧠 Resource Requirements ​

  • The full stack uses approximately 2 GB RAM on idle
  • Ensure your VPS has at least:
    • 2 GB RAM
    • 2-core CPU
    • 10 GB disk space
    • Static IP address

📌 Post-Install Configuration Tasks ​

After installation:

  1. Log in to the Admin Panel
  2. Go to:
    • Settings → SMS Providers: Choose and configure one of 8 available
    • Settings → Payment Gateways: Select and set up from 22 integrated gateways
    • Regions & Pricing: Define your operational areas and fare structures
  3. (Optional) Upload your brand logo and set system-wide colors

🔧 Managing Your Deployment ​

Once installed, you can manage your services using Docker commands:

bash
docker-compose ps          # View running containers
docker-compose logs -f     # Stream live logs
docker-compose restart     # Restart all services
docker-compose down        # Stop and remove containers (volumes are safe)

For advanced scaling or separation (e.g., moving MySQL or Redis to dedicated servers), edit the docker-compose.yml and .env accordingly.