AeThex AI 🧠

The operational intelligence core of the AeThex ecosystem

AeThex AI is your local AI assistant powered by KAEL (Knowledge-Augmented Execution Layer) - a direct, efficient AI agent designed for developers, architects, and strategic thinkers.

Built on Open WebUI (MIT License).

---

Quick Start 🚀

Prerequisites

1. Ollama - Install from ollama.ai
2. Python 3.11+ - Required for the backend
3. Node.js 18-22 - Required for the frontend

Setup

1. Start Ollama and pull a model:

   ollama serve
   ollama pull llama3.2
   

2. Install Python dependencies:

   cd backend
   pip install -r requirements.txt
   

3. Install frontend dependencies:

   npm install --legacy-peer-deps
   

4. Configure environment:

   # Copy the .env file (already configured for AeThex)
   # Edit .env if you need to change OLLAMA_BASE_URL
   

5. Initialize KAEL model:

   python scripts/init_kael.py
   

   Or import manually via Admin Panel > Workspace > Models > Import using aethex-models/kael.json

6. Start the server:

   # Backend
   cd backend
   uvicorn open_webui.main:app --host 0.0.0.0 --port 8080 --reload
   
   # Frontend (in another terminal)
   npm run dev
   

7. Open AeThex AI: Navigate to http://localhost:8080

---

KAEL - The AeThex AI Agent 🤖

KAEL is configured with the AeThex ecosystem context and operates as your trusted co-architect:

• Direct & Efficient - No corporate fluff, just results
• Systems Thinking - Considers second-order effects
• Technical Depth - Specific and actionable guidance
• Strategic Partner - A sparring partner for ideas

Default Prompt Suggestions

• Help me architect a new AeThex microservice
• Review code and suggest improvements
• Strategize on AeThex Foundation goals
• Debug issues step by step
• Explain concepts in systems thinking terms
• Plan features for AeThex Connect

---

Project Structure

aethex-ai/
├── backend/           # Python FastAPI backend (Open WebUI)
├── src/               # SvelteKit frontend
├── static/            # Static assets (favicon, CSS)
├── scripts/           # Utility scripts
│   └── init_kael.py   # KAEL initialization script
├── aethex-models/     # Model configurations
│   └── kael.json      # KAEL model import file
├── .env               # Environment configuration
└── README.md          # This file

---

Configuration

Key environment variables in .env:

Variable	Default	Description
WEBUI_NAME	AeThex AI	Application name
OLLAMA_BASE_URL	http://localhost:11434	Ollama API endpoint
DEFAULT_MODELS	kael	Default model for new chats
DEFAULT_USER_ROLE	user	Role for new signups

---

AeThex Ecosystem

AeThex operates through a Trinity structure:

• AeThex Foundation - Nonprofit, mission-driven
• AeThex Corporation - Commercial operations
• AeThex Labs - Research & Development

Key Projects

• AeThex Connect - Social/community platform
• AeThex Engine Core - Godot-based game engine
• GameForge - Game development tools
• AeThexOS - Custom operating system
• AeThex Passport - Identity system

---

Based on Open WebUI

open-webui serve

This will start the Open WebUI server, which you can access at http://localhost:8080

Quick Start with Docker 🐳

Note

Please note that for certain Docker environments, additional configurations might be needed. If you encounter any connection issues, our detailed guide on Open WebUI Documentation is ready to assist you.

Warning

When using Docker to install Open WebUI, make sure to include the -v open-webui:/app/backend/data in your Docker command. This step is crucial as it ensures your database is properly mounted and prevents any loss of data.

Tip

If you wish to utilize Open WebUI with Ollama included or CUDA acceleration, we recommend utilizing our official images tagged with either :cuda or :ollama. To enable CUDA, you must install the Nvidia CUDA container toolkit on your Linux/WSL system.

Installation with Default Configuration

• If Ollama is on your computer, use this command:

  docker run -d -p 3000:8080 --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main
  

