RAIRprotocol
  • 💎Welcome to RAIR
  • 💴Whitepaper (draft)
    • Start
      • History
      • Licensing
      • Codebase
      • Onboarding
      • Mechanics
        • Burn Model
        • Earn Model
      • Governance (DAORM)
  • ↔️Integrations
    • Core Technologies
      • Guides
        • Alchemy
        • GCP Cloud Storage
        • Web3Auth
    • Blockchains
  • 👩‍💻CODEBASE
    • RAIRsolidity
      • Soneium (Minato)
      • Core DAO
      • All Contract Addresses
      • Transfer functions
    • RAIRdapp
      • RAIRfrontend
        • Proxy Settings for Default Frontend
        • Frontend Variables Library
      • RAIRnode
        • Permissions and Access Controls
        • Backend Variables Library
      • RAIRsync
        • Integrating New EVMs
      • RAIRstream
      • RAIRinfra
    • RAIR API
      • Endpoints
        • Auth
          • Get challenge
          • Login
          • Logout
          • Me
          • Unlock
          • Stream
            • Out
        • Analytics
          • Csv
        • Contracts
          • FactoryList
          • Full
          • Import
          • My
          • Network
            • Products
              • Offers
        • Credits
          • Withdraw
        • Favorites
        • Files
          • ById
          • ByCategory
          • Categories
          • ForToken
          • Unlocks
          • List
          • Remove
          • Update
        • Nft
          • Network
            • Attributes
            • Files
            • Locks
            • Offers
            • Token
              • Pinning
          • PinningMultiple
          • Csv
            • Sample
        • Offers
          • /
        • Products
          • /
          • User
        • Resales
          • Create
          • Delete
          • Open
          • Purchase
          • Update
        • Search
          • All
        • Settings
          • Featured
          • Theme
          • AppLogo
        • Tokens
          • /
          • TokenNumbers
        • Transaction
        • Upload
          • File
          • Validate
        • Users
          • /
          • Export
          • List
          • Yoti verify
      • Specification
    • A Note on Documentation
  • ⚙️Installation and Testing
    • Getting Started
      • Welcome to New Web3 Devs!
      • RAIRlite (Single VM)
        • Windows WSL Installation
        • MVP Test Plan
        • https configuration
      • RAIRcloud (Cloud Enabled)
        • Cloud Test Plan
  • 🛟End User Guides
    • User Functionality
      • How to login
      • Buy your first NFT
      • Put items up for sale
      • Watch Content
    • Admin Functionality
      • Deploying NFT contracts
      • Managing Metadata
      • Managing Media
      • Managing Marketplace
      • Managing Users
      • Importing External Contracts
Powered by GitBook
On this page
  • Simple Deployment
  • Video Workflow
  • Install Docker-Compose
  • Configure .env
  • Build RAIRlite
  • Test plan

Was this helpful?

  1. Installation and Testing
  2. Getting Started

RAIRlite (Single VM)

Deploying RAIR to localhost or single cloud VM.

PreviousWelcome to New Web3 Devs!NextWindows WSL Installation

Last updated 10 months ago

Was this helpful?

Simple Deployment

Getting up and running with RAIRprotocol is easy!

  1. Pick where you'd like to deploy. , Ubuntu Local, or Ubuntu Cloud VM

  2. Install Docker and Docker Compose

  3. Clone/Fork our repo and run a simple docker command to deploy the entire system!

  4. Configure Docker with your admin NFT and your own API keys (Alchemy, etc)

Video Workflow

Install Docker-Compose


Configure .env

Inside the repository root is a file called .env.sample. This template contains a list of values that are to be consumed during the build process:

  1. Create a new file in /rair called .env

  2. Copy and paste the contents of .env.sample into .env


Build RAIRlite

It's the moment of truth. From the command line, in the repository root, run:

docker-compose -f {dockerfile.yml} up

Wait for the build to complete. (This may take a while if it's the first time as dependencies need to be downloaded)

Once successfully deployed, point the browser to the RAIRfrontend service (probably localhost:8080, or wherever you set the host in .env).

You should see the application running!


Test plan

RAIR deploys each its services in a self-contained Docker image. If you are building RAIR from a desktop environment, you can install which also adds theDocker-Compose command line utility to your system.

If another setup is desired, you can .

Refer to the for help populating .env.

Finally, to ensure that you are running the Minimum Viable Product, execute our .

⚙️
Docker Desktop
install Docker-compose manually
Backend Variables Library
MVP Test Plan
Windows WSL
Screen capture installation flow