@accelerated-software-development/caddy-api-client - v0.4.3
    Preparing search index...

    Function loadCaddyfile

    • Load a Caddyfile and convert it to Caddy JSON format

      Convenience function for loading Caddyfile-formatted configuration. Equivalent to loadConfig(path, "caddyfile", options).

      Parameters

      • path: string

        Path to the Caddyfile

      • Optionaloptions: LoadConfigOptions

        Loading options (adminUrl, timeout)

      Returns Promise<Config & Record<string, unknown>>

      The parsed Caddy configuration object

      If the file content is empty or invalid

      If Caddy cannot parse the Caddyfile

      If unable to connect to Caddy Admin API

      If the request times out

      const config = await loadCaddyfile("./Caddyfile");

      // Modify the config
      config.apps.http.servers.srv0.routes.push(myNewRoute);

      // Apply to running Caddy
      await client.applyConfig(config);