README

Filament File Browser

File & Folders & Media Browser With Code Editor

Caution

This package gives access to files on your server. Use it for super-admins only, keep the developer gate on, and point basePath() at the smallest folder you need.

Screenshots

Version Compatibility

Plugin	Filament	Laravel	PHP
5.x	5.x	12.x / 13.x	8.2+
1.x / 2.x (v3 branch)	3.x	10.x / 11.x	8.1+

Installation

composer require tomatophp/filament-browser

after install your package please run this command

php artisan filament-browser:install

finally register the plugin on /app/Providers/Filament/AdminPanelProvider.php

use TomatoPHP\FilamentBrowser\FilamentBrowserPlugin;

->plugin(
    FilamentBrowserPlugin::make()
        ->basePath(storage_path('app/browser'))
        ->hiddenFolders([
            base_path('app'),
        ])
        ->hiddenFiles([
            base_path('composer.lock'),
        ])
        ->hiddenExtensions([
            'php',
        ])
        ->allowCreateFolder()
        ->allowCreateNewFile()
        ->allowUpload()
        ->allowEditFile()
        ->allowRenameFile()
        ->allowDeleteFile()
        ->allowPreview()
)

The page is available at /admin/browser (under the Settings navigation group).

Options

Method	Default	Description
`basePath(string $path)`	`config('filament-browser.start_path')` (`base_path()`)	Root folder. Every operation is confined to it.
`allowCreateNewFile(bool = true)`	`false`	Create code and markdown files.
`allowCreateFolder(bool = true)`	`false`	Create folders.
`allowUpload(bool = true)`	`false`	Upload files into the current folder.
`allowEditFile(bool = true)`	`false`	Save changes from the code / markdown editor (read-only otherwise).
`allowRenameFile(bool = true)`	`false`	Rename files.
`allowDeleteFile(bool = true)`	`false`	Delete files.
`allowPreview(bool = true)`	`true`	Preview images, video, audio, PDF and spreadsheets.
`hiddenFiles(array)` / `hiddenFolders(array)`	`[]`	Absolute paths that are not listed and cannot be opened.
`hiddenExtensions(array)`	`[]`	Extensions that are not listed, opened or created (e.g. `['php']`).
`hideEnvFiles(bool = true)`	`true`	`.env` and `.env.*` are hidden; call `hideEnvFiles(false)` to show them.
`developerGate(bool = true)`	`true`	Protect the page with filament-developer-gate.
`authorize(bool\|Closure)`	`true`	Who may open the page, e.g. `fn () => auth()->user()->hasRole('super_admin')`.

allowCode() and allowMarkdown() are kept for backward compatibility and have no effect.

Developer Gate

The browser asks for the developer password before it opens. The default password is password; change it in your .env:

DEVELOPER_GATE_PASSWORD=

Security

Every path sent from the browser is relative to basePath(), resolved with realpath() and refused when it leaves the root (.., absolute paths, symlinks pointing outside), or when it is hidden.
.env files are hidden by default, and hidden files, folders and extensions can not be opened, created or renamed to.
Nothing can be written unless you enable the matching allow*() option, and the checks run again on the server when the action runs.
Previews are embedded in the page; files are never copied to public storage.
The developer gate is checked on every Livewire request, not only on the page route.
Do not point basePath() at a folder served by your web server (such as public/) while allowCreateNewFile() or allowUpload() is enabled, or hide the php extension.

Publish Assets

you can publish config file by use this command

php artisan vendor:publish --tag="filament-browser-config"

you can publish views file by use this command

php artisan vendor:publish --tag="filament-browser-views"

you can publish languages file by use this command

php artisan vendor:publish --tag="filament-browser-lang"

Testing

composer test

Other Filament Packages

Checkout our Awesome TomatoPHP

tomatophp / filament-browser

Package info

Security

Fund package maintenance!

Statistics

README

Filament File Browser

Screenshots

Version Compatibility

Installation

Options

Developer Gate

Security

Publish Assets

Testing

Other Filament Packages