README

A Laravel package that integrates Telegram backup functionality with FilamentPHP 3+. This package provides Filament resources for managing Telegram bots, chats, and backups, allowing you to automatically send Laravel backups to Telegram.

Demo

Installation

You can install the package via composer:

composer require lmkhang10/telegram-backup-filamentphp

You can publish and run the migrations with:

php artisan vendor:publish --tag="telegram-backup-filamentphp-migrations"
php artisan migrate

You can publish the config file with:

php artisan vendor:publish --tag="telegram-backup-filamentphp-config"

Environment Variables

Add the following environment variables to your .env file:

# Enable/disable automatic backup notifications to Telegram
TELEGRAM_BACKUP_ENABLED=true

# Chunk size for splitting large backup files (in MB, max 49)
# Default: 1 MB
BACKUP_TELEGRAM_CHUNK_SIZE=1

Important: You must configure Telegram bots and chats via the Filament admin panel. The package uses the database configuration exclusively - there are no environment variable fallbacks for bot tokens or chat IDs.

Usage

Register Resources in Your Filament Panel

In your Filament panel provider (e.g., app/Providers/Filament/AdminPanelProvider.php), add the Telegram resources:

use FieldTechVN\TelegramBackup\Filament\Resources\TelegramBotResource;
use FieldTechVN\TelegramBackup\Filament\Resources\TelegramChatResource;
use FieldTechVN\TelegramBackup\Filament\Resources\TelegramBackupResource;
use Filament\Navigation\NavigationBuilder;
use Filament\Navigation\NavigationGroup;
use Filament\Navigation\NavigationItem;

public function panel(Panel $panel): Panel
{
    return $panel
        // ... other configuration
        ->resources([
            TelegramBotResource::class,
            TelegramChatResource::class,
            TelegramBackupResource::class,
        ])
        ->navigation(function (NavigationBuilder $builder): NavigationBuilder {
            return $builder
                ->items([
                    // ... your other navigation items
                ])
                ->groups([
                    // Telegram group
                    NavigationGroup::make('TelegramGroup')
                        ->label(__('admin.nav.telegram.group'))
                        ->items([
                            NavigationItem::make('TelegramBotResource')
                                ->label(TelegramBotResource::getNavigationLabel())
                                ->icon(TelegramBotResource::getNavigationIcon())
                                ->url(fn(): string => TelegramBotResource::getUrl())
                                ->sort(1),

                            NavigationItem::make('TelegramChatResource')
                                ->label(TelegramChatResource::getNavigationLabel())
                                ->icon(TelegramChatResource::getNavigationIcon())
                                ->url(fn(): string => TelegramChatResource::getUrl())
                                ->sort(2),

                            NavigationItem::make('TelegramBackupResource')
                                ->label(TelegramBackupResource::getNavigationLabel())
                                ->icon(TelegramBackupResource::getNavigationIcon())
                                ->url(fn(): string => TelegramBackupResource::getUrl())
                                ->sort(3),
                        ]),
                ]);
        });
}

How to Add a Chat ID

To configure a Telegram group or channel for storing backups, follow these steps:

Add Bot Token First
- Go to the Telegram Bots list page in your Filament admin panel
- Create a new bot or edit an existing one
- Add your Telegram bot token (obtained from @BotFather on Telegram)
- Save the bot
Add Bot to Group/Channel
- In Telegram, add the bot to the group or channel you want to use for cloud storage
- Set the bot as an Administrator with the following permissions:
  - ✅ Manage Messages - Enable this (required)
  - ❌ Change Channel Info - Disable
  - ❌ Manage Stories - Disable
  - ❌ Manage Direct Messages - Disable
  - ❌ Add Subscribers - Disable
  - ❌ Manage Video Chats - Disable
  - ❌ Add New Admins - Disable
Note: Only "Manage Messages" permission is required. All other permissions should be disabled for security.
Start Long Polling
- Go back to the Telegram Bots list page in Filament
- Find your bot and click the "Start Long Polling" button
- This will enable the bot to listen for messages and commands
Run Setup Command
- In Telegram, go to the group/channel where you added the bot
- Type the command: /setup
- The bot will automatically:
  - Detect the chat information
  - Create or update the chat in the database
  - Link the chat to your bot
  - Send a confirmation message
Done!
- The chat is now configured and ready to receive backups
- You can verify the chat was added by checking the Telegram Chats list in Filament

Features

Telegram Bot Management: Create and manage Telegram bots for sending backups
Chat Management: Manage Telegram chats/channels where backups are sent
Backup Tracking: View and manage backups sent to Telegram
Automatic Backup Sending: Integrates with Spatie Laravel Backup to automatically send backups to Telegram
Large File Splitting: Automatically splits large backup files to comply with Telegram's file size limits

Testing

composer test

Changelog

Please see CHANGELOG for more information on what has changed recently.

Contributing

Please see CONTRIBUTING for details.

Security Vulnerabilities

Please review our security policy on how to report security vulnerabilities.

Credits

License

The MIT License (MIT). Please see License File for more information.

lmkhang10 / telegram-backup-filamentphp

Maintainers

Details