Charli3 Node Operator Backend Setup

Welcome to the Charli3 Node Operator Backend setup guide. This README provides a comprehensive overview of the setup process and points you to detailed documentation for each aspect of running a Charli3 node.

Table of Contents

• Charli3 Node Operator Backend Setup
  • Table of Contents
  • 🚀 Quick Start
  • 📚 Essential Documentation
  • 🔬 Advanced Topics
  • 🛠 Troubleshooting
  • System Architecture Overview
  • Prerequisites
  • Installation
  • Configuration Files
  • Available Oracle Feeds
  • Key Features
    • Alert System
    • Reward Collection
  • Security Considerations
  • 🚀 Performance Optimization
  • 🔄 Upgrading Your Node
  • Support and Community

🚀 Quick Start

1. 📋 Check the Prerequisites
2. 🛠 Follow the Installation Guide
3. ⚙️ Configure your node using the Configuration Guide
4. 🖥️ Start your node following the Running Your Node guide

📚 Essential Documentation

For production usage, we recommend reviewing these documents:

• Security Best Practices
• SLA Requirements
• Alerts Configuration
• Reward Collection Guide

🔬 Advanced Topics

For more in-depth information:

• Oracle Feeds Configuration
• Architecture Overview
• System Requirements
• Accessing Node Operator Backend Docker Image
• FAQ

🛠 Troubleshooting

Encountering issues? Check our Troubleshooting Guide.

System Architecture Overview

The recommended setup involves two servers:

1. Cardano Infrastructure Server: Runs the Cardano node, Ogmios, and Kupo.
2. Charli3 Node Server: Hosts the Charli3 node operator backend.

For a detailed explanation of the system architecture, refer to the Architecture Overview document.

Prerequisites

Before setting up your Charli3 node, ensure you meet all system requirements. These include hardware specifications, software prerequisites, and network requirements.

For a comprehensive list of prerequisites, see the Prerequisites document.

Installation

Follow these steps to set up your Charli3 node:

1. Set up the Cardano Infrastructure Server
2. Clone the Charli3 Node Operator Setup Repository
3. Access the Node-Operator-Backend Docker Image
4. Prepare your node wallet

For detailed installation steps, refer to the Installation Guide.

Configuration Files

Charli3 nodes use two types of configuration files:

• config.yml: Feed-specific configuration files
• dynamic_config.yml: Shared configuration file for parameters common across all feeds

For more information on configuring your node, see the Configuration Guide.

Available Oracle Feeds

Charli3 supports various oracle feeds, including:

• ADA/USD
• BTC/ADA
• ETH/USD
• And more

For a complete list and configuration details, refer to the Oracle Feeds Configuration guide.

Key Features

Alert System

Charli3 nodes include a configurable alert system to notify operators of important events or issues. For setup and configuration details, see the Alerts Configuration Guide.

Reward Collection

Automatic reward collection allows node operators to efficiently manage their earned C3 tokens. Learn more in the Reward Collection Guide.

Security Considerations

Security is crucial when operating a Charli3 node. Key security measures include:

• Protecting your mnemonic phrase
• Implementing server hardening techniques
• Using strong authentication methods

For detailed security best practices, refer to the Security Best Practices guide.

🚀 Performance Optimization

To ensure your node operates at peak efficiency:

• Optimize your server's resources
• Fine-tune your database configuration
• Consider using pgbouncer for improved database performance

For more details, consult the System Requirements and Configuration Guide.

🔄 Upgrading Your Node

Stay up-to-date with the latest features and improvements:

1. Regularly check for updates from the Charli3 team
2. Follow the upgrade instructions provided with each release
3. Always back up your configuration before upgrading

Support and Community

If you need assistance or want to connect with other Charli3 node operators:

• Join our Discord community (link to be provided)
• Visit the Charli3 website for more resources

Thank you for contributing to the Charli3 network! Your participation helps build a more decentralized and robust oracle system on Cardano.