• If Ollama is on a Different Server, use this command:

  To connect to Ollama on another server, change the OLLAMA_BASE_URL to the server's URL:

  docker run -d -p 3000:8080 -e OLLAMA_BASE_URL=https://example.com -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main
  

• To run Open WebUI with Nvidia GPU support, use this command:

  docker run -d -p 3000:8080 --gpus all --add-host=host.docker.internal:host-gateway -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:cuda
  

Installation for OpenAI API Usage Only

• If you're only using OpenAI API, use this command:

  docker run -d -p 3000:8080 -e OPENAI_API_KEY=your_secret_key -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:main
  

Installing Open WebUI with Bundled Ollama Support

This installation method uses a single container image that bundles Open WebUI with Ollama, allowing for a streamlined setup via a single command. Choose the appropriate command based on your hardware setup:

• With GPU Support: Utilize GPU resources by running the following command:

  docker run -d -p 3000:8080 --gpus=all -v ollama:/root/.ollama -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:ollama
  

• For CPU Only: If you're not using a GPU, use this command instead:

  docker run -d -p 3000:8080 -v ollama:/root/.ollama -v open-webui:/app/backend/data --name open-webui --restart always ghcr.io/open-webui/open-webui:ollama
  

Both commands facilitate a built-in, hassle-free installation of both Open WebUI and Ollama, ensuring that you can get everything up and running swiftly.

After installation, you can access Open WebUI at http://localhost:3000. Enjoy! 😄

Other Installation Methods

We offer various installation alternatives, including non-Docker native installation methods, Docker Compose, Kustomize, and Helm. Visit our Open WebUI Documentation or join our Discord community for comprehensive guidance.

Look at the Local Development Guide for instructions on setting up a local development environment.

Troubleshooting

Encountering connection issues? Our Open WebUI Documentation has got you covered. For further assistance and to join our vibrant community, visit the Open WebUI Discord.

Open WebUI: Server Connection Error

If you're experiencing connection issues, it’s often due to the WebUI docker container not being able to reach the Ollama server at 127.0.0.1:11434 (host.docker.internal:11434) inside the container . Use the --network=host flag in your docker command to resolve this. Note that the port changes from 3000 to 8080, resulting in the link: http://localhost:8080.

Example Docker Command:

docker run -d --network=host -v open-webui:/app/backend/data -e OLLAMA_BASE_URL=http://127.0.0.1:11434 --name open-webui --restart always ghcr.io/open-webui/open-webui:main

Keeping Your Docker Installation Up-to-Date

Check our Updating Guide available in our Open WebUI Documentation.

Using the Dev Branch 🌙

Warning

The :dev branch contains the latest unstable features and changes. Use it at your own risk as it may have bugs or incomplete features.

If you want to try out the latest bleeding-edge features and are okay with occasional instability, you can use the :dev tag like this:

docker run -d -p 3000:8080 -v open-webui:/app/backend/data --name open-webui --add-host=host.docker.internal:host-gateway --restart always ghcr.io/open-webui/open-webui:dev

Offline Mode

If you are running Open WebUI in an offline environment, you can set the HF_HUB_OFFLINE environment variable to 1 to prevent attempts to download models from the internet.

export HF_HUB_OFFLINE=1

What's Next? 🌟

Discover upcoming features on our roadmap in the Open WebUI Documentation.

License 📜

This project contains code under multiple licenses. The current codebase includes components licensed under the Open WebUI License with an additional requirement to preserve the "Open WebUI" branding, as well as prior contributions under their respective original licenses. For a detailed record of license changes and the applicable terms for each section of the code, please refer to LICENSE_HISTORY. For complete and updated licensing details, please see the LICENSE and LICENSE_HISTORY files.

Support 💬

If you have any questions, suggestions, or need assistance, please open an issue or join our Open WebUI Discord community to connect with us! 🤝

Star History

---

Created by Timothy Jaeryang Baek - Let's make Open WebUI even more amazing together! 💪