trueselph/jivas repository overview

⁠Jivas

⁠Overview

This Docker image provides a ready-to-use installation of Jivas, an agentic framework for building, deploying, and managing intelligent agents. Built on top of Jaseci, JIVAS provides a modular architecture that allows developers to build, extend, and customize agents with ease. Its plug-and-play design via Action packages allows flexibility and scalability for various use cases.

⁠What's Included

• Jivas Core: The complete Jivas platform with all essential components
• Jivas Client: A lightweight client for interacting with your Jivas agents
• Jivas Studio: A web-based user interface for agent development and management
• File Server: Built-in file storage capabilities (configurable for local or S3)
• Automated Setup: Initializes the database, creates admin user, and sets up the environment

⁠Exposed Ports

• 8000: Main Jivas API service
• 8989: Jivas Studio web interface
• 9000: File server (when running in development mode)
• 8501: Jivas Client web interface

⁠Quick Start

docker run -p 8000:8000 -p 8989:8989 -p 9000:9000 -p 8501:8501\
  ghcr.io/trueselph/jivas:latest

Once running, you can access:

• Jivas API at http://localhost:8000⁠
• Jivas Studio at http://localhost:8989⁠
• Jivas Client at http://localhost:8501⁠
• File server at http://localhost:9000/files⁠ (in development mode)

Default login credentials:

• Email: [email protected]⁠
• Password: password

⁠Configuration

⁠Environment Variables

The image can be configured using the following environment variables:

⁠Custom Configuration Example

docker run -p 8000:8000 -p 8989:8989 -p 9000:9000 -p 8501:8501 \
  -e [email protected] \
  -e JIVAS_PASSWORD=strongpassword \
  -e JIVAS_ENVIRONMENT=development \
  ghcr.io/trueselph/jivas:latest

⁠Storage Options

⁠Local File Storage

By default, Jivas uses local file storage. Files are stored in the container's filesystem at the path specified by JIVAS_FILES_ROOT_PATH.

⁠S3 File Storage

For production deployments, you can configure Jivas to use S3-compatible storage:

docker run -p 8000:8000 -p 8989:8989 \
  -e JIVAS_FILE_INTERFACE=s3 \
  -e JIVAS_S3_BUCKET_NAME=my-jivas-bucket \
  -e JIVAS_S3_REGION_NAME=us-east-1 \
  -e JIVAS_S3_ACCESS_KEY_ID=your-access-key \
  -e JIVAS_S3_SECRET_ACCESS_KEY=your-secret-key \
  ghcr.io/trueselph/jivas:latest

⁠Persistent Data

For production use, consider mounting volumes for persistent data:

docker run -p 8000:8000 -p 8989:8989 -p 9000:9000 -p 8501:8501 \
  -v jivas-data:/app/.jvdata \
  -v jivas-files:/app/.files \
  ghcr.io/trueselph/jivas:latest

⁠Health Checks

The container automatically checks for service availability on port 8000 and initializes the necessary components once the service is running.

⁠Support and Documentation

For more information, visit the Jivas Documentation⁠ or GitHub Repository⁠.