/** @type {import('typedoc').TypeDocOptions} */
module.exports = {
  exclude: ['**/*.test.ts', '**/node_modules/**', '**/build/**'],
  excludeExternals: true,
  excludePrivate: true,
  gitRevision: 'main',
};


/** @type {import('typedoc').TypeDocOptions} */
module.exports = {
  basePath: '../',
  entryPoints: ['../packages/sdk', '../packages/integrations', '../packages/common'],
  entryPointStrategy: 'packages',
  out: 'interfaces/sdk',

  name: 'Internal SDKs',
  cname: 'docs.configu.com',
  navigationLinks: {
    'configu.com': 'https://configu.com',
    'app.configu.com': 'https://app.configu.com',
  },
  hideGenerator: true,
  visibilityFilters: {
    inherited: true,
    protected: true,
  },
  readme: 'none',

  plugin: ['typedoc-plugin-markdown', 'typedoc-plugin-frontmatter'],
  outputFileStrategy: 'modules',
  flattenOutputFiles: true,
  fileExtension: '.mdx',
  entryFileName: 'overview',
  excludeScopesInPaths: true,
  hidePageHeader: true,
  hidePageTitle: true,
  hideBreadcrumbs: true,
  publicPath: '/interfaces/sdk/',
  sanitizeComments: true,
};


Step-by-step guide for engineers to incorporate Configu into small-scale applications, enhancing configuration management from the get-go.

Integrate Configu

Configu

Configu is an **open-source, end-to-end ConfigOps infrastructure** that empowers engineering teams to seamlessly manage and collaborate on **software configuration data**—such as environment variables, secrets, and feature flags—across any system or environment. ⚙️✨

Overview

Use Cases

Configu emerges in the landscape of configuration management as a **purpose-built solution**, designed to address and overcome the limitations commonly faced with traditional and contemporary approaches. Here's a detailed comparison that showcases why Configu is the preferred choice for developers, DevOps, SREs, and platform engineers.

Comparison

Gain a solid understanding of the foundational elements that drive Configu's configuration management system. This page provides a short overview of key concepts to help you navigate and utilize Configu effectively.

Concepts

Configu is designed to revolutionize the way software configurations are managed, integrating seamlessly into the software development lifecycle. Its architecture and workflow are meticulously crafted to support and enhance configuration management, making it a critical component of modern software development practices. Let's delve into the intricacies of how Configu operates, from its architectural foundation to its comprehensive workflow.

Workflow

Configu Orchestrator (open-source)

The `Cfgu` format defines the characteristics of a software configuration in Configu, providing metadata and constraints for `ConfigValues`. When attached to a `ConfigKey` in a `ConfigSchema`, it enables validation of `ConfigValues`, facilitating their implementation in the code.

.cfgu

Configu Configuration-as-Code Format

The `.configu` file is an optional configuration file used by the various Configu interfaces to customize its behavior. The file should be named `.configu` regardless of the format used: JSON or YAML.

.configu

Configu Interface Configuration File

Learn how to integrate Configu into your project.

Learn how to quickly get started with `Configu`. We'll use the `Configu CLI` and the `Configu ConfigStore` (Configu Platform) to declare, initialize, and export a simple set of configuration data.

Hello World

Advanced integration strategies for deploying Configu in your CI/CD pipelines, tailored for experienced engineers aiming to optimize deployment workflows.

CI/CD with Configu

HashiCorp Vault

Managing HashiCorp Vault using Configu CLI

Learn how to use React Native with `Configu`. We'll use the `Configu CLI` and the `Configu ConfigStore` (Configu Platform) to declare, initialize, and export a simple set of configuration data which you can use in your React Native app.

React Native with Configu

This guide is intended to help with migration to v1.

V1 Migration

V1 Migration Guide

Guides

Blog

Contributing

Change Log

Chat

Platform

`Configu CLI` is the easiest interface for getting started with Configu. With the command-line interface (CLI), you can easily interact with Configu using a terminal or an automated system, providing you with all the functionality you need to orchestrate your configuration data and beyond.

Setup

A reference guide for all Configu CLI commands.

Reference

Command Reference

A reference guide for all Configu Proxy Endpoints.

API Reference

Core SDK

Configu SDK for Node.js published to [npm](https://www.npmjs.com/package/@configu/node).

Integrations Library

Common Library

Learn how to send Activity Log events to a Discord channel.

Create a Discord Webhook

Learn how to send Activity Log events to a Slack channel.

Create a Slack Webhook

Learn how to trigger a [GitHub workflow](https://docs.github.com/en/actions/using-workflows/triggering-a-workflow) from a webhook invocation.