mobilecoin-consensus-fog
  • Consensus Server Runbook
  • About
    • About this Runbook
      • Audience
        • How to Use This Information
  • Common Tasks
    • About Common Tasks
  • Understanding the Consensus Server
    • Secure Enclaves
  • Prerequisites
    • IAS Account
    • SGX-Enabled Machine
  • Getting Intel Attestation Service Credentials
    • Quote Status Responses
    • Validating the Attestation
  • SGX Provisioning
    • Provisioning with Azure
    • Downloading the Consensus Server Software
      • Downloading the Pre-Built Container from Docker Hub
  • Running the Node
    • Running the Node in a Container (Preferred Method)
      • Environment Variables: How to Configure Your Node
      • Run It!
    • Using Your Own Binaries (Without Docker)
      • Run It!
  • Upgrading the Enclave
    • Unacceptable Degradation of Service
    • Uneven Node Block Heights
    • Monitoring
  • Configuring your Node
    • Configuring your Node to Connect with Trusted Peers
      • Broadcasting to Trusted and Untrusted Peers
      • Defining a Consensus Quorum Set
      • Obtaining Ledger Contents from S3 Archive for Catchup
    • Signing Consensus Messages
    • Distributing Ledger Contents to S3 Archive
    • Obtaining the Origin Block
    • Updating Your Network Configuration
  • Attesting to the Consensus Server
  • Proposing Transactions
  • Verifying Transactions are Working Correctly
    • Send Transaction
    • Use the Python API to Check Balance and Send Transactions
    • Verify Nodes are Participating in Consensus
  • Common Errors and Alerts
    • Common Errors
    • Common Alerts
  • Glossary
    • Glossary
  • Frequently Asked Questions (FAQs)
    • FAQs
Powered by GitBook
On this page
Edit on GitHub
  1. Running the Node
  2. Running the Node in a Container (Preferred Method)

Environment Variables: How to Configure Your Node

PreviousRunning the Node in a Container (Preferred Method)NextRun It!

Last updated 3 years ago

The following environment variables should be provided:

Variable
Value
Function

LOCAL_NODE_ID

address:port

Local node name for logging. Should ideally match the value of peer-responder-id as provided to consensus-service.

NODE_LEDGER_DIR

Path to ledger

The location of the ledger. We suggest that this should be persistently stored outside the container and mounted in. On startup, if the contents of NODE_LEDGER_DIR are empty, then the origin block from within the container should be copied into the NODE_LEDGER_DIR.

CONSENSUS_ADMIN_URI

URI

The URI for the admin http service which provides a management panel to the consensus service. The gateway is started in the container and is set to listen via this environment variable. Used by mc-admin-http-gateway.

AWS_ACCESS_KEY_ID

AWS Credential

Should have write access to your S3 ledger archive bucket. Used by ledger-distribution.

AWS_SECRET_ACCESS_KEY

AWS Credential

Should have write access to your S3 ledger archive bucket. Used by ledger-distribution.

AWS_PATH

S3 URL

The S3 location of your S3 ledger archive bucket. Used by ledger-distribution.

SGX_MODE

HW or SW

Indicates whether to run with SGX in hardware or simulation mode. (Should be HW). Used by consensus-service.

IAS_MODE

PROD or DEV

Indicates whether to hit the Intel Attestation Service’s prod or dev endpoint. (Should be PROD). Used by consensus-service.

RUST_LOG

info, debug, trace

Sets the log level. Can also be tuned per specific rust crate. See . Used by ledger-distribution and consensus-service.

RUST_BACKTRACE

full, 1, 0

Indicates how much detail to provide in the backtrace in the event of a panic. Used by ledger-distribution and consensus-service.

env_logger