A self-hosted media server and file management system
Vue ffmpegfile-serverjellyfinlaravelmediamedia-playermedia-servermediabrowsermediaservermusicmusic-librarymusic-playermusicplayerself-hostedvuejs
readme
aminnausin6ca6966bae7d
diff --git a/README.md b/README.mdindex b6fbec9e..fd2cb4ff 100755--- a/README.md+++ b/README.md@@ -1,25 +1,28 @@-# Web based Media hosting website/server--Built with:--- Laravel-- Vue.js-- Tailwind-- Nginx-- Postgresql--Features to add:--- User profiles-- Uploadable images (With supabase or local storage based on admin preference)-- User access levels (Admin, Contributor, General)-- User friends system-- Synchronised playback with a user party system-- Automatic scrubbing of metadata with admin selected source API-- Category management-- Video playback statistics and heatmaps-- Video player UI-- Tags system+<h1 style="text-align:center; display: block;">MediaServer</h1>+<!-- <p style="text-align:center"> -->+ <!-- <br>+ <a href="http://www.amitmerchant.com/electron-markdownify"><img src="https://raw.githubusercontent.com/amitmerchant1990/electron-markdownify/master/app/img/markdownify.png" alt="Markdownify" width="200"></a>+ <br> -->+ <!-- # MediaServer -->+ <!-- <br> -->+<!-- </p> -->++#### <p style="text-align:center">A minimalist self-hosted Media Server built with <a href="https://laravel.com/" target="_blank">Laravel</a>. </p>++<p style="text-align:center">+ <img src="https://img.shields.io/badge/vue-v3.4.29-white" alt="Vue">+ <img src="https://img.shields.io/badge/laravel-v11.10-F9322C" alt="Laravel">+ <img src="https://img.shields.io/badge/lisense-AGPL%20V3-purple" alt="Lisense">+</p>++<p style="text-align:center">+ <a href="#key-features">Key Features</a> •+ <a href="#how-to-use">How To Use</a> •+ <a href="#demo">Demo</a> •+ <a href="#similar-projects">Similar Projects</a>+</p>++<!--  -->## Overview@@ -29,23 +32,125 @@ It automatically scans and indexes your videos and serves them in a minimalisticThe main benefit is that you host content yourself and thus control the speed at which videos can load. No more buffering !Extra features include watch history, ambient mode, editable video metadata and online file management.+### Built With++- Laravel <img src="https://github.com/marwin1991/profile-technology-icons/assets/25181517/afcf1c98-544e-41fb-bf44-edba5e62809a" width=14 height=14 alt="Laravel"/>+- Vue.js+- Tailwind <img src="https://user-images.githubusercontent.com/25181517/202896760-337261ed-ee92-4979-84c4-d4b829c7355d.png" width=14 height=14 alt="Tailwind"/>+- Nginx <img src="https://user-images.githubusercontent.com/25181517/183345125-9a7cd2e6-6ad6-436f-8490-44c903bef84c.png" width=14 height=14 alt="Nginx"/>+- Postgresql++### Designed With++- Figma+- DrawSQL+- [PinesUI](https://github.com/thedevdojo/pines)++#### Personally Hosted With++- Nixos+- Caddy+- Docker++## Features++### Key Features++- Quiet / Minimalist UI+- Ambient Video Player+ - Provides ambient backlight based on video content in darkmode+ - Can be disabled+- Video Playback Heatmap+ - Shows up after 5 seeks to any point in a video+ - Ranges from 1 to 25 at any 100th point in the video+ - Can be disabled+- Video and Folder Sharing+ - With video id or folder name in the URL+- Customisable Video Metadata+ - Description+ - Episode / Season number+ - Release Dates+ - Tags+- Customisable Folder Metadata+ - Thumbnail+ - Description+ - Release Dates+ - Tags+- Watch History Tracking+ - Can filter history by any video or folder attribute+- View Counts+- Persistent Metadata+ - Moved or reuploaded videos will be matched with pre-existing metadata+- Dark/Light mode++### Features to add++- Video player UI+- Video playback statistics+ - Most Played in the last X days+ - Your favourite video / folder / category+ - Avg time / count watched per day / week / month+- Category management+- Index process manager+- Timed video comments (like on soundcloud)+- Uploadable images (With supabase or local storage based on admin preference)+- User profiles+- User friends system+- Synchronised playback with a user party system+- User access levels (Admin, Contributor, General)+- Automatic scrubbing of metadata with admin selected source API++## How To Use+### Installation-Requires Apache or NGINX, PostgreSQL, A build of Vue and Tailwind with Node, FFmpeg and PHP 8. You can use Laragon to run in a single application.+To run this yourself, you require a webserver such as [Caddy](https://caddyserver.com/) or [NGINX](https://nginx.org/en/index.html), [PostgreSQL](https://www.postgresql.org/), A build of Vue and Tailwind with [Node](https://nodejs.org/en), [FFmpeg](https://www.ffmpeg.org/) and PHP 8. You can use [Laragon](https://laragon.org/) to run in a single application.++```bash+# Clone+git clone https://github.com/aminnausin/mediaServer.git++# Open+cd mediaServer++# Install dependencies+composer install++npm i++# Setup Laravel+php artisan key:generate++php artisan migrate-To connect to your file server, create a Symbolic link between your remote location and ./storage/app/public/media-To see any of your videos, you must INDEX FILES from the user dropdown menu or start the Laravel CRON job which scans-every 6 hours. Sync files will synchronise local cache json files with the database. The verify job will pull metadata+# Link storage folders+php artisan link++# Build the app+npm run build++# Run locally with Laravel+npm run vite:dev+```++### Operating Instructions++To connect to your file server, create a Symbolic link between your storage folder and ./storage/app/public/media.+To see any of your videos, you must `INDEX FILES` from the user dropdown menu or start the Laravel scheduler which scans+every 6 hours. `SYNC FILES` will synchronise local cache json files with the database. The `VERIFY FILES` job will pull metadatafrom the files using FFprobe.Different folders are accessed via url/folder/subfolder. Using just URL/folder will open the first subfolder scanned.-You can share direct links to both videos and folders with the share buttons in the UI. Access to any category requires-you to know its name by design.+You can share direct links to both videos and folders with the share buttons in the UI. Access to any category requires you to know its name by design.++#### Default File Types-Supported File Types:+- MP4+- MKV-- MP4-- MKV+> **Note**+> You can add more by changing the code inside `./app/jobs/VerifyFiles.php` under the `generateVideos` function.+> _Eventually_, I will make this dependant on values from the database which can be configured from a settings dashboard## Demo@@ -61,3 +166,13 @@ Below are screenshots of the current webpage on Desktop and Android.|  |  || :--------------------------------------------------------------------------------------: | :---------------------------------------------------------------------------------------: || Dark Mode on Desktop | Light Mode on Android |++## Activity++++## Similar Projects++Some similar projects that serve the same purpose but were not sources of inspiration for this project include:++- [Jellyfin](https://github.com/jellyfin/jellyfin)