54 lines
2.5 KiB
Markdown
54 lines
2.5 KiB
Markdown
|
# Configuration Documentation Index
|
||
|
|
|
||
|
|
**Last Updated**: 2025-01-27
|
||
|
|
**Status**: Active
|
||
|
|
|
||
|
|
This index helps you find the right configuration guide for your needs.
|
||
|
|
|
||
|
|
## Which Guide Should I Use?
|
||
|
|
|
||
|
|
### Network Configuration
|
||
|
|
**Use**: [Network Configuration Guide](NETWORK_CONFIGURATION_GUIDE.md)
|
||
|
|
**When**: You need to configure the Besu network, genesis file, or network topology
|
||
|
|
**Covers**: Network configuration tool, genesis block, network settings
|
||
|
|
|
||
|
|
### Azure and Cloudflare Setup
|
||
|
|
**Use**: [Azure/Cloudflare Environment Setup](AZURE_CLOUDFLARE_ENV_SETUP.md)
|
||
|
|
**When**: You need to set up environment variables for Azure and Cloudflare integration
|
||
|
|
**Covers**: Azure subscription, Cloudflare zone ID, API tokens, Terraform backend
|
||
|
|
|
||
|
|
### Contract Deployment Setup
|
||
|
|
**Use**: [Contract Deployment Environment Setup](CONTRACT_DEPLOYMENT_ENV_SETUP.md)
|
||
|
|
**When**: You need to configure environment variables for deploying contracts
|
||
|
|
**Covers**: Private keys, CCIP configuration, WETH deployment, Oracle setup
|
||
|
|
|
||
|
|
### Azure Naming Conventions
|
||
|
|
**Use**: [Azure Naming Convention (3 Character)](AZURE_NAMING_CONVENTION_3CHAR.md) - **Recommended**
|
||
|
|
**When**: You need to name Azure resources using the standard 3-character region codes
|
||
|
|
**Covers**: Standard naming pattern with 3-character region codes (e.g., `wst`, `nor`)
|
||
|
|
|
||
|
|
**Alternative**: [Azure Naming Convention (2-3 Character)](AZURE_NAMING_CONVENTION_2CHAR.md)
|
||
|
|
**When**: You need to use 2-3 character region codes (legacy/alternative)
|
||
|
|
**Covers**: Alternative naming pattern with 2-3 character region codes (e.g., `we`, `ne`)
|
||
|
|
|
||
|
|
## Quick Reference
|
||
|
|
|
||
|
|
| Guide | Purpose | When to Use |
|
||
|
|
|-------|---------|-------------|
|
||
|
|
| [Network Configuration Guide](NETWORK_CONFIGURATION_GUIDE.md) | Besu network setup | Configuring blockchain network |
|
||
|
|
| [Azure/Cloudflare Environment Setup](AZURE_CLOUDFLARE_ENV_SETUP.md) | Azure/Cloudflare env vars | Setting up infrastructure |
|
||
|
|
| [Contract Deployment Environment Setup](CONTRACT_DEPLOYMENT_ENV_SETUP.md) | Contract deployment env vars | Deploying smart contracts |
|
||
|
|
| [Azure Naming (3 Char)](AZURE_NAMING_CONVENTION_3CHAR.md) | Azure naming (standard) | Naming Azure resources (standard) |
|
||
|
|
| [Azure Naming (2-3 Char)](AZURE_NAMING_CONVENTION_2CHAR.md) | Azure naming (alternative) | Naming Azure resources (alternative) |
|
||
|
|
|
||
|
|
## Related Documentation
|
||
|
|
|
||
|
|
- [Master Documentation Index](../MASTER_DOCUMENTATION_INDEX.md)
|
||
|
|
- [Deployment Guide](../deployment/DEPLOYMENT.md)
|
||
|
|
- [Architecture Documentation](../architecture/ARCHITECTURE.md)
|
||
|
|
|
||
|
|
---
|
||
|
|
|
||
|
|
**Last Updated**: 2025-01-27
|
||
|
|
|