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 latest 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
    ├── DiagnosticsModule
    │   ├── HealthChecks.json
    │   ├── OpenTelemetry.json
    │   ├── PackingLogs.json
    │   └── Serilog.json
    └── UiModule
        └── ConnectionStrings.json

🔧 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

📊 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 documentation is provided for that use case.

Please refer to the Service Module page for more details.

🖥️ UI Module

Provides a web-based UI for packing demos and protocol decoding.

• 🔍 UI Module Overview