๐Ÿ”ท
Locentra OS
๐Ÿ”ท
Locentra OS
  • ๐Ÿง  Introduction
  • โš™๏ธ Features
  • ๐Ÿ›  Under The Hood
  • ๐Ÿงฉ Installation
  • ๐Ÿš€ Usage
  • ๐Ÿงฎ CLI Commands
  • ๐Ÿ”Œ API Reference
  • ๐Ÿค– Agents System
  • ๐Ÿง  Semantic Memory
  • ๐ŸŽ“ Training & Fine-Tuning
  • ๐Ÿ” $LOCENTRA Token Access
  • ๐Ÿ— System Architecture
  • ๐Ÿงฉ Extending the System
  • ๐Ÿงช Testing & Quality Assurance
  • ๐Ÿ“„ License & Open Source
Powered by GitBook
On this page

๐Ÿงฉ Installation

Whether you're running it locally as a Python dev or deploying in containers as an ops engineerโ€”Locentra OS installs cleanly, boots fast, and stays under your control.

This guide covers both manual setup and Docker-based deployment.


๐Ÿงช System Requirements

Minimum:

  • Python 3.10+

  • Node.js 18+

  • PostgreSQL 13+

  • Docker & Docker Compose (for containerized setup)

Recommended:

  • Unix-like system (Linux/macOS)

  • 8GB+ RAM for live inference and training

  • GPU (CUDA) if using large models locally


๐Ÿงฑ 1. Clone the Repository

git clone https://github.com/Locentra/OS.git
cd OS

๐Ÿ 2. Manual Installation (Local Python Setup)

Ideal for devs who want to step through the system layer by layer.

๐Ÿ”น Backend Setup

cd backend
python -m venv .venv
source .venv/bin/activate
pip install -r requirements.txt

๐Ÿ”น Environment Variables

Copy the default .env and adjust settings:

cp .env.example .env

Example config:

MODEL_NAME=tiiuae/falcon-rw-1b
DATABASE_URL=postgresql://user:pass@localhost:5432/Locentra
DEBUG=true

๐Ÿ”น Frontend Setup

cd ../web
npm install

๐Ÿ”น Start Services

  • Backend:

    cd ../backend
    bash ../scripts/run_server.sh
  • Frontend:

    cd ../web
    npm run dev
  • Initialize Database:

    python ../database/db_init.py

๐Ÿณ 3. Docker Deployment (Recommended)

Fastest way to run the full stack locally. Clean, reproducible, no system conflicts.

๐Ÿ”น One-Liner Boot

cp .env.example .env
docker-compose up --build

๐Ÿ”น Access Points

Logs are streamed to console by default. Extend docker-compose.yml to route logs or mount volumes as needed.


๐Ÿ“ 4. Backend Structure Overview

Locentra-os/backend/
โ”œโ”€โ”€ api/         # FastAPI routes (REST API layer)
โ”œโ”€โ”€ core/        # Engine bootstrapping, registry, settings
โ”œโ”€โ”€ models/      # Inference, model loader, fine-tuning, adapter
โ”œโ”€โ”€ agents/      # AutoTrainer, FeedbackAgent (self-learning logic)
โ”œโ”€โ”€ db/          # SQLAlchemy models, migrations, connectors
โ”œโ”€โ”€ services/    # Logic layer: memory, analytics, user mgmt
โ”œโ”€โ”€ data/        # Tokenizer, vector embedding, dataset prep
โ”œโ”€โ”€ utils/       # Metrics, crypto helpers, evaluation

The backend is modularโ€”every service, agent, or component can be extended or replaced.

Previous๐Ÿ›  Under The HoodNext๐Ÿš€ Usage

Last updated 1 day ago

๐ŸŒ App:

๐Ÿง  API:

๐Ÿ’ป UI:

๐Ÿ“˜ Docs:

http://localhost
http://localhost:8000
http://localhost:3000
http://localhost/api/docs
Page cover image