PHPackages                             filaforge/filament-opensource-chat - PHPackages - PHPackages  [Skip to content](#main-content)[PHPackages](/)[Directory](/)[Categories](/categories)[Trending](/trending)[Leaderboard](/leaderboard)[Changelog](/changelog)[Analyze](/analyze)[Collections](/collections)[Log in](/login)[Sign up](/register)

1. [Directory](/)
2. /
3. [Utility & Helpers](/categories/utility)
4. /
5. filaforge/filament-opensource-chat

ActiveLibrary[Utility & Helpers](/categories/utility)

filaforge/filament-opensource-chat
==================================

Open Source Chat management plugin for FilamentPHP with model profiles, user settings, and conversations CRUD pages.

v1.0.0(9mo ago)01MITPHPPHP ^8.1

Since Aug 19Pushed 9mo agoCompare

[ Source](https://github.com/filaforge/filament-opensource-chat)[ Packagist](https://packagist.org/packages/filaforge/filament-opensource-chat)[ Docs](https://github.com/filaforge/opensource-chat)[ RSS](/packages/filaforge-filament-opensource-chat/feed)WikiDiscussions master Synced 1mo ago

READMEChangelogDependencies (3)Versions (5)Used By (0)

Filaforge Opensource Chat
=========================

[](#filaforge-opensource-chat)

A powerful Filament plugin that integrates various open-source AI chat capabilities directly into your admin panel.

Features
--------

[](#features)

- **Multi-Model Support**: Chat with various open-source AI models
- **Conversation Management**: Save, organize, and continue chat conversations
- **Model Selection**: Choose from available open-source AI models
- **Customizable Settings**: Configure API endpoints, models, and chat parameters
- **Real-time Chat**: Live chat experience with streaming responses
- **Conversation History**: Keep track of all your AI conversations
- **Export Conversations**: Save and share chat transcripts
- **Role-based Access**: Configurable user permissions and access control
- **Context Awareness**: Maintain conversation context across sessions
- **Local Deployment**: Support for self-hosted AI models

Installation
------------

[](#installation)

### 1. Install via Composer

[](#1-install-via-composer)

```
composer require filaforge/opensource-chat
```

### 2. Publish & Migrate

[](#2-publish--migrate)

```
# Publish provider groups (config, views, migrations)
php artisan vendor:publish --provider="Filaforge\\OpensourceChat\\Providers\\OpensourceChatServiceProvider"

# Run migrations
php artisan migrate
```

### 3. Register Plugin

[](#3-register-plugin)

Add the plugin to your Filament panel provider:

```
use Filament\Panel;

public function panel(Panel $panel): Panel
{
    return $panel
        // ... other configuration
        ->plugin(\Filaforge\OpensourceChat\OpensourceChatPlugin::make());
}
```

Setup
-----

[](#setup)

### Configuration

[](#configuration)

The plugin will automatically:

- Publish configuration files to `config/opensource-chat.php`
- Publish view files to `resources/views/vendor/opensource-chat/`
- Publish migration files to `database/migrations/`
- Register necessary routes and middleware

### Open Source AI Configuration

[](#open-source-ai-configuration)

Configure your open-source AI endpoints in the published config file:

```
// config/opensource-chat.php
return [
    'default_provider' => env('OS_CHAT_PROVIDER', 'local'),
    'providers' => [
        'local' => [
            'base_url' => env('OS_CHAT_LOCAL_URL', 'http://localhost:8000'),
            'api_key' => env('OS_CHAT_LOCAL_KEY', ''),
            'model' => env('OS_CHAT_LOCAL_MODEL', 'llama3'),
        ],
        'fireworks' => [
            'base_url' => env('OS_CHAT_FIREWORKS_URL', 'https://api.fireworks.ai'),
            'api_key' => env('OS_CHAT_FIREWORKS_KEY', ''),
            'model' => env('OS_CHAT_FIREWORKS_MODEL', 'llama-v2-7b-chat'),
        ],
        'together' => [
            'base_url' => env('OS_CHAT_TOGETHER_URL', 'https://api.together.xyz'),
            'api_key' => env('OS_CHAT_TOGETHER_KEY', ''),
            'model' => env('OS_CHAT_TOGETHER_MODEL', 'meta-llama/Llama-2-7b-chat-hf'),
        ],
    ],
    'max_tokens' => env('OS_CHAT_MAX_TOKENS', 4096),
    'temperature' => env('OS_CHAT_TEMPERATURE', 0.7),
    'stream' => env('OS_CHAT_STREAM', true),
    'timeout' => env('OS_CHAT_TIMEOUT', 60),
];
```

### Environment Variables

[](#environment-variables)

Add these to your `.env` file:

```
OS_CHAT_PROVIDER=local
OS_CHAT_LOCAL_URL=http://localhost:8000
OS_CHAT_LOCAL_KEY=your_local_api_key_here
OS_CHAT_LOCAL_MODEL=llama3
OS_CHAT_FIREWORKS_URL=https://api.fireworks.ai
OS_CHAT_FIREWORKS_KEY=your_fireworks_api_key_here
OS_CHAT_FIREWORKS_MODEL=llama-v2-7b-chat
OS_CHAT_TOGETHER_URL=https://api.together.xyz
OS_CHAT_TOGETHER_KEY=your_together_api_key_here
OS_CHAT_TOGETHER_MODEL=meta-llama/Llama-2-7b-chat-hf
OS_CHAT_MAX_TOKENS=4096
OS_CHAT_TEMPERATURE=0.7
OS_CHAT_STREAM=true
OS_CHAT_TIMEOUT=60
```

### Getting API Keys

[](#getting-api-keys)

#### Fireworks AI

[](#fireworks-ai)

1. Visit [Fireworks AI](https://fireworks.ai/)
2. Create an account and navigate to API keys
3. Generate a new API key
4. Copy the key to your `.env` file

#### Together AI

[](#together-ai)

1. Visit [Together AI](https://together.ai/)
2. Sign up and go to API keys section
3. Create a new API key
4. Copy the key to your `.env` file

#### Local Models

[](#local-models)

For local deployment, you can use:

- **Ollama**: Local model serving
- **LM Studio**: Desktop AI model interface
- **Custom endpoints**: Your own AI model servers

Usage
-----

[](#usage)

### Accessing Opensource Chat

[](#accessing-opensource-chat)

1. Navigate to your Filament admin panel
2. Look for the "Opensource Chat" menu item
3. Start chatting with open-source AI models

### Starting a Conversation

[](#starting-a-conversation)

1. **Select Provider**: Choose from available AI providers
2. **Select Model**: Choose the specific AI model to use
3. **Type Your Message**: Enter your question or prompt
4. **Send Message**: Submit your message to the AI
5. **View Response**: See the AI's response in real-time
6. **Continue Chat**: Keep the conversation going

### Managing Conversations

[](#managing-conversations)

1. **New Chat**: Start a fresh conversation
2. **Save Chat**: Automatically save important conversations
3. **Load Chat**: Resume previous conversations
4. **Export Chat**: Download conversation transcripts
5. **Delete Chat**: Remove unwanted conversations

### Advanced Features

[](#advanced-features)

- **Provider Switching**: Switch between different AI providers
- **Model Selection**: Choose from available models per provider
- **Parameter Tuning**: Adjust temperature, max tokens, and other settings
- **Context Management**: Maintain conversation context across sessions
- **Streaming Responses**: Real-time AI responses for better user experience

Troubleshooting
---------------

[](#troubleshooting)

### Common Issues

[](#common-issues)

- **API key errors**: Verify your API keys are correct and have sufficient credits
- **Connection failures**: Check if the AI service endpoints are accessible
- **Model not available**: Ensure the selected model is available in your plan
- **Rate limiting**: Check your API rate limits and usage

### Debug Steps

[](#debug-steps)

1. Check the plugin configuration:

```
php artisan config:show opensource-chat
```

2. Verify routes are registered:

```
php artisan route:list | grep opensource-chat
```

3. Test API connectivity:

```
# Test local endpoint
curl http://localhost:8000/health

# Test external endpoints
curl -H "Authorization: Bearer YOUR_API_KEY" https://api.fireworks.ai/v1/models
```

4. Check environment variables:

```
php artisan tinker
echo env('OS_CHAT_PROVIDER');
echo env('OS_CHAT_LOCAL_URL');
```

5. Clear caches:

```
php artisan optimize:clear
```

6. Check logs for errors:

```
tail -f storage/logs/laravel.log
```

### Provider-Specific Issues

[](#provider-specific-issues)

#### Local Models

[](#local-models-1)

- **Service not running**: Ensure your local AI service is started
- **Port conflicts**: Check if the required ports are available
- **Model not loaded**: Verify the model is properly loaded in your service

#### Fireworks AI

[](#fireworks-ai-1)

- **Authentication errors**: Check API key and permissions
- **Model availability**: Ensure the model is available in your plan
- **Rate limits**: Monitor your API usage and limits

#### Together AI

[](#together-ai-1)

- **API key issues**: Verify your Together AI API key
- **Model access**: Check if you have access to the selected model
- **Service status**: Check Together AI service status

Security Considerations
-----------------------

[](#security-considerations)

### Access Control

[](#access-control)

- **Role-based permissions**: Restrict access to authorized users only
- **API key security**: Never expose API keys in client-side code
- **User isolation**: Ensure users can only access their own conversations
- **Audit logging**: Track all chat activities and API usage

### Best Practices

[](#best-practices)

- Use environment variables for API keys
- Implement proper user authentication
- Monitor API usage and costs
- Regularly rotate API keys
- Set appropriate rate limits
- Use HTTPS for external API calls

Performance Optimization
------------------------

[](#performance-optimization)

### Local Deployment

[](#local-deployment)

- **Resource allocation**: Ensure sufficient RAM and CPU for models
- **Model optimization**: Use quantized models for better performance
- **Caching**: Implement response caching for common queries
- **Load balancing**: Use multiple model instances if needed

### External APIs

[](#external-apis)

- **Connection pooling**: Reuse HTTP connections when possible
- **Request batching**: Batch multiple requests when feasible
- **Response caching**: Cache responses to reduce API calls
- **Fallback strategies**: Implement fallback to local models

Uninstall
---------

[](#uninstall)

### 1. Remove Plugin Registration

[](#1-remove-plugin-registration)

Remove the plugin from your panel provider:

```
// remove ->plugin(\Filaforge\OpensourceChat\OpensourceChatPlugin::make())
```

### 2. Roll Back Migrations (Optional)

[](#2-roll-back-migrations-optional)

```
php artisan migrate:rollback
# or roll back specific published files if needed
```

### 3. Remove Published Assets (Optional)

[](#3-remove-published-assets-optional)

```
rm -f config/opensource-chat.php
rm -rf resources/views/vendor/opensource-chat
```

### 4. Remove Package and Clear Caches

[](#4-remove-package-and-clear-caches)

```
composer remove filaforge/opensource-chat
php artisan optimize:clear
```

### 5. Clean Up Environment Variables

[](#5-clean-up-environment-variables)

Remove these from your `.env` file:

```
OS_CHAT_PROVIDER=local
OS_CHAT_LOCAL_URL=http://localhost:8000
OS_CHAT_LOCAL_KEY=your_local_api_key_here
OS_CHAT_LOCAL_MODEL=llama3
OS_CHAT_FIREWORKS_URL=https://api.fireworks.ai
OS_CHAT_FIREWORKS_KEY=your_fireworks_api_key_here
OS_CHAT_FIREWORKS_MODEL=llama-v2-7b-chat
OS_CHAT_TOGETHER_URL=https://api.together.xyz
OS_CHAT_TOGETHER_KEY=your_together_api_key_here
OS_CHAT_TOGETHER_MODEL=meta-llama/Llama-2-7b-chat-hf
OS_CHAT_MAX_TOKENS=4096
OS_CHAT_TEMPERATURE=0.7
OS_CHAT_STREAM=true
OS_CHAT_TIMEOUT=60
```

Support
-------

[](#support)

- **Documentation**: [GitHub Repository](https://github.com/filaforge/opensource-chat)
- **Issues**: [GitHub Issues](https://github.com/filaforge/opensource-chat/issues)
- **Discussions**: [GitHub Discussions](https://github.com/filaforge/opensource-chat/discussions)

Contributing
------------

[](#contributing)

We welcome contributions! Please see our [Contributing Guide](CONTRIBUTING.md) for details.

License
-------

[](#license)

This plugin is open-sourced software licensed under the [MIT license](LICENSE).

---

**Made with ❤️ by the Filaforge Team**

###  Health Score

30

—

LowBetter than 64% of packages

Maintenance58

Moderate activity, may be stable

Popularity1

Limited adoption so far

Community6

Small or concentrated contributor base

Maturity47

Maturing project, gaining track record

 Bus Factor1

Top contributor holds 100% of commits — single point of failure

How is this calculated?**Maintenance (25%)** — Last commit recency, latest release date, and issue-to-star ratio. Uses a 2-year decay window.

**Popularity (30%)** — Total and monthly downloads, GitHub stars, and forks. Logarithmic scaling prevents top-heavy scores.

**Community (15%)** — Contributors, dependents, forks, watchers, and maintainers. Measures real ecosystem engagement.

**Maturity (30%)** — Project age, version count, PHP version support, and release stability.

###  Release Activity

Cadence

Every ~0 days

Total

3

Last Release

272d ago

Major Versions

0.1.2 → v1.0.02025-08-19

### Community

Maintainers

![](https://www.gravatar.com/avatar/e7ccd0e302c517e0c6bc2b4ef05008e5beb1621bf5a64b17b82cdceb19566389?d=identicon)[filaforge](/maintainers/filaforge)

---

Top Contributors

[![blhk0532](https://avatars.githubusercontent.com/u/221689993?v=4)](https://github.com/blhk0532 "blhk0532 (5 commits)")

---

Tags

laravelaichatfilamentllmopensource

### Embed Badge

![Health badge](/badges/filaforge-filament-opensource-chat/health.svg)

```
[![Health](https://phpackages.com/badges/filaforge-filament-opensource-chat/health.svg)](https://phpackages.com/packages/filaforge-filament-opensource-chat)
```

###  Alternatives

[pboivin/filament-peek

Full-screen page preview modal for Filament

253319.6k12](/packages/pboivin-filament-peek)[bezhansalleh/filament-google-analytics

Google Analytics integration for FilamentPHP

205144.8k5](/packages/bezhansalleh-filament-google-analytics)[dotswan/filament-map-picker

Easily pick and retrieve geo-coordinates using a map-based interface in your Filament applications.

124139.3k2](/packages/dotswan-filament-map-picker)[jibaymcs/filament-tour

Bring the power of DriverJs to your Filament panels and start a tour !

12247.8k](/packages/jibaymcs-filament-tour)[aymanalhattami/filament-context-menu

context menu (right click menu) for filament

9838.0k](/packages/aymanalhattami-filament-context-menu)[tapp/filament-google-autocomplete-field

Filament plugin that provides a Google Autocomplete field

3098.1k](/packages/tapp-filament-google-autocomplete-field)

PHPackages © 2026

[Directory](/)[Categories](/categories)[Trending](/trending)[Changelog](/changelog)[Analyze](/analyze)