A self-hosted media server and file management system
Vue ffmpegfile-serverjellyfinlaravelmediamedia-playermedia-servermediabrowsermediaservermusicmusic-librarymusic-playermusicplayerself-hostedvuejs
<?php
use App\Http\Controllers\Api\V1\AnalyticsController;
use App\Http\Controllers\Api\V1\Auth\GuestTokenController;
use App\Http\Controllers\Api\V1\Auth\PasswordResetLinkController;
use App\Http\Controllers\Api\V1\AuthController;
use App\Http\Controllers\Api\V1\CategoryController;
use App\Http\Controllers\Api\V1\EmailController;
use App\Http\Controllers\Api\V1\ExternalMetadataController;
use App\Http\Controllers\Api\V1\Feed\ExploreController;
use App\Http\Controllers\Api\V1\FolderController;
use App\Http\Controllers\Api\V1\JobController;
use App\Http\Controllers\Api\V1\Media\MediaController;
use App\Http\Controllers\Api\V1\Metadata\FontController;
use App\Http\Controllers\Api\V1\Metadata\SeriesRelationsController;
use App\Http\Controllers\Api\V1\Metadata\StoryboardController;
use App\Http\Controllers\Api\V1\Metadata\SubtitleController;
use App\Http\Controllers\Api\V1\Metadata\TranscriptController;
use App\Http\Controllers\Api\V1\MetadataController;
use App\Http\Controllers\Api\V1\PasswordController;
use App\Http\Controllers\Api\V1\PlaybackController;
use App\Http\Controllers\Api\V1\PlaybackProgressController;
use App\Http\Controllers\Api\V1\ProfileController;
use App\Http\Controllers\Api\V1\RecordController;
use App\Http\Controllers\Api\V1\SeriesController;
use App\Http\Controllers\Api\V1\Server\DiskUsageController;
use App\Http\Controllers\Api\V1\Server\ServerConfigController;
use App\Http\Controllers\Api\V1\Server\SetupController;
use App\Http\Controllers\Api\V1\SessionController;
use App\Http\Controllers\Api\V1\SubTaskController;
use App\Http\Controllers\Api\V1\TagController;
use App\Http\Controllers\Api\V1\TaskController;
use App\Http\Controllers\Api\V1\UserController;
use App\Http\Controllers\Api\V1\VideoController;
use App\Http\Controllers\DirectoryController;
use App\Http\Controllers\Proxy\PlausibleProxyController;
use App\Support\AppManifest;
use Illuminate\Http\Request;
use Illuminate\Support\Facades\Route;
use Robertogallea\PulseApi\Http\Controllers\DashboardController;
//
// ─── Pulse API (Protected) ──────────────────────────────────────────────────
//
Route::prefix('pulse')->group(function () {
Route::get('/', [DashboardController::class, 'index'])->name('pulse.dashboard');
Route::get('/{type}', [DashboardController::class, 'show'])->name('pulse.resource');
})->middleware('auth');
//
// ─── Protected Routes ───────────────────────────────────────────────────────
//
Route::group(['middleware' => ['auth:sanctum']], function () {
// Auth
Route::get('/user', fn (Request $request) => $request->user());
Route::delete('/logout', [AuthController::class, 'destroy']);
// Settings
Route::prefix('settings')->group(function () {
// Account Settings
Route::get('/sessions', [SessionController::class, 'index'])->name('sessions.list');
Route::delete('/sessions', [SessionController::class, 'destroyOthers'])->name('sessions.destroyOthers');
Route::delete('/account', [ProfileController::class, 'destroy'])->name('account.destroy');
Route::put('/password', [PasswordController::class, 'update'])->name('password.update');
Route::put('/email', [EmailController::class, 'update'])->name('email.update');
});
Route::prefix('config')->group(function () {
// User Defined Settings
Route::get('/', [ServerConfigController::class, 'index']);
Route::patch('/scanner', [ServerConfigController::class, 'updateScanner']);
Route::patch('/storage', [ServerConfigController::class, 'updateStorage']);
Route::patch('/performance', [ServerConfigController::class, 'updatePerformance']);
Route::patch('/media', [ServerConfigController::class, 'updateMedia']);
});
// Dashboard
Route::get('/active-sessions', [UserController::class, 'sessionCount']);
// Media and Metadata
Route::resource('/metadata', MetadataController::class)->only(['show', 'store', 'update']);
Route::resource('/series', SeriesController::class)->only(['index', 'store', 'update']);
Route::resource('/tags', TagController::class)->only(['index', 'store']);
Route::prefix('/metadata/{metadata}')->group(function () {
// Lyrics
Route::patch('/lyrics', [MetadataController::class, 'updateLyrics']);
// Subtitles
Route::delete('/subtitles', [SubtitleController::class, 'reset']); // clear cache
// Fonts
Route::get('/fonts', [FontController::class, 'show']);
Route::post('/fonts', [FontController::class, 'regenerate']); // clear existing files and queue regenerate
// Storyboard
Route::get('/storyboard', [StoryboardController::class, 'show']);
Route::post('/storyboard', [StoryboardController::class, 'regenerate']); // clear existing files and queue regenerate
// Images
Route::patch('/images', [MetadataController::class, 'updateImages']);
// Transcript
Route::post('/transcript', [TranscriptController::class, 'regenerate']);
});
Route::prefix('/categories/{category}')->group(function () {
Route::patch('/default-folder', [CategoryController::class, 'setDefaultFolder']);
Route::patch('/settings', [CategoryController::class, 'updateSettings']);
});
Route::resource('/categories', CategoryController::class)->only(['index']);
Route::get('series/search', [SeriesController::class, 'search']);
Route::prefix('/series/{series}')->group(function () {
// Download Access Control
Route::put('/downloads', [SeriesController::class, 'updateDownloadSettings']);
// Images
Route::patch('/images', [SeriesController::class, 'updateImages']);
// Relations with other series(folders)
Route::get('/relations', [SeriesRelationsController::class, 'index']);
Route::put('/relations', [SeriesRelationsController::class, 'update']);
// Size History
Route::get('/size-history', [SeriesController::class, 'sizeHistory']);
});
// Users and Profiles
Route::get('/profiles/search/{username?}', [ProfileController::class, 'findUser']);
Route::resource('/users', UserController::class)->only(['index', 'destroy']);
Route::resource('/profiles', ProfileController::class)->only(['show', 'store', 'update']);
// Records and Views
Route::resource('/records', RecordController::class)->only(['index', 'store', 'destroy']);
Route::get('/user-view-count/{metadata}', [RecordController::class, 'userViewCount']);
// Server
Route::resource('/analytics', AnalyticsController::class)->only(['index']);
Route::prefix('sub-tasks')->middleware('can:admin')->group(function () {
Route::get('/{task}', [SubTaskController::class, 'show']);
Route::delete('/{subTask}', [SubTaskController::class, 'destroy']);
});
Route::prefix('server')->group(function () {
Route::get('/disk-usage', [DiskUsageController::class, 'index']);
});
Route::resource('/tasks', TaskController::class)->only(['index', 'destroy']);
Route::prefix('tasks')->group(function () {
Route::get('/stats', [TaskController::class, 'stats']);
Route::get('/wait-times', [TaskController::class, 'waitTimes']);
Route::post('/sync', [JobController::class, 'syncFiles']);
Route::post('/index/{category?}', [JobController::class, 'indexFiles']);
Route::post('/verify/{category?}', [JobController::class, 'verifyFiles']);
Route::post('/verify-folders/{category?}', [JobController::class, 'verifyFolders']);
Route::post('/scan/{category?}', [JobController::class, 'scanFiles']);
Route::post('/storyboards/{category}', [JobController::class, 'generateStoryboards']);
Route::post('/clean', [JobController::class, 'cleanPaths']); // OLD
Route::post('/cancel/{task}', [TaskController::class, 'cancel']);
});
});
//
// ─── Public Routes ──────────────────────────────────────────────────────────
//
// Auth
Route::get('/auth', [AuthController::class, 'authenticate']);
Route::post('/login', [AuthController::class, 'login']);
Route::post('/register', [AuthController::class, 'register'])->middleware('throttle:6,1')->name('register');
Route::post('/recovery', [PasswordResetLinkController::class, 'store'])->name('password.recovery');
Route::post('/reset-password/{token}', [PasswordController::class, 'store'])->name('password.reset');
Route::post('/guest-token', [GuestTokenController::class, 'issue'])->middleware('throttle:guest-token');
// App Info
Route::get('/manifest', fn () => response()->json(AppManifest::info()));
Route::get('/health', fn () => response()->json(['health' => 1]));
Route::get('/setup-status', [SetupController::class, 'setupStatus']);
// Analytics
Route::withoutMiddleware([
\Illuminate\Session\Middleware\StartSession::class,
\Illuminate\Cookie\Middleware\AddQueuedCookiesToResponse::class,
\Illuminate\Cookie\Middleware\EncryptCookies::class,
\Laravel\Sanctum\Http\Middleware\EnsureFrontendRequestsAreStateful::class,
])->group(function () {
Route::post('/event', [PlausibleProxyController::class, 'event'])->middleware('throttle:120,1')->name('analytics.event');
});
// Home
Route::prefix('/explore')->group(function () {
Route::get('continue-watching', [ExploreController::class, 'continueWatching']);
Route::get('recently-released', [ExploreController::class, 'recentlyReleased']);
Route::get('recently-updated', [ExploreController::class, 'recentlyUpdated']);
Route::get('recently-added', [ExploreController::class, 'recentlyAdded']);
Route::get('recently-uploaded', [ExploreController::class, 'recentlyUploaded']);
});
// Libraries (categories)
Route::resource('/categories', CategoryController::class)->only(['show']);
// Folder GET by Id or by Library Id
Route::resource('/folders', FolderController::class)->only(['show']);
Route::get('/folders', [FolderController::class, 'getFrom']);
// Video Search and Views
Route::patch('/videos/watch/{video}', [VideoController::class, 'watch']);
Route::get('/videos/{video}/info', [VideoController::class, 'getMediaInfo']);
Route::get('/videos', [VideoController::class, 'getFrom']);
// Video playback history
Route::resource('/playback', PlaybackController::class)->only(['show', 'store']);
// Media Specific
Route::prefix('/media/{video}')->group(function () {
// Downloads
Route::get('/download', [MediaController::class, 'download']);
});
// Public Metadata
Route::prefix('/metadata/{metadata}')->group(function () {
// Progress
Route::get('/progress', [PlaybackProgressController::class, 'show']);
Route::put('/progress', [PlaybackProgressController::class, 'upsert'])->middleware('throttle:playback-progress');
// Lyrics Service
Route::prefix('/lyrics')->middleware('throttle:lrclib')->group(function () {
Route::get('/import', [ExternalMetadataController::class, 'importLyrics']);
Route::get('/search', [ExternalMetadataController::class, 'searchLyrics']);
});
});
// Content
Route::get('/{dir}', [DirectoryController::class, 'showDirectoryAPI']);
Route::get('/{dir}/{folderName}', [DirectoryController::class, 'showDirectoryAPI']);