Download the PHP package juhe-it-solutions/contao-openai-assistant without Composer

On this page you can find all versions of the php package juhe-it-solutions/contao-openai-assistant. It is possible to download/install these versions without Composer. Possible dependencies are resolved automatically.

FAQ

After the download, you have to make one include require_once('vendor/autoload.php');. After that you have to import the classes with use statements.

Example:
If you use only one package a project is not needed. But if you use more then one package, without a project it is not possible to import the classes with use statements.

In general, it is recommended to use always a project to download your libraries. In an application normally there is more than one library needed.
Some PHP packages are not free to download and because of that hosted in private repositories. In this case some credentials are needed to access such packages. Please use the auth.json textarea to insert credentials, if a package is coming from a private repository. You can look here for more information.

  • Some hosting areas are not accessible by a terminal or SSH. Then it is not possible to use Composer.
  • To use Composer is sometimes complicated. Especially for beginners.
  • Composer needs much resources. Sometimes they are not available on a simple webspace.
  • If you are using private repositories you don't need to share your credentials. You can set up everything on our site and then you provide a simple download link to your team member.
  • Simplify your Composer build process. Use our own command line tool to download the vendor folder as binary. This makes your build process faster and you don't need to expose your credentials for private repositories.
Please rate this library. Is it a good library?

Informations about the package contao-openai-assistant

Contao OpenAI Assistant Extension

Contao PHP Production Ready Packagist

About

juhe-it-solutions/contao-openai-assistant is a comprehensive OpenAI Assistant integration for Contao 5.3+ providing backend management and a modern frontend chatbot. Developed and maintained by JUHE IT-solutions, Austria.

This extension allows you to create, configure, and deploy AI assistants directly within your Contao CMS, with secure API key management, file uploads, and a customizable frontend chat widget.

🎉 A Quick Note from the Developer

Hey folks! 👋 This whole project is my first attempt at completely vibing with Contao extension development (crafted in countless nights fueled by coffee ☕ and determination 💪).

While I'm super proud of what we've built here, I gotta be honest - I don't have the bandwidth to actively maintain this project.

Feel free to:

No guarantees that everything will be addressed immediately, but I'll take a look when time allows! Since this is open source, feel free to fork and enhance it! 🎯

🚀 Features

Backend Management

Frontend Chatbot

Security & Performance

📋 Requirements

🚀 Quick Start

🛠️ Installation using Contao Manager

The extension can easily be installed using the Contao Manager. Just search for the extension with keywords 'openai', 'openai-assistant', 'chatbot',...

🛠️ Installation using composer

For detailed installation instructions, see docs/installation.md.

  1. Install the extension:

  2. Run migrations and clear cache:

  3. Configure in Contao backend:

    • Go to AI-TOOLS → OpenAI Dashboard
    • Create OpenAI configuration with your API key
    • Upload knowledge base files
    • Create your first assistant
  4. Add to frontend:
    • Create AI-Chatbot module in Layout → Modules
    • Add module to your page layout

📚 For detailed documentation, see the docs/ directory.

Manual Installation (Alternative)

If you prefer manual installation:

  1. Download the extension:

  2. Copy to your Contao installation:

  3. Add to composer.json (if not using Composer):

  4. Run migrations and clear cache:

🎯 How to Setup

Prerequisites

Before setting up the extension, you need:

  1. OpenAI Account: Create an account at platform.openai.com
  2. Create Project: e.g. Chatbot for website xyz
  3. API Key: Generate a secret key in your OpenAI project
  4. Assistants API Access: Ensure your account has access to the Assistants API
  5. Contao 5.3+: Ensure you're running Contao 5.3 or higher (recommended: Contao 5.5)

Step-by-Step Setup Guide

1. Backend Configuration

After installing the extension via Contao Manager, you will see a new entry in your Contao backend main menu: AI-TOOLS → OpenAI Dashboard. Click on this link to access the configuration area.

1a. Create OpenAI Configuration
1b. Upload Knowledge Base Files
1c. Create OpenAI Assistant

2. Frontend Module Configuration

2a. Create AI Chat Module
2b. Configure Chatbot Settings

3. Integration

3a. Page Layout Integration
3b. Content Element Integration (Alternative)

🔄 How It Works (Real-World Process)

Behind the Scenes

When you configure the extension in Contao, the following happens automatically on the OpenAI platform:

1. OpenAI Project Setup

2. Synchronization Process

3. File Management

4. Assistant Configuration

Important Notes

⚠️ One-Way Synchronization:

🔒 Security:

⚙️ Configuration

API Key Management

The extension supports multiple methods for storing OpenAI API keys:

📖 For detailed API key management, see docs/security/api-key-management.md

Color Customization

The extension supports full color customization for both light and dark themes:

🎨 Frontend Features

Chat Widget

The frontend chat widget provides:

Accessibility

🔧 API Endpoints

The extension provides several API endpoints:

🛡️ Security Features

🔐 API Key Security

The extension supports multiple levels of API key security:

  1. Environment Variables (Recommended) - Store keys in .env.local or system environment
  2. Encrypted Database Storage - Fallback with AES-256-CBC encryption
  3. Real-time Validation - API keys validated with OpenAI on save

📖 For detailed security documentation, see docs/security/api-key-management.md

🗄️ Database Tables

The extension creates three main database tables:

📚 Documentation

Comprehensive documentation is available in the docs/ directory:

🐛 Troubleshooting

For detailed troubleshooting information, see docs/development/troubleshooting.md.

Quick Fixes

  1. API Key Issues: Check OpenAI Setup Guide
  2. Model Problems: See Model Selection Guide
  3. Security Concerns: Review Security Documentation
  4. Frontend Issues: Check Frontend Guide

🤝 Contributing

We welcome contributions! Please see CONTRIBUTING.md for detailed guidelines.

Quick Start for Contributors

  1. Fork the repository
  2. Create a feature branch (git checkout -b feature/amazing-feature)
  3. Make your changes
  4. Add tests if applicable
  5. Commit your changes (git commit -m 'Add amazing feature')
  6. Push to the branch (git push origin feature/amazing-feature)
  7. Submit a pull request

Development Setup

For local development:

📄 License

This extension is licensed under the LGPL-3.0-or-later license. See LICENSE for details.

Security

If you discover a security vulnerability, please report it privately via email to [[email protected]]. Do not open public issues for security problems.

Maintainers

🙏 Acknowledgments


Note: This extension requires a valid OpenAI API key with Assistants API access. Please ensure you comply with OpenAI's terms of service and usage policies.


All versions of contao-openai-assistant with dependencies

PHP Build Version
Package Version
Requires php Version >=8.1
contao/core-bundle Version >=5.3
symfony/http-client Version ^6.0
Composer command for our command line client (download client) This client runs in each environment. You don't need a specific PHP version etc. The first 20 API calls are free. Standard composer command

The package juhe-it-solutions/contao-openai-assistant contains the following files

Loading the files please wait ....