Switchboard Documentation
  • Understanding Switchboard
    • Introduction
      • Why Switchboard Oracles?
      • Vision & mission
      • Brief History and Key Achievements to Date
      • Switchboard’s Architecture, Tech Stack and Security
        • Trusted Execution Environments (TEEs)
        • Oracle Queues
        • Node Architecture
  • Product Documentation
    • Data Feeds
      • Getting Started with Switchboard Data Feeds
      • Solana / SVM
        • Part 1: Designing and Simulating Your Feed
          • Option 1: Drag-and-Drop Feed Builder
          • Option 2: Designing a Feed in Typescript
        • Part 2: Deploying your Feed On-Chain
        • Part 3: Integrating your Feed
          • Integrating your Feed On-Chain
          • Integrating into Frontends
        • Costs
        • Integrating on Eclipse
      • EVM
        • Part 1: Prerequisites and Quick Start Guide
        • Part 2: Designing and Creating Your Feed
          • Option 1: Drag-and-Drop Feed Builder
          • Option 2: Designing a Feed in Typescript
        • Part 3: Integrating your Feed
          • Integrating your Feed On-Chain
          • Integrating your Feed with Typescript
          • Integrating into Frontends (EVM)
      • Aptos
      • Sui
      • Movement
      • Starknet
      • Optional Features
        • Switchboard Secrets
    • Aggregator
      • How to use the Switchboard Oracle Aggregator
    • Randomness
      • Why Randomness is important?
      • Switchboard's Approach to Verifiable Randomness
      • Tutorials
        • Solana / SVM
        • EVM
  • Tooling and Resources
    • Crossbar
      • Run Crossbar with Docker Compose
    • Switchboard Command Line Interface
    • Technical Resources and Documentation
      • SDKs and Documentation
      • Solana Accounts
      • EVM Identifiers
      • Code Examples (Github)
  • Switchboard Protocol
    • (Re)staking
      • What is (re)staking?
      • What are Node Consensus Networks (NCNs)?
      • What are Vault Receipt Tokens (VRTs)?
      • The Node Partner Program
      • The Switchboard NCN
    • Running a Switchboard Oracle
      • Prerequisites
        • Knowledge about Linux, containers and Self-Hosting
        • Hardware Requirements and AMD SEV SNP
        • Software Requirements
        • Network Requirements
      • Hardware: tested providers and setup
        • OVH
      • Platform: Kubernetes + AMD SEV SNP
        • Bare Metal with Kubernetes (K3s)
      • The Git Repo: Clone Our Code
        • Repo Structure
      • Configuration: Tweaking Configurations
        • cfg/00-common-vars.cfg
        • cfg/00-devnet-vars.cfg and cfg/00-mainnet-vars.cfg
      • Installation: Setup Via Scripts
        • Bare Metal with Kubernetes (K3s) + AMD SEV SNP
  • Frequently Asked Questions and Glossary
    • FAQ
    • Glossary
Powered by GitBook
On this page
  1. Switchboard Protocol
  2. Running a Switchboard Oracle
  3. The Git Repo: Clone Our Code

Repo Structure

Our infra-external repo intro and structure

First step is then to clone our infra-external github repo locally and cd into it:

git clone https://github.com/switchboard-xyz/infra-external
cd infra-external

This repository structure is divided into three main areas:

infra-external/
│
├── README.md
│
├── cfg/
│   │
│   ├── 00-common-vars.cfg
│   ├── 00-devnet-vars.cfg
│   └── 00-mainnet-vars.cfg
│
├── data/
│   │
│   ├── devnet_payer.json
│   └── mainnet_payer.json
│
└── oracle/
    │
    └── bare-metal/
        └── kubernetes/
            └── ... scripts ...

These areas serve as follows:

  • cfg/: Contains configuration files for two environments, devnet and mainnet plus a shared one called common that contains shared variables that apply to both. You may want to backup this directory at least once or every time you change its content.

  • data/: Holds essential data files like devnet_payer.json and mainnet_payer.json needed for setting up the Oracles. May be populated by other directories after setup. You may want to backup this directory at least once or every time you change its content.

  • oracle/: Includes scripts for setting up Oracles. This directory can be ignored during backups and will change as we update our process.

  • README.md: it's the README file for the repo, in Markdown format.

Continue to the next section where we'll take care of the configuring files.

PreviousThe Git Repo: Clone Our CodeNextConfiguration: Tweaking Configurations

Last updated 2 months ago