Skip to main content

​
Prerequisites

Before you begin, ensure you have:
  • Python 3.11 or higher
  • Docker and Docker Compose (for containerized deployment)
  • Access to required API keys (see Configuration section)

​
Local Development Setup

​
1. Clone the Repository

git clone https://github.com/praxos/hetairos.git
cd hetairos

​
2. Install Dependencies

pip install -r requirements.txt

​
3. Configure Environment Variables

Create a .env file in the root directory: 
# Core Configuration
ENVIRONMENT=development

# LLM Configuration (via Portkey)
PORTKEY_API_KEY=your_portkey_api_key
OPENAI_API_KEY=your_openai_api_key
GOOGLE_API_KEY=your_google_api_key

# Database
MONGODB_URI=mongodb://localhost:27017
DATABASE_NAME=hetairos

# Azure Services (if using)
AZURE_KEY_VAULT_URL=your_keyvault_url
AZURE_COSMOS_ENDPOINT=your_cosmos_endpoint
AZURE_SERVICE_BUS_NAMESPACE=your_service_bus

# Messaging Platform Tokens (configure as needed)
TELEGRAM_BOT_TOKEN=your_telegram_bot_token
DISCORD_BOT_TOKEN=your_discord_bot_token
SLACK_BOT_TOKEN=your_slack_bot_token
You don’t need to configure all integrations at once. Start with the platforms you plan to use.

​
4. Install Playwright Browsers

For the AI-powered web browsing feature: 
playwright install

​
5. Start the Server

python src/main.py
The API will be available at http://localhost:8000.

​
6. Start Background Workers

In a separate terminal: 
python run_workers_local.py

​
Using Praxos

​
Connect via Telegram

  1. Create a bot using @BotFather on Telegram
  2. Add your bot token to the .env file as TELEGRAM_BOT_TOKEN
  3. Start a conversation with your bot
  4. Send /start to initialize

​
Connect via Discord

  1. Create a Discord application at the Discord Developer Portal
  2. Create a bot and copy the token
  3. Add the token to your .env file as DISCORD_BOT_TOKEN
  4. Invite the bot to your server using OAuth2 URL generator
  5. Send messages to interact with Praxos

​
Connect via Slack

  1. Create a Slack app at api.slack.com
  2. Configure OAuth & Permissions with required scopes
  3. Install the app to your workspace
  4. Add the bot token to .env as SLACK_BOT_TOKEN
  5. Invite the bot to channels using /invite @YourBot

​
Next Steps

Architecture

Learn about Praxos’s architecture and design principles

Integrations

Explore available integrations and how to configure them

Tools & Capabilities

Discover what Praxos can do for you

Deployment

Deploy Praxos to production with Kubernetes

​
Troubleshooting

​
Server Won’t Start

  • Check that all required environment variables are set
  • Verify MongoDB is running and accessible
  • Check logs in the console for specific error messages

​
Integration Not Working

  • Verify API tokens are correctly configured
  • Check that webhooks are properly set up (for platforms that require them)
  • Review integration-specific documentation

​
Browser Tool Failing

  • Ensure Playwright browsers are installed: playwright install
  • Check available memory (browser automation requires ~200-500MB)
  • Verify the target website isn’t blocking automation
For additional help, check the troubleshooting guide or open an issue on GitHub.