Skip to content
Merged
Show file tree
Hide file tree
Changes from 10 commits
Commits
Show all changes
20 commits
Select commit Hold shift + click to select a range
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
79 changes: 79 additions & 0 deletions pastefox-share/README.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,79 @@
# PasteFox Share

A plugin for [Pelican Panel](https://pelican.dev) to share console logs via [pastefox.com](https://pastefox.com) with one click.

## Features

- One-click log sharing from server console
- Optional API key for extended features (without API key, pastes expire after 7 days)
- Configurable visibility (PUBLIC/PRIVATE - requires API key)
- Visual effects (Matrix, Confetti, Glitch, etc.)
- Theme selection (Light/Dark)
- Password protection support
- Fetches up to 5000 log lines
- Admin settings page in sidebar

## Installation

1. Download the latest release ZIP file from the [Releases](https://github.com/FlexKleks/PelicanPlugins/releases) page
2. Go to your Pelican Panel admin area
3. Navigate to **Admin → Plugins**
4. Click **"Import file"**
5. Select the downloaded ZIP file
6. Click **"Import"**
Comment thread
FlexKleks marked this conversation as resolved.
Outdated

### Clear Cache

```bash
php artisan optimize:clear
```
Comment thread
FlexKleks marked this conversation as resolved.
Outdated

## Configuration

1. Go to **Admin → Advanced → PasteFox**
2. Configure the following settings:

| Setting | Description |
|---------|-------------|
| API Key | Optional - Get from https://pastefox.com/dashboard |
Comment thread
FlexKleks marked this conversation as resolved.
Outdated
| Visibility | PUBLIC or PRIVATE (requires API key) |
| Effect | Visual effect for the paste |
| Theme | Light or Dark theme |
| Password | Optional password protection |

### Without API Key
- Pastes expire after 7 days
- Always public visibility
- Basic features only

### With API Key
- No expiration limit
- Private pastes available
- Password protection
- Paste linked to your account

## Usage

1. Open a server console
2. Click the **"Share Logs"** button in the header
3. Copy the generated link from the notification

## Coming Soon

- File sharing
- Custom domains
- Folders
- Syntax highlighting themes

## Author

Created by [FlexKleks](https://github.com/FlexKleks)

## Support

- [GitHub Issues](https://github.com/FlexKleks/PelicanPlugins/issues)
Comment thread
FlexKleks marked this conversation as resolved.
Outdated
- [Pelican Discord](https://discord.gg/pelican-panel)

## License

MIT
Comment thread
FlexKleks marked this conversation as resolved.
Outdated
9 changes: 9 additions & 0 deletions pastefox-share/config/pastefox-share.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,9 @@
<?php

return [
'api_key' => env('PASTEFOX_API_KEY'),
'visibility' => env('PASTEFOX_VISIBILITY', 'PUBLIC'),
'effect' => env('PASTEFOX_EFFECT', 'NONE'),
'theme' => env('PASTEFOX_THEME', 'dark'),
'password' => env('PASTEFOX_PASSWORD'),
];
11 changes: 11 additions & 0 deletions pastefox-share/lang/en/messages.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,11 @@
<?php

return [
'share_logs' => 'Share Logs',
'share_file' => 'Share',
Comment thread
FlexKleks marked this conversation as resolved.
'uploaded' => 'Logs uploaded to PasteFox',
'file_uploaded' => 'File uploaded to PasteFox',
'upload_failed' => 'Upload failed',
'api_key_missing' => 'PasteFox API key not configured. Add PASTEFOX_API_KEY to your .env file.',
Comment thread
FlexKleks marked this conversation as resolved.
Outdated
'expires_7_days' => '⚠️ Without API key, paste expires in 7 days',
];
15 changes: 15 additions & 0 deletions pastefox-share/plugin.json
Original file line number Diff line number Diff line change
@@ -0,0 +1,15 @@
{
"id": "pastefox-share",
"name": "PasteFox Share",
"author": "FlexKleks",
"version": "1.0.0",
"description": "Share console logs via pastefox.com",
"category": "plugin",
"url": "https://github.com/FlexKleks/PelicanPlugins",
Comment thread
FlexKleks marked this conversation as resolved.
Outdated
"update_url": null,
"namespace": "FlexKleks\\PasteFoxShare",
"class": "PasteFoxSharePlugin",
"panels": ["admin", "server"],
"panel_version": null,
"composer_packages": null
}
154 changes: 154 additions & 0 deletions pastefox-share/src/Filament/Admin/Pages/PasteFoxSettings.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,154 @@
<?php
Comment thread
FlexKleks marked this conversation as resolved.
Outdated

namespace FlexKleks\PasteFoxShare\Filament\Admin\Pages;

use App\Traits\EnvironmentWriterTrait;
Comment thread
FlexKleks marked this conversation as resolved.
Outdated
use Filament\Actions\Action;
use Filament\Forms\Components\Select;
use Filament\Forms\Components\TextInput;
use Filament\Forms\Concerns\InteractsWithForms;
use Filament\Notifications\Notification;
use Filament\Pages\Concerns\InteractsWithFormActions;
use Filament\Pages\Page;
use Filament\Schemas\Components\Component;
use Filament\Schemas\Components\Section;
use Filament\Schemas\Schema;

/**
* @property Schema $form
*/
class PasteFoxSettings extends Page
{
use EnvironmentWriterTrait;
use InteractsWithFormActions;
use InteractsWithForms;

protected static string|\BackedEnum|null $navigationIcon = 'tabler-share';

protected string $view = 'filament.server.pages.server-form-page';

/** @var array<mixed>|null */
public ?array $data = [];

public function getTitle(): string
{
return 'PasteFox Settings';
}

public static function getNavigationLabel(): string
{
return 'PasteFox';
}

public static function getNavigationGroup(): ?string
{
return trans('admin/dashboard.advanced');
}

public function mount(): void
{
$this->form->fill([
'api_key' => config('pastefox-share.api_key'),
'visibility' => config('pastefox-share.visibility', 'PUBLIC'),
'effect' => config('pastefox-share.effect', 'NONE'),
'password' => config('pastefox-share.password'),
'theme' => config('pastefox-share.theme', 'dark'),
]);
}

/**
* @return Component[]
*/
public function getFormSchema(): array
{
return [
Section::make('API Configuration')
->description('Without API key, pastes expire after 7 days and are always public.')
->schema([
TextInput::make('api_key')
->label('API Key')
->password()
->revealable()
->helperText('Optional - Get your API key from https://pastefox.com/dashboard'),
]),

Section::make('Paste Settings')
->schema([
Select::make('visibility')
->label('Visibility')
->options([
'PUBLIC' => 'Public',
'PRIVATE' => 'Private (requires API key)',
])
->default('PUBLIC')
->helperText('Private pastes require an API key'),

Select::make('effect')
->label('Visual Effect')
->options([
'NONE' => 'None',
'MATRIX' => 'Matrix Rain',
'GLITCH' => 'Glitch',
'CONFETTI' => 'Confetti',
'SCRATCH' => 'Scratch Card',
'PUZZLE' => 'Puzzle Reveal',
'SLOTS' => 'Slot Machine',
'SHAKE' => 'Shake',
'FIREWORKS' => 'Fireworks',
'TYPEWRITER' => 'Typewriter',
'BLUR' => 'Blur Reveal',
])
->default('NONE'),

Select::make('theme')
->label('Theme')
->options([
'dark' => 'Dark',
'light' => 'Light',
])
->default('dark'),

TextInput::make('password')
->label('Password Protection')
->password()
->revealable()
->minLength(4)
->maxLength(100)
->helperText('Optional - 4-100 characters'),
]),
];
}
Comment thread
FlexKleks marked this conversation as resolved.
Outdated

protected function getFormStatePath(): ?string
{
return 'data';
}

protected function getHeaderActions(): array
{
return [
Action::make('save')
->label(trans('filament-panels::resources/pages/edit-record.form.actions.save.label'))
->action('save')
->keyBindings(['mod+s']),
];
}

public function save(): void
{
$data = $this->form->getState();

$this->writeToEnvironment([
'PASTEFOX_API_KEY' => $data['api_key'] ?? '',
'PASTEFOX_VISIBILITY' => $data['visibility'] ?? 'PUBLIC',
'PASTEFOX_EFFECT' => $data['effect'] ?? 'NONE',
'PASTEFOX_THEME' => $data['theme'] ?? 'dark',
'PASTEFOX_PASSWORD' => $data['password'] ?? '',
]);

Notification::make()
->title('Settings saved')
->success()
->send();
}
Comment thread
FlexKleks marked this conversation as resolved.
Outdated
}
122 changes: 122 additions & 0 deletions pastefox-share/src/Filament/Components/Actions/UploadLogsAction.php
Original file line number Diff line number Diff line change
@@ -0,0 +1,122 @@
<?php

namespace FlexKleks\PasteFoxShare\Filament\Components\Actions;

use App\Models\Server;
use Exception;
use Filament\Actions\Action;
use Filament\Facades\Filament;
use Filament\Notifications\Notification;
use Filament\Support\Enums\Size;
use Illuminate\Support\Facades\Http;

class UploadLogsAction extends Action
{
public static function getDefaultName(): ?string
{
return 'upload_logs_pastefox';
}

protected function setUp(): void
{
parent::setUp();

$this->hidden(function () {
/** @var Server $server */
$server = Filament::getTenant();

return $server->retrieveStatus()->isOffline();
});

$this->label(fn () => trans('pastefox-share::messages.share_logs'));

$this->icon('tabler-share');

$this->color('primary');

$this->size(Size::ExtraLarge);

$this->action(function () {
/** @var Server $server */
$server = Filament::getTenant();

try {
$logs = Http::daemon($server->node)
->get("/api/servers/{$server->uuid}/logs", [
'size' => 5000,
])
->throw()
->json('data');

$logs = is_array($logs) ? implode(PHP_EOL, $logs) : $logs;

$apiKey = config('pastefox-share.api_key');
$hasApiKey = !empty($apiKey);

// Build request payload
$payload = [
'content' => $logs,
'title' => 'Console Logs: '.$server->name.' - '.now()->format('Y-m-d H:i:s'),
'language' => 'log',
'effect' => config('pastefox-share.effect', 'NONE'),
'theme' => config('pastefox-share.theme', 'dark'),
];

// Only add these options if API key is present
if ($hasApiKey) {
$payload['visibility'] = config('pastefox-share.visibility', 'PUBLIC');

$password = config('pastefox-share.password');
if (!empty($password)) {
$payload['password'] = $password;
}
}

// Build HTTP request
$request = Http::withHeaders(['Content-Type' => 'application/json'])
->timeout(30)
->connectTimeout(5);

// Add API key header if available
if ($hasApiKey) {
$request = $request->withHeaders(['X-API-Key' => $apiKey]);
}

$response = $request
->throw()
->post('https://pastefox.com/api/pastes', $payload)
->json();
Comment thread
FlexKleks marked this conversation as resolved.
Outdated

if ($response['success']) {
$url = 'https://pastefox.com/'.$response['data']['slug'];

$body = $url;
if (!$hasApiKey) {
$body .= "\n".trans('pastefox-share::messages.expires_7_days');
}

Notification::make()
->title(trans('pastefox-share::messages.uploaded'))
->body($body)
->persistent()
->success()
->send();
} else {
Notification::make()
->title(trans('pastefox-share::messages.upload_failed'))
->body($response['error'] ?? 'Unknown error')
->danger()
->send();
}
Comment thread
FlexKleks marked this conversation as resolved.
} catch (Exception $exception) {
report($exception);

Notification::make()
->title(trans('pastefox-share::messages.upload_failed'))
->body($exception->getMessage())
->danger()
->send();
}
});
}
}
Comment thread
FlexKleks marked this conversation as resolved.
Loading