Hiyve Components - v1.0.0
    Preparing search index...

    Function loadHiyveConfig

    • Load Hiyve server configuration from environment variables.

      Parameters

      • env: Record<string, string | undefined> = process.env

        Environment object to read from (default: process.env)

      Returns HiyveServerConfig

      Populated server config

      Reads the standard env vars used by all Hiyve example servers:

      • APIKEY — API key for signaling server and cloud API
      • CLIENT_SECRET — client secret for signaling server
      • SERVER_REGION — region identifier (default: 'us-east-2')
      • SERVER_REGION_URL — region URL suffix (default: '.rtc.muziemedia.com')
      • ENVIRONMENT — 'production' or 'development' (default: 'development')
      • HIYVE_CLOUD_API_URL — explicit cloud API base URL. Overrides the environment-derived default; set it when the cloud API is reached through a host you control (private DNS, a proxy, or an isolated stack) rather than the public per-environment hostname.
      import { loadHiyveConfig, mountHiyveRoutes } from '@hiyve/admin';

      const config = loadHiyveConfig();
      mountHiyveRoutes(router, config);

    Settings

    Member Visibility