Skip to content

A self-hosted media server and file management system

Update README.md

Amin Nausin4068c2e3275e
diff --git a/README.md b/README.md
index b70c1374..4fbff3bd 100644
--- a/README.md
+++ b/README.md
@@ -1,4 +1,9 @@
-## This is a simple web based media hosting server.
+# This is a simple web based media hosting server built with Laravel.
+It is still incomplete.
+
+
+
+## Overview
Videos are grouped by folders and listed in a table with the file name and date.
This is good for a home server and provides fast and easy access to media.
@@ -6,14 +11,16 @@ The website is responsive by design and works on mobile devices. HVEC support de
### Installation
-Rquires Apache and PHP 8.
+Requires Apache or NGINX, PostgreSQL and PHP 8. You can use Laragon to run in a single application.
-Create symbolic links in the resources folder that point to where videos are stored.
+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 run a file scan or start the Laravel CRON job which scans every 6 hours.
+You can run a file scan manually via the "Index Files" option in the dropdown under your username.
-Different folders are accessed ?dir=foldername after the website's url.
+Different folders are accessed via url/folder/subfolder. Using just URL/folder will open the first subfolder scanned.
-The default folder is defined on the second line of index.php as RESOURCE_DEFAULT.
-This folder is shown when the user does not specify a folder.
+The default folder is defined on line 18 of ./routes/web.php as an automatic redirect to the default /folder/subfolder.
+This is shown when the user does not specify a folder.
Supported File Types:
- MP4
@@ -26,6 +33,6 @@ Screenshots of the current webpage on Desktop and on Android.
!
!
-|![Dark](https://github.com/aminnausin/mediaServer/assets/83550431/7df9dbe1-efec-4aad-ae64-df857f718480)|![Light](./doc/img/LightMode.png)|
+|![Dark](https://github.com/aminnausin/mediaServer/assets/83550431/7df9dbe1-efec-4aad-ae64-df857f718480)|![Light](https://github.com/aminnausin/mediaServer/assets/83550431/495ba4cb-0e30-45e3-91b7-d3a3dae454b6)|
|:-:|:-:|
|Dark Mode on Desktop|Light Mode on Android|