Docs
Quick Start
Local Setup

Local Setup Guide

This is a condensed version of our Local Installation Guide

Step 1. Download the Installation Files

Manual Download

  1. Go to the Install Option for your Architecture

  2. Download the ZIP File: Click the green “Code” button, then click “Download ZIP.”

  3. Extract the ZIP File: Find the downloaded ZIP file, right-click, and select “Extract All…“.

Using Git

Run the following git command in your terminal, from the desired parent directory:

git clone https://github.com/ecosystemai/ecosystem.git

To update to the latest install options and files:

git pull

Step 2. Install Docker

  1. Download: Go to Docker Desktop Download Page and download Docker Desktop.
  2. Install: Open the installer and follow the instructions.
  3. Run: Open Docker Desktop to ensure it is running.

Notes:

  • Docker Desktop is recommended for most users.
  • You may need to restart your computer after installation.

Step 3. Run the App

  1. Navigate to the Project Directory

  2. Create and Configure .env File:

    • Copy the contents of ecosystem_env.txt to a new file named .env.
    • Fill in any necessary values.

    Add your keys for OPENAI_API_KEY and ECOSYSTEM_API_KEY.

    DATA_PATH=./data
    OPENAI_API_KEY=
    ECOSYSTEM_API_KEY=
    
  3. Start the Application: Find your correct install folder. Run the following command from within the install directory:

    • ARM64
    cd ecosystem/docker-arm
    ./start.sh
    • x86
    cd ecosystem/docker-x86
    ./start_x86.sh
    • Windows
    cd ecosystem\docker-windows
    start.bat

Conclusion

That’s it! You should now have ecosystem.Ai running locally on your machine. Enjoy!


Additional Links

Explore more about ecosystem.Ai and how to configure it to your needs.