Configuration

Binacle.Net is designed for flexibility, allowing you to enable only the features you need. Most functionality is provided through modules, each with its own requirements, configuration options, and dependencies.

This guide covers the configuration system for v3.0.x version.

Make sure to read Configuration Basics first then proceed with the specifics for this version.

📖 Table of Contents

• 📂 Configuration Files
  • 📑 Directory Structure
• 🔧 Modules Overview
  • 🏗️ Core
  • 📊 Diagnostics Module
  • 🛡️ Service Module
  • 🖥️ UI Module

📂 Configuration Files

All configuration files are located in /app/Config_Files.

📑 Directory Structure

app
└── Config_Files
    ├── Presets.json
    ├── Cors.json
    ├── ForwardedHeaders.json
    └── DiagnosticsModule
        ├── HealthChecks.json
        ├── OpenTelemetry.json
        ├── PackingLogs.json
        └── Serilog.json

ForwardedHeaders.json ships with the feature turned off. Cors.json is not in the image at all - add it only if a browser calls the API directly, since until you do, no origin is allowed through.

🔧 Binacle.Net Modules Overview

Each module adds functionality to Binacle.Net. This section provides an overview and links to detailed configuration pages.

🏗️ Binacle.Net Core

The foundation of Binacle.Net. Provides essential API functionality, Swagger UI, and presets.

• 🔍 Core Overview
• 📖 Presets
• 🌐 Forwarded Headers

📊 Diagnostics Module

Handles system health monitoring, logging, and telemetry. This module is always enabled, but not all of its features come enabled by default.

• 🔍 Diagnostics Module Overview
• 📜 Logging
• ❤️‍🩹 Health Checks
• 📦 Packing Logs
• 📡 OpenTelemetry

🛡️ Service Module

Allows Binacle.Net to run as a managed service with authentication and rate limiting.

This module is primarily made for the official Binacle.Net cloud service. It is still possible to enable it for self-hosted instances, but no public documentation is provided for it. A minor release can break it; a patch will not.

Please refer to the Service Module page for more details.

🖥️ UI Module

Adds two browser pages: a packing demo and a ViPaq decoder.

• 🔍 UI Module Overview