Skip to main content
Version: 1.0.x

Welcome to Lunar.dev Documentation

Lunar.dev provides a robust platform for API consumption management, helping you optimize and control your API traffic at scale. Whether you are just getting started or deploying Lunar.dev in production, this documentation will guide you through every step.

To make your journey easier, we’ve created checklists for the most important steps you need to follow. Whether you're learning what Lunar is, evaluating it, or preparing to deploy it in your production environment, we’ve organized the essential docs you’ll need for each phase.

Each section of our documentation comes with an overview page, serving as an "interface" that introduces high-level concepts, while the sub-pages dive into specific details—much like the implementation of a function. This modular approach allows readers to easily locate the exact information they need while keeping the content concise and approachable.

tip

If you're ever unsure where to look, we’ve included an AI chatbot that’s always ready to assist you in finding the answers you're looking for.

caution

As of the current release, Lunar Flows are not enabled by default in the latest version (1.0.x) of Lunar Gateway. The default configuration still relies on policies.yaml for optimizing and shaping API traffic. If you wish to use the existing configuration style with policies.yaml, ensure the following environment variable is set:

  • Docker: LUNAR_STREAMS_ENABLED=false
  • Kubernetes (values.yaml): lunarStreamsEnabled: false

Please remember to restart the service after making these changes to apply the configuration.

We encourage users to update to the latest version due to various performance optimizations and enhancements already included, even if you continue using policies.yaml.

For more information on configuring policies.yaml, refer to this documentation link.

🟢 Learn What’s Lunar.dev

To understand the fundamentals of Lunar.dev and its capabilities, start with these key documents:

Checklist

Understand what Lunar.dev does.

Explore how Lunar.dev handles API consumption.

Dive into use cases relevant to your needs.

🔍 Evaluation Process

Once you understand Lunar.dev’s value, move on to evaluating how it fits your use case by exploring these resources:

Checklist

Confirm Lunar.dev meets your system requirements.

Evaluate its performance using benchmarks.

Identify the right use cases and solutions for your project.

đź›  Install Lunar.dev

Once you're ready to install Lunar.dev, follow the installation process outlined in the guides below:

Checklist

Complete the setup of the API Consumption Gateway.

Install via Docker or Kubernetes, depending on your environment.

Route your API traffic through Lunar using Direct Mode or Lunar Interceptor.

⚙️ Configuring Lunar Flows

Lunar Flows allow you to control and optimize API traffic. Start configuring flows with these resources:

Checklist

Explore different flow components and configuration options.

Set up custom quotas and flow management rules.

Choose from pre-built flows or create your own based on your needs.

🚀 Deploy Lunar.dev in Production

To ensure smooth operation in production, these documents provide key deployment and runtime configuration information:

Checklist

Ensure your production environment is configured with the required settings.

Implement Failsafe Mechanisms to guarantee service reliability.

Monitor and maintain API consumption using custom metrics and flows.

Join our community and stay connected with us via the following platforms:

These steps provide a clear path for understanding, evaluating, and implementing Lunar.dev.

If you encounter any issues, check our FAQs or contact support